|
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.RmiAgentLifeCycleServiceProxy
An RMI Agent Lifecycle Service Proxy contains a reference to an RMI version of an Agent Lifecycle Service (known as the delegate); the proxy contains methods identical to the methods in the actual service such that when a method is called on the proxy, the proxy forwards the call on to the actual service, but the proxy
Fields inherited from interface com.ibm.able.platform.AgentLifeCycleService |
---|
SERVICE_TYPE |
Constructor Summary | |
---|---|
RmiAgentLifeCycleServiceProxy(RmiAgentLifeCycleService theDelegate,
java.rmi.registry.Registry theRegistry,
java.lang.String theAddress)
Creates a proxy over the specified RMI reference to an Agent Lifecycle Service. |
Method Summary | |
---|---|
void |
addAblePlatformServiceEventListener(AblePlatformServiceEventListener theListener)
Adds a service event listener to this service. |
static java.lang.String |
Copyright()
Gets the copyright statement of this class. |
AblePlatformAgent |
createAgentInstance(AbleAgentClassDescription theAgentClassDescription,
java.lang.String theAgentPoolAlias,
AbleSecureKey theSecureKey)
Creates an instance of an agent in a specified agent pool. |
AblePlatformAgent |
createAgentInstanceAndInitialize(AbleAgentClassDescription theAgentClassDescription,
java.lang.String theAgentPoolAlias,
AbleSecureKey theSecureKey)
Creates an instance of an agent in a specified agent pool and initializes the agent using parameters found in the specified AbleAgentClassDescription. |
AblePlatformAgent |
createAgentInstanceAndInitialize(AbleAgentClassDescription theAgentClassDescription,
java.lang.String theAgentPoolAlias,
java.lang.Object theInitArg,
AbleSecureKey theSecureKey)
Creates an instance of an agent in a specified agent pool and initializes the agent using the specified parameters. |
java.util.Vector |
getAblePlatformServiceEventListeners()
Gets a collection of all service event listeners registered with this service event generator. |
java.util.Vector |
getCreatedAgents(AbleSecureKey theSecureKey)
Gets a collection of all AblePlatformAgent objects created by this particular Agent Lifecycle Service. |
AbleAgentClassDescription[] |
getPermittedAgents()
Gets a collection of agents that are permitted to run on this platform. |
javax.agent.service.ServiceProperties |
getServiceProperties()
Gets the service properties of the underlying service. |
void |
initializeAgent(AblePlatformAgent theAgent,
AbleSecureKey theSecureKey)
Initializes a previously created agent. |
void |
initializeAgent(AblePlatformAgent theAgent,
java.lang.Object theInitArg,
AbleSecureKey theSecureKey)
Initializes a previously created agent instance using the specified initialization argument. |
void |
quiesceAgentPool(java.lang.String theAgentPoolAlias,
AbleSecureKey theSecureKey)
Quiesces the specified agent pool by sending a quitAgent to each agent known to be running in the
pool. |
void |
quitAgent(javax.agent.service.directory.AgentDescription theAgentDescription,
AbleSecureKey theSecureKey)
Requests the agent represented by the specified AgentDescription to quit itself along with any threads the agent owns and any other beans and agents the agent may contain. |
void |
quitAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList,
AbleSecureKey theSecureKey)
Requests each agent represented in the specified AgentDescription list to quit itself along with any threads the agent owns and any other beans and agents the agent may contain. |
void |
reinitializeAgent(javax.agent.service.directory.AgentDescription theAgentDescription,
AbleSecureKey theSecureKey)
|
void |
removeAblePlatformServiceEventListener(AblePlatformServiceEventListener theListener)
Removes a service event listener from this service. |
void |
resetAgent(javax.agent.service.directory.AgentDescription theAgentDescription,
AbleSecureKey theSecureKey)
Requests the agent represented by the specified AgentDescription to reset itself along with any threads the agent owns and any other beans and agents the agent may contain; however, the agent itself may decide whether to reset any internal agents and beans it may contain. |
void |
resetAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList,
AbleSecureKey theSecureKey)
Requests each agent represented in the specified AgentDescription list to reset itself along with any threads the agent owns and any other beans and agents the agent may contain. |
void |
resumeAgent(javax.agent.service.directory.AgentDescription theAgentDescription,
AbleSecureKey theSecureKey)
Requests the agent represented by the specified AgentDescription to resume itself along with any threads the agent owns and any other beans and agents the agent may contain; however, the agent itself may decide whether to resume any internal agents and beans it may contain. |
void |
resumeAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList,
AbleSecureKey theSecureKey)
Requests each agent represented in the specified AgentDescription list to resume itself along with any threads the agent owns and any other beans and agents the agent may contain. |
void |
setServiceProperties(javax.agent.service.ServiceProperties theServiceProperties)
Sets the service properties of the underlying service. |
void |
suspendAgent(javax.agent.service.directory.AgentDescription theAgentDescription,
AbleSecureKey theSecureKey)
Requests the agent represented by the specified AgentDescription to suspend itself along with any threads the agent owns and any other beans and agents the agent may contain; however, the agent itself may decide whether to suspend any internal agents and beans it may contain. |
void |
suspendAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList,
AbleSecureKey theSecureKey)
Requests each agent represented in the specified AgentDescription list to suspend itself along with any threads the agent owns and any other beans and agents the agent may contain. |
void |
terminateService(AbleSecureKey theSecureKey)
Terminates this service in a controlled way; the service is removed from the service root and, if necessary, unbound from the RMI registry and unexported as a remote RMI object. |
java.lang.String |
toString()
Gets a string describing the contents of the object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public RmiAgentLifeCycleServiceProxy(RmiAgentLifeCycleService theDelegate, java.rmi.registry.Registry theRegistry, java.lang.String theAddress)
theDelegate
- A reference to an RMI version of an Agent Lifecycle
Service.
theRegistry
- The RMI registry at which the above Agent Lifecycle
Service is registered.
theAddress
- The RMI address at which the above Agent Lifecycle
Service is registered.
Method Detail |
public javax.agent.service.ServiceProperties getServiceProperties()
Note: In this implementation, the method call is not forwarded on to the service; null is always returned.
getServiceProperties
in interface javax.agent.service.Service
public void setServiceProperties(javax.agent.service.ServiceProperties theServiceProperties)
Note: In this implementation, the method call is not forwarded on to the service; the call is simply ignored.
setServiceProperties
in interface javax.agent.service.Service
theServiceProperties
- The service properties to be used by the service.
public AbleAgentClassDescription[] getPermittedAgents() throws AgentLifeCycleException, AgentLifeCycleFailure
AgentLifeCycleService
getPermittedAgents
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
createAgentInstance
methods to create new
instances of agents in the platform.AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.public AblePlatformAgent createAgentInstance(AbleAgentClassDescription theAgentClassDescription, java.lang.String theAgentPoolAlias, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
If the AbleAgentClassDescription contains constructor parameters, a constructor that matches the parameters will be used, if found. Otherwise, the agent's null argument constructor is used.
The agent is constructed, but not initialized; initialization
must be performed as a separate step by calling one of the
initializeAgent
methods.
createAgentInstance
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentClassDescription
- A class description obtained from the
AgentLifeCycleService.getPermittedAgents()
method.
The specified class description is verified that it is
one from Agent Lifecycle's internal permitted agent
list so that it cannot be spoofed.
theAgentPoolAlias
- Specifies in which of the agent's eligible agent pools
(defined in the platform preference file) the agent is
to be created.
The specified agent pool is verified against the
agent's class description, so that an agent cannot be
created in an agent pool in which it is not allowed to
run.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- If the AbleAgentClassDescription is null.
If the AbleAgentClassDescription does not exist in the service's actual permitted agent list; that is, the AbleAgentClassDescription appears to have been spoofed.
If the specified agent pool name is not a valid agent pool for the AbleAgentClassDescription.
If the agent represented by the AbleAgentClassDescription is not an AblePlatformAgent.
AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public AblePlatformAgent createAgentInstanceAndInitialize(AbleAgentClassDescription theAgentClassDescription, java.lang.String theAgentPoolAlias, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
If the AbleAgentClassDescription contains constructor parameters, a constructor that matches the parameters will be used, if found. Otherwise, the agent's null argument constructor is used.
If the AbleAgentClassDescription contains intialization parameters, those parameters are packaged into an Object[] that is used to intialize the agent; otherwise, the agent is initialized without any special parameters.
createAgentInstanceAndInitialize
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentClassDescription
- A class description obtained from the
AgentLifeCycleService.getPermittedAgents()
method.
The specified class description is verified that it is
one from Agent Lifecycle's internal permitted agent
list so that it cannot be spoofed.
theAgentPoolAlias
- Specifies in which of the agent's eligible agent pools
(defined in the platform preference file) the agent is
to be created.
The specified agent pool is verified against the
agent's class description, so that an agent cannot be
created in an agent pool in which it is not allowed to
run.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- If the AbleAgentClassDescription is null.
If the AbleAgentClassDescription does not exist in the service's actual permitted agent list; that is, the AbleAgentClassDescription appears to have been spoofed.
If the specified agent pool name is not a valid agent pool for the AbleAgentClassDescription.
If the agent represented by the AbleAgentClassDescription is not an AblePlatformAgent.
AgentLifeCycleFailure
- If the agent cannot be created.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public AblePlatformAgent createAgentInstanceAndInitialize(AbleAgentClassDescription theAgentClassDescription, java.lang.String theAgentPoolAlias, java.lang.Object theInitArg, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
If the AbleAgentClassDescription contains constructor parameters, a constructor that matches the parameters will be used, if found. Otherwise, the agent's null argument constructor is used.
createAgentInstanceAndInitialize
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentClassDescription
- A class description obtained from the
AgentLifeCycleService.getPermittedAgents()
method.
The specified class description is verified that it is
one from Agent Lifecycle's internal permitted agent
list so that it cannot be spoofed.
theAgentPoolAlias
- Specifies in which of the agent's eligible agent pools
(defined in the platform preference file) the agent is
to be created.
The specified agent pool is verified against the
agent's class description, so that an agent cannot be
created in an agent pool in which it is not allowed to
run.
theInitArg
- If the initialization parameter is not null, the agent
is initialized using the specified initialization
parameter; otherwise, the agent is initialized without
any special parameters.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- If the AbleAgentClassDescription is null.
If the AbleAgentClassDescription does not exist in the service's actual permitted agent list; that is, the AbleAgentClassDescription appears to have been spoofed.
If the specified agent pool name is not a valid agent pool for the AbleAgentClassDescription.
If the agent represented by the AbleAgentClassDescription is not an AblePlatformAgent.
AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void initializeAgent(AblePlatformAgent theAgent, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
initializeAgent
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAblePlatformAgent
- The agent to initialize.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void initializeAgent(AblePlatformAgent theAgent, java.lang.Object theInitArg, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
initializeAgent
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAblePlatformAgent
- The agent to initialize.
theInitArg
- The initialization argument; typically this is an
Object[] array, but depends on each agent's init
method.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void reinitializeAgent(javax.agent.service.directory.AgentDescription theAgentDescription, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
public void quitAgent(javax.agent.service.directory.AgentDescription theAgentDescription, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
quitAgent
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescription
- The agent to quit.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void quitAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
quitAgents
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescriptionList
- The agents to quit.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void suspendAgent(javax.agent.service.directory.AgentDescription theAgentDescription, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
suspendAgent
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescription
- The agent to suspend.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void suspendAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
suspendAgents
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescriptionList
- The agents to suspend.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void resumeAgent(javax.agent.service.directory.AgentDescription theAgentDescription, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
resumeAgent
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescription
- The agent to resume.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void resumeAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
resumeAgents
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescriptionList
- The agents to resume.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void resetAgent(javax.agent.service.directory.AgentDescription theAgentDescription, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
resetAgent
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescription
- The agent to reset.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void resetAgents(javax.agent.service.directory.AgentDescription[] theAgentDescriptionList, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
resetAgents
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentDescriptionList
- The agents to reset.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public java.util.Vector getCreatedAgents(AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
getCreatedAgents
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
Each element of the collection is an Object[n] object.
Each element of that is
The collection may be empty, but not null.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void quiesceAgentPool(java.lang.String theAgentPoolAlias, AbleSecureKey theSecureKey) throws AgentLifeCycleException, AgentLifeCycleFailure, javax.agent.service.naming.NamingException
AgentLifeCycleService
quitAgent
to each agent known to be running in the
pool.
Note that there is nothing that prevents new agents from being created in the pool during the time the pool is being quiesced.
quiesceAgentPool
in interface AgentLifeCycleService
com.ibm.able.platform.AgentLifeCycleService
theAgentPoolAlias
- The name of an agent pool defined in the platform
preference file.
theSecureKey
- Used when security is on to make sure that the caller
is authentic and has the authority to perform the
operation; may be null when security is off.
AgentLifeCycleException
- On any Agent Lifecycle error.AgentLifeCycleFailure
- When there is a problem in the lifecycle
infrastructure code.javax.agent.service.naming.NamingException
- On any Agent Naming Service error.public void terminateService(AbleSecureKey theSecureKey) throws AbleException, javax.agent.service.naming.NamingException
AblePlatformService
terminateService
in interface AblePlatformService
com.ibm.able.platform.AblePlatformService
theSecureKey
- When security if off, this may be null as the
parameter is ignored; when security is on the security
key must be from an object with equal or greater
authority in order for the operation to proceed.
AbleException
- On any remote error or Able error.javax.agent.service.naming.NamingException
- On any naming error.public void addAblePlatformServiceEventListener(AblePlatformServiceEventListener theListener) throws AbleException
AblePlatformServiceEventGenerator
addAblePlatformServiceEventListener
in interface AblePlatformServiceEventGenerator
com.ibm.able.platform.AblePlatformServiceEventGenerator
theListener
- Any object interested in listening for service events
generated by this service.
AbleException
- On any error.public void removeAblePlatformServiceEventListener(AblePlatformServiceEventListener theListener) throws AbleException
AblePlatformServiceEventGenerator
removeAblePlatformServiceEventListener
in interface AblePlatformServiceEventGenerator
com.ibm.able.platform.AblePlatformServiceEventGenerator
theListener
- A previously registered object that is no longer
interested in listening for service events generated
by this service.
AbleException
- On any error.public java.util.Vector getAblePlatformServiceEventListeners() throws AbleException
AblePlatformServiceEventGenerator
getAblePlatformServiceEventListeners
in interface AblePlatformServiceEventGenerator
com.ibm.able.platform.AblePlatformServiceEventGenerator
AbleException
- On any error.public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String 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 |