PsServices (A Framework to learn and study easier Knowledge-based Agents)

java.lang.Object
- com.dpsframework.util.PsServices

All Implemented Interfaces:

PsConstants
```
public final class PsServices
extends java.lang.Object
implements PsConstants
```
Main Repository of dpsFramwork Static Methods and Services.

Since:

2014, revised at: 2018-08

Version:

1.7 (Build.1814)

Author:

Francisco J. Aguayo (Leon University / IEEE Power & Energy Systems Society Member)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class PsServices.DirFilter
- Nested classes/interfaces inherited from interface com.dpsframework.util.PsConstants
  PsConstants.AgentINSTANCE, PsConstants.BoardPKEYS, PsConstants.FwARTIFACTS, PsConstants.FwCLASS, PsConstants.FwDISTRIBUTION, PsConstants.FwPATHS, PsConstants.FwPKEYS, PsConstants.JADEdefaults, PsConstants.KwBASED, PsConstants.NodePKEYS, PsConstants.ToolPARAMETERS

Nested Classes
Modifier and Type	Class and Description
`private static class`	`PsServices.DirFilter`

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.util.ResourceBundle`	`DPSNODE_BUNDLE`
`private static java.util.HashMap<java.lang.Integer,java.lang.String>`	`errorLevels`
`private static int`	`level0`
`private static int`	`level1`
`private static int`	`level2`
`private static java.lang.String`	`toolName`

Constructor Summary

Constructors
Modifier Constructor and Description

private PsServices()

Constructors
Modifier	Constructor and Description
`private`	`PsServices()`

Method Summary

Methods
Modifier and Type	Method and Description
`private static void`	`addDir(java.io.File dirObj, java.util.zip.ZipOutputStream out)` Making a zip file of directory including its sub-directories recursively.
`static void`	`addNativeLibraryPath()` This function enables the java.library.path to be modified at runtime.
`static boolean`	`bhvState(java.lang.String value)`
`private static java.util.ResourceBundle`	`createNodeBundle()`
`static java.lang.String[]`	`DirList(java.lang.String theDir)`
`private static void`	`extractFromFirst(java.nio.file.FileSystem fs, java.lang.String path, java.lang.String target, boolean isNdoOpt)` This is an extension of ZipJava ORACLE.
`static void`	`generateNewPsNode(java.lang.String nameOfNewPsNode, java.lang.String typeOfPsNode)` Make an structure of directories and add it to DPS-Framework nodes directory.
`static java.lang.String`	`getDpsAllEnvironment()`
`static java.lang.String`	`getDpsJAVAClassesURLs()` View System and Java Virtual Machine variables.
`static java.lang.String`	`getDpsJAVAClassPaths()`
`static java.lang.String`	`getDpsJVMProperties()`
`static java.lang.String`	`getDpsNativleLibURLs()`
`static java.lang.String`	`getDpsOSEnvironment()`
`static java.lang.String`	`getJVMEnv()`
`static java.lang.String`	`getNativeLocalPath()` Absolute Path to native libraries required by Knowledge-Agents.
`static java.lang.String`	`getNativePath()` View: http://lopica.sourceforge.net/os.html for complete list of architectures / OS Names
`static java.lang.String`	`getNativeRelativePath()` Solution adopted has been: the double path for locating natural Java and native libraries C++ for Java.
`static java.lang.String`	`getOSarch()` Host architecture where JVM it is running the JADE Platform.
`static java.lang.String`	`getOSname()` OS name where JVM it is running the JADE Platform.
`private static java.nio.file.spi.FileSystemProvider`	`getZipFSProvider()`
`static java.lang.String`	`i18n(java.lang.String key)` Read resource keys.
`static boolean`	`isDPSCandidatePath(java.lang.String nameOfNewDir)` Test privileges and existence of this Directory.
`static boolean`	`isDPSFramework()` Test existence of DPS-Framework infrastructure over nameOfDir this dot (.) directory.
`static boolean`	`isDPSFramework(java.lang.String nameOfDir)` Test existence of DPS-Framework infrastructure over that directory.
`static boolean`	`isHeadless()` Version 0.9.2: adapted to headless hosts
`static boolean`	`isPsBoardAgentDir(java.lang.String nameOfBoard)` Test existence of Directories of PsBoardAgent and some file inside FrameworkDir.
`static boolean`	`isPsMonitorAgentDir(java.lang.String nameOfAgent)` Test existence of Directories on simple Agent instance.
`static boolean`	`isPsNodeAgentDir(java.lang.String nameOfNode)` Test existence of Directories and some file of PsNodeAgent inside FrameworkDir.
`static void`	`makeNewPsNode(java.lang.String nameOfNewPsNode, java.lang.String typeOfPsNode)` Make an structure of directories and add it to DPS-Framework nodes directory.
`private static void`	`mkdirs(java.nio.file.Path path)` It is used by extractFromFirst Function.
`static void`	`printHelp(int level)`
`static void`	`printHelp(java.lang.String resource)`
`private static void`	`sysLogger(java.lang.Object[] o)` A simple Logger mechanism.
`private static void`	`sysLogger(java.lang.Object _errorDesc, java.lang.String _description)` Local version with two parameters of sysLogger method.
`private static void`	`sysLogger(java.lang.Object _errorDesc, java.lang.String _description, java.lang.String _cause)` Local version of sysLogger method.
`static void`	`sysLogger(java.lang.String fromClass, java.lang.String description)`
`static void`	`sysLogger(java.lang.String fromClass, java.lang.String errorDesc, java.lang.String description)`
`static void`	`sysLogger(java.lang.String fromClass, java.lang.String errorDesc, java.lang.String description, java.lang.String cause)`
`static boolean`	`testCLASSPATH(java.lang.String clazz, java.lang.String from)` Test presences about classes in CLASSPATH paths collection.
`static void`	`unzipFolder(java.lang.String agentZipFile, java.lang.String extractFolder)`
`static void`	`updateFrameworkProperties(java.lang.String fwPath, java.lang.String code, java.lang.String value, boolean addValue)`
`static void`	`zipDir(java.lang.String dir, java.lang.String zipFileName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DPSNODE_BUNDLE
```
private static final java.util.ResourceBundle DPSNODE_BUNDLE
```
  - level0
```
private static final int level0
```
    See Also:
    Constant Field Values
  - level1
```
private static final int level1
```
    See Also:
    Constant Field Values
  - level2
```
private static final int level2
```
    See Also:
    Constant Field Values
  - toolName
```
private static final java.lang.String toolName
```
    See Also:
    Constant Field Values
  - errorLevels
```
private static final java.util.HashMap<java.lang.Integer,java.lang.String> errorLevels
```
- Constructor Detail
  - PsServices
```
private PsServices()
```
- Method Detail
  - createNodeBundle
```
private static java.util.ResourceBundle createNodeBundle()
```
  - i18n
```
public static java.lang.String i18n(java.lang.String key)
```
    Read resource keys.
    
    Parameters:
    key - Key on dpsnode_messages.properties resource file.
    
    Returns:
    Key value.
  - getOSarch
```
public static java.lang.String getOSarch()
```
    Host architecture where JVM it is running the JADE Platform.
  - getOSname
```
public static java.lang.String getOSname()
```
    OS name where JVM it is running the JADE Platform.
  - getNativePath
```
public static java.lang.String getNativePath()
```
    View: http://lopica.sourceforge.net/os.html for complete list of architectures / OS Names
    
    Returns:
    Native Library Path Access by Architecture.
  - getNativeLocalPath
```
public static java.lang.String getNativeLocalPath()
```
    Absolute Path to native libraries required by Knowledge-Agents. NOTE: usually "user.dir" plus ./lib/.
  - getNativeRelativePath
```
public static java.lang.String getNativeRelativePath()
```
    Solution adopted has been: the double path for locating natural Java and native libraries C++ for Java.
    The first is a hard-code to ./lib/name-of-architecture. It permits to make a Developer's Environment and it take its data from getNativeLibPath().
    The second solutions is made from NativeRelativePath() plus addNativeLibraryPath() amplification. This solution is for deployment at big scale inside servers. It requires make the new variable (sFrameworkAppNativeLib) in framework.properties ("ps.framework.app.nativelib") and uses it for make a new Paths to Operating System. Relative or absolute. Its mission is for Systems Administrators and for setup a centralization model of libraries of JADE, Jess, BeanShell and CLIPS, plus the gateway of JNI CLIPSJNI.xxx library for each architecture.
    
    Returns:
    Absolute position of native libraries.
  - isDPSCandidatePath
```
public static boolean isDPSCandidatePath(java.lang.String nameOfNewDir)
```
    Test privileges and existence of this Directory.
    
    Parameters:
    nameOfNewDir - Name for the new Framework.
    
    Returns:
    True if it is that directory can to be a candidate for new Framework.
  - isDPSFramework
```
public static boolean isDPSFramework(java.lang.String nameOfDir)
```
    Test existence of DPS-Framework infrastructure over that directory.
    
    Parameters:
    nameOfDir - Name of Framework to analyze.
    
    Returns:
    True if it is really Framework Directory-Structure.
  - isDPSFramework
```
public static boolean isDPSFramework()
```
    Test existence of DPS-Framework infrastructure over nameOfDir this dot (.) directory.
    
    Returns:
    True if it is really Framework Directory-Structure.
  - isPsMonitorAgentDir
```
public static boolean isPsMonitorAgentDir(java.lang.String nameOfAgent)
```
    Test existence of Directories on simple Agent instance.
    
    Parameters:
    nameOfAgent - Name of Agent's instance to analyze.
    
    Returns:
    True if it is a really Agent Directory.
  - isPsNodeAgentDir
```
public static boolean isPsNodeAgentDir(java.lang.String nameOfNode)
```
    Test existence of Directories and some file of PsNodeAgent inside FrameworkDir.
    
    Parameters:
    nameOfNode - Name of Node to analyze.
    
    Returns:
    True if it is really Node Directory.
  - isPsBoardAgentDir
```
public static boolean isPsBoardAgentDir(java.lang.String nameOfBoard)
```
    Test existence of Directories of PsBoardAgent and some file inside FrameworkDir.
    
    Parameters:
    nameOfBoard - Name of TicketBoard Agent to analyze.
    
    Returns:
    True if it is really TicketBoard Agent Directory.
  - extractFromFirst
```
private static void extractFromFirst(java.nio.file.FileSystem fs,
                    java.lang.String path,
                    java.lang.String target,
                    boolean isNdoOpt)
                              throws java.lang.Throwable
```
    This is an extension of ZipJava ORACLE. With an one more parameter it is possible to take decision about final location of files inside that JAR.
    
    Parameters:
    fs - The file system from extract.
    path - The path from getting files.
    target - The final point where data is saved like file.
    isNdoOpt - making new PsNode.
    
    Throws:
    
    java.lang.Throwable - Error caption.
  - mkdirs
```
private static void mkdirs(java.nio.file.Path path)
                    throws java.io.IOException
```
    It is used by extractFromFirst Function.
    
    Parameters:
    path - Position where files will be copied.
    
    Throws:
    
    java.io.IOException - When to make a new directory was not possible.
  - addNativeLibraryPath
```
public static void addNativeLibraryPath()
                                 throws java.io.IOException
```
    This function enables the java.library.path to be modified at runtime.
    Sun Engineers + Filter of Local (dps.library.path). http://forums.sun.com/thread.jspa?threadID=707176
    
    Throws:
    
    java.io.IOException - Method for capturing an error situation.
  - getDpsJAVAClassesURLs
```
public static java.lang.String getDpsJAVAClassesURLs()
```
    View System and Java Virtual Machine variables.
    
    Returns:
    Dump of environment (JVM and Operating System) Status Variables.
  - getDpsNativleLibURLs
```
public static java.lang.String getDpsNativleLibURLs()
```
  - getDpsJAVAClassPaths
```
public static java.lang.String getDpsJAVAClassPaths()
```
  - getDpsOSEnvironment
```
public static java.lang.String getDpsOSEnvironment()
```
  - getDpsJVMProperties
```
public static java.lang.String getDpsJVMProperties()
```
  - getDpsAllEnvironment
```
public static java.lang.String getDpsAllEnvironment()
```
  - getJVMEnv
```
public static java.lang.String getJVMEnv()
```
  - DirList
```
public static java.lang.String[] DirList(java.lang.String theDir)
```
  - addDir
```
private static void addDir(java.io.File dirObj,
          java.util.zip.ZipOutputStream out)
                    throws java.io.IOException
```
    Making a zip file of directory including its sub-directories recursively. Source: http://www.java2s.com/Code/Java/File-Input-Output/Makingazipfileofdirectoryincludingitssubdirectoriesrecursively.htm NOTE: Modificado para extraer solo Path relativo al Framework.
    
    Parameters:
    dirObj - The directory to compress.
    out - The ZipOutputStream where zip files will be created.
    
    Throws:
    
    java.io.IOException - When something about compress made crash..
  - zipDir
```
public static void zipDir(java.lang.String dir,
          java.lang.String zipFileName)
                   throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - updateFrameworkProperties
```
public static void updateFrameworkProperties(java.lang.String fwPath,
                             java.lang.String code,
                             java.lang.String value,
                             boolean addValue)
```
    Parameters:
    fwPath - Path to location.
    code - Name of property.
    value - Value to incorporate.
    addValue - If added that value.
  - getZipFSProvider
```
private static java.nio.file.spi.FileSystemProvider getZipFSProvider()
```
  - generateNewPsNode
```
public static void generateNewPsNode(java.lang.String nameOfNewPsNode,
                     java.lang.String typeOfPsNode)
                              throws java.lang.Throwable
```
    Make an structure of directories and add it to DPS-Framework nodes directory.
    NOTE: from October versions, this functions only inside Development-Agent Environment, that is, not when applications are running on big scale mode with centralized libraries.
    
    Parameters:
    nameOfNewPsNode - Name of new node.
    typeOfPsNode - Select kind of node
    
    Throws:
    
    java.lang.Throwable - Method for capturing errors situations.
  - makeNewPsNode
```
public static void makeNewPsNode(java.lang.String nameOfNewPsNode,
                 java.lang.String typeOfPsNode)
                          throws java.lang.Throwable
```
    Make an structure of directories and add it to DPS-Framework nodes directory.
    NOTE: from October versions, this functions only inside Development-Agent Environment, that is, not when applications are running on big scale mode with centralized libraries.
    
    Parameters:
    nameOfNewPsNode - Name of new node.
    typeOfPsNode - Select kind of node
    
    Throws:
    
    java.lang.Throwable - Method for capturing errors situations.
  - bhvState
```
public static boolean bhvState(java.lang.String value)
```
  - isHeadless
```
public static boolean isHeadless()
```
    Version 0.9.2: adapted to headless hosts
    
    Returns:
    isHeadless
  - unzipFolder
```
public static void unzipFolder(java.lang.String agentZipFile,
               java.lang.String extractFolder)
```
  - printHelp
```
public static void printHelp(java.lang.String resource)
```
  - printHelp
```
public static void printHelp(int level)
```
  - sysLogger
```
private static void sysLogger(java.lang.Object[] o)
```
    A simple Logger mechanism.
    
    Parameters:
    o - An object to print out.
  - sysLogger
```
public static void sysLogger(java.lang.String fromClass,
             java.lang.String errorDesc,
             java.lang.String description)
```
  - sysLogger
```
public static void sysLogger(java.lang.String fromClass,
             java.lang.String errorDesc,
             java.lang.String description,
             java.lang.String cause)
```
  - sysLogger
```
public static void sysLogger(java.lang.String fromClass,
             java.lang.String description)
```
  - testCLASSPATH
```
public static boolean testCLASSPATH(java.lang.String clazz,
                    java.lang.String from)
```
    Test presences about classes in CLASSPATH paths collection.
    
    Parameters:
    clazz - Name of class to test.
    
    Returns:
    true If class is on CLASSPATH.
  - sysLogger
```
private static void sysLogger(java.lang.Object _errorDesc,
             java.lang.String _description,
             java.lang.String _cause)
```
    Local version of sysLogger method.
    
    Parameters:
    _errorDesc - Level error description or String level error description.
    _description - A description about the detected error.
    _cause - Error cause of.
  - sysLogger
```
private static void sysLogger(java.lang.Object _errorDesc,
             java.lang.String _description)
```
    Local version with two parameters of sysLogger method.
    
    Parameters:
    _errorDesc - Level error description.
    _description - Error description.

Class PsServices

Nested Class Summary

Nested classes/interfaces inherited from interface com.dpsframework.util.PsConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DPSNODE_BUNDLE

level0

level1

level2

toolName

errorLevels

Constructor Detail

PsServices

Method Detail

createNodeBundle

i18n

getOSarch

getOSname

getNativePath

getNativeLocalPath

getNativeRelativePath

isDPSCandidatePath

isDPSFramework

isDPSFramework

isPsMonitorAgentDir

isPsNodeAgentDir

isPsBoardAgentDir

extractFromFirst

mkdirs

addNativeLibraryPath

getDpsJAVAClassesURLs

getDpsNativleLibURLs

getDpsJAVAClassPaths

getDpsOSEnvironment

getDpsJVMProperties

getDpsAllEnvironment

getJVMEnv

DirList

addDir

zipDir

updateFrameworkProperties

getZipFSProvider

generateNewPsNode

makeNewPsNode

bhvState

isHeadless

unzipFolder

printHelp

printHelp

sysLogger

sysLogger

sysLogger

sysLogger

testCLASSPATH

sysLogger

sysLogger