|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.platform.AblePlatform
The AblePlatform class provides constants and class methods to support the distributed platform of the IBM Agent Building and Learning Environment (ABLE); in addition to static methods that help determine the values of certain preferences set by the user in the platform preference file, methods are provided to obtain the platform's service root and to look up services individually.
Field Summary | |
---|---|
static java.lang.String |
AbleAgentAutonomyLevel
The following are keys of attributes that are added to each agent's JAS AgentDescription by each AblePlatformDefaultAgent when it is created. |
static java.lang.String |
AbleAgentDescription
|
static java.lang.String |
AbleAgentLastUpdate
|
static java.lang.String |
AbleAgentMovable
|
static java.lang.String |
AbleAgentRmiAddress
|
static java.lang.String |
AbleAgentRmiHost
|
static java.lang.String |
AbleAgentRmiName
|
static java.lang.String |
AbleAgentStatus
|
static java.lang.String |
AbleAgentSummary
|
static java.lang.String |
AbleAgentType
|
static java.lang.String |
AbleAgentVendor
|
static java.lang.String |
AbleAgentVersion
|
static java.lang.String |
AbleDirectLocatorObject
|
static java.lang.String |
AbleDirectLocatorType
|
static java.lang.String |
AbleEnvelopeDisplayName
|
static java.lang.String |
AbleEnvelopeNestedName
|
static java.lang.String |
AbleLocatorProtocol
|
static int |
CustomAutonomy
Autonomy level: custom autonomy; an agent operating with this level is operating on a custom level. |
static java.lang.String |
DefaultPlatformName
A default name for a platform when no platform name is specified in the preferences file. |
static int |
HighAutonomy
Autonomy level: high autonomy; an agent operating with this level is highly autonomous. |
static java.security.KeyPairGenerator |
KeyGenerator
This KeyPairGenerator is created using the cryptography algorithm and cryptography provider specified in the preferences file. |
static int |
LowAutonomy
Autonomy level: low autonomy; an agent operating with this level is hardly autonomous. |
static int |
MediumAutonomy
Autonomy level: medium autonomy; an agent operating with this level is somewhat autonomous. |
static java.lang.String |
PlatformMessageBundle
The fully qualified name of the class that contains this package's NLS messages. |
static java.lang.String |
PlatformSupportName
The name of the platform support object as it is used when doing RMI lookups, rebinds, and so on. |
static AblePlatformPreferences |
Preferences
The current set of preferences, as loaded from the preferences file. |
Method Summary | |
---|---|
static AbleMessageContainer |
AutonomyLevel(int theAutonomyLevel)
Turns the specified autonomy level into a human readable form for error messages. |
static java.lang.String |
Copyright()
Gets the copyright statement of this class. |
static java.security.KeyPair |
generateKeyPair()
Gets a KeyPair from the special KeyPairGenerator created using the cryptography algorithm and cryptography provider specified in the preferences file. |
static java.lang.String |
getPlatformCryptographyAlgorithm()
Gets the platform's cryptography algorithm as specified in the platform preference file. |
static java.lang.String |
getPlatformCryptographyProvider()
Gets the platform's cryptography provider as specified in the platform preference file. |
static java.lang.String |
getPlatformName()
Gets the platform's name as specified in the platform preference file. |
static boolean |
getPlatformSecurity()
Gets the platform's security setting as specified in the platform preference file. |
static javax.agent.service.ServiceRoot |
getPlatformServiceRoot(java.lang.String theRequestorsPort)
Gets the platform's service root. |
static javax.agent.service.Service |
getService(java.lang.String theRequestorsPort,
java.lang.String theServiceAlias)
Gets the specified platform service. |
static javax.agent.service.ServiceRoot |
getServiceRoot(java.lang.String theRequestorsPort)
Gets the platform's service root. |
static java.lang.String |
NlsMsg(java.lang.String theMsgKey)
Gets an NLS message by key; the message must not contain any insertion text. |
static java.lang.String |
NlsMsg(java.lang.String theMsgKey,
java.lang.Object[] theInserts)
Gets an NLS message by key with the specified text inserted into the message. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String PlatformSupportName
public static final java.lang.String PlatformMessageBundle
public static final java.lang.String AbleAgentAutonomyLevel
public static final java.lang.String AbleAgentDescription
public static final java.lang.String AbleAgentLastUpdate
public static final java.lang.String AbleAgentMovable
public static final java.lang.String AbleAgentRmiAddress
public static final java.lang.String AbleAgentRmiHost
public static final java.lang.String AbleAgentRmiName
public static final java.lang.String AbleAgentStatus
public static final java.lang.String AbleAgentSummary
public static final java.lang.String AbleAgentType
public static final java.lang.String AbleAgentVendor
public static final java.lang.String AbleAgentVersion
public static final java.lang.String AbleDirectLocatorType
public static final java.lang.String AbleDirectLocatorObject
public static final java.lang.String AbleEnvelopeDisplayName
public static final java.lang.String AbleEnvelopeNestedName
public static final java.lang.String AbleLocatorProtocol
public static final int CustomAutonomy
AutonomyLevel(int)
public static final int HighAutonomy
AutonomyLevel(int)
public static final int MediumAutonomy
AutonomyLevel(int)
public static final int LowAutonomy
AutonomyLevel(int)
public static final java.lang.String DefaultPlatformName
public static final AblePlatformPreferences Preferences
public static final java.security.KeyPairGenerator KeyGenerator
getPlatformCryptographyAlgorithm()
,
getPlatformCryptographyProvider()
Method Detail |
public static final AbleMessageContainer AutonomyLevel(int theAutonomyLevel)
theAutonomyLevel
- A valid (or invalid) AblePlatform.<AutonomyLevel> value.
HighAutonomy
.
If the specified number is not a valid autonomy level,
"AutonomyLevel_Unrecognised CustomAutonomy
,
HighAutonomy
,
MediumAutonomy
,
LowAutonomy
public static final java.security.KeyPair generateKeyPair()
KeyGenerator
public static java.lang.String getPlatformCryptographyAlgorithm()
AblePlatformPreferences.getCryptographyAlgorithm()
public static java.lang.String getPlatformCryptographyProvider()
AblePlatformPreferences.getCryptographyProvider()
public static java.lang.String getPlatformName()
AblePlatformPreferences.getPlatformName()
public static boolean getPlatformSecurity()
AblePreferences.getSecurity()
public static javax.agent.service.ServiceRoot getPlatformServiceRoot(java.lang.String theRequestorsPort)
theRequestorsPort
- The port, if any (may be null), of the object
requesting the service root. This is used to help
determine whether the requestor is running in the
same agent pool as any Service that may need to be
constructed.
getServiceRoot(String)
public static javax.agent.service.ServiceRoot getServiceRoot(java.lang.String theRequestorsPort)
The JAS ServiceManager.getService
method is used
to create or locate each service configured in the platform
preference file.
Each call to this method generates a new ServiceRoot, rather than returning a cached ServiceRoot, because a service may go down and come back up at a new IP address. Also, using this technique ensures that if a service needs to be restarted on the local host, it will be.
If a configured service is missing at some remote host, that error is logged.
theRequestorsPort
- The port, if any (may be null), of the object
requesting the service root. This is used to help
determine whether the requestor is running in the
same agent pool as any Service that may need to be
constructed.
public static javax.agent.service.Service getService(java.lang.String theRequestorsPort, java.lang.String theServiceAlias) throws AbleException
Note that the JAS ServiceManager is called to find the service, and that the ServiceManager will use the specified service's factory to "get" the service. "Getting" the service may be as simple as an RMI look up, or it may involve creating the service from scratch.
theRequestorsPort
- The port, if any (may be null), of the object
requesting the service object. This is used to help
determine whether the requestor is running in the
same agent pool as the specified Service.
theServiceAlias
- The alias of the service as mandated by the platform
preference file; note that the alias must be the
desired service's actual binding name (case
insensitive).
AbleException
- If the specified service cannot be located or
created.public static java.lang.String NlsMsg(java.lang.String theMsgKey)
theMsgKey
- A unique key identifying the message to be retrieved.
public static java.lang.String NlsMsg(java.lang.String theMsgKey, java.lang.Object[] theInserts)
theMsgKey
- A unique key identifying the message to be retrieved.
theInserts
- An array of String objects which are inserted into the
message before it is returned.
public static java.lang.String Copyright()
Able.Copyright
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |