|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.workflow.api.Agent
An instance of this class is used to gain access to MQWF services.
The main functions of the Agent class are to select the the MQWF configuration
and to create the ExecutionService
. The ExecutionService can then
be used to logon to the Workflow server and to call MQWF services.
An instance of the Agent class can be reused to create multiple ExecutionService instances. It has no other functionality after calling the locate method.
Field Summary | |
---|---|
static int |
JNDI_LOCATOR
|
static int |
LOC_LOCATOR
|
static java.lang.String[] |
LOCATOR_TAGS
|
static java.lang.String[] |
LOCATORS
|
static java.io.PrintWriter |
log
|
static com.ibm.workflow.client.util.logging.FmcTrace |
trace
|
Constructor Summary | |
---|---|
Agent()
Constructs an Agent instance. |
Method Summary | |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener l)
Adds the given listener to the set of listeners to be notified of property changes. |
void |
addVetoableChangeListener(java.beans.VetoableChangeListener l)
Adds the given listener to the set of listeners to be notified of vetoable property changes. |
java.lang.String |
getConfigurationID()
Returns the configuration to be used for profile accesses. |
ExecutionAgent |
getExecutionAgent()
Returns an ExecutionAgent. |
int |
getLocator()
Returns the property describing the locator policy. |
java.lang.String |
getName()
Returns the name of the agent. |
boolean |
isBound()
Returns true if the agent is bound. |
ExecutionService |
locate(java.lang.String group,
java.lang.String system)
Locates the ExecutionService in the given system group and system. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener l)
Removes the given listener from the set of listeners to be notified of property changes. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener l)
Removes the given listener from the set of listeners to be notified of vetoable property changes. |
void |
setConfigurationID(java.lang.String newConfigurationID)
Sets the configuration identifier to be used by the agent. |
void |
setContext(java.applet.Applet applet,
java.util.Properties properties)
Sets the context for the Agent. |
void |
setContext(java.lang.String[] args,
java.util.Properties properties)
} Sets the context for the Agent. |
void |
setLocator(int newLoc)
Sets the locator policy for this agent. |
void |
setName(java.lang.String newName)
Sets the name of the agent. |
java.lang.String |
toString()
Returns the name of the agent. |
VersionInfo |
versionInfo()
Returns information about version, release, modification level, and driver build of the agent. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int LOC_LOCATOR
public static final int JNDI_LOCATOR
public static final java.lang.String[] LOCATORS
public static final java.lang.String[] LOCATOR_TAGS
public static java.io.PrintWriter log
public static com.ibm.workflow.client.util.logging.FmcTrace trace
Constructor Detail |
public Agent()
Method Detail |
public void setContext(java.lang.String[] args, java.util.Properties properties)
args
- the command line arguments.properties
- the environmental properties passed to the application/applet when it was instantiated.public void setContext(java.applet.Applet applet, java.util.Properties properties)
applet
- the applet which instantiated the agentproperties
- the environmental properties passed to the application/applet when it was instantiatedpublic ExecutionService locate(java.lang.String group, java.lang.String system) throws FmcException
group
- the system groupsystem
- the systemFmcException
- thrown if an API error or a communication error occurred.public ExecutionAgent getExecutionAgent() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.ExecutionAgent
public java.lang.String toString()
toString
in class java.lang.Object
getName()
,
setName(java.lang.String)
public boolean isBound()
public VersionInfo versionInfo() throws FmcException
FmcException
- public void setName(java.lang.String newName) throws java.beans.PropertyVetoException
newName
- the name of the agentjava.beans.PropertyVetoException
- setLocator(int)
,
setConfigurationID(java.lang.String)
public java.lang.String getName()
public void setConfigurationID(java.lang.String newConfigurationID) throws java.beans.PropertyVetoException
newConfigurationID
- the configration identifier.java.beans.PropertyVetoException
- if a configuration for the given identifier was not found.setLocator(int)
,
setName(java.lang.String)
public java.lang.String getConfigurationID() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public void setLocator(int newLoc) throws java.beans.PropertyVetoException
newLoc
- the locator policyjava.beans.PropertyVetoException
- if the selected locator policy is not supported.setName(java.lang.String)
,
setConfigurationID(java.lang.String)
,
LOC_LOCATOR
public int getLocator()
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
l
- the listener to addpublic void removePropertyChangeListener(java.beans.PropertyChangeListener l)
l
- the listener to removepublic void addVetoableChangeListener(java.beans.VetoableChangeListener l)
l
- the listener to addpublic void removeVetoableChangeListener(java.beans.VetoableChangeListener l)
l
- the listener to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |