|
Sonic ESB API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMonitoredContainerRuntimeAPI
Method Summary | |
---|---|
void |
clearLogFiles(java.lang.String containerRuntimeID)
Invoke the Agent's JMX clearLogFile operation, which deletes the current log file and the archived ones |
com.sonicsw.mf.common.runtime.IContainerState |
getMFContainerState(java.lang.String containerName)
Return the state for the MF container |
boolean |
isMFComponentOnline(java.lang.String containerName,
java.lang.String componentName)
Answer whether the specified component is online. |
void |
launchMFContainer(java.lang.String containerID)
Start the monitored container |
void |
reloadMFComponent(java.lang.String containerName,
java.lang.String componentName)
Reload a component within the MF container. |
void |
restartMFContainer(java.lang.String canonicalName)
Restart a running container |
void |
setContainerLaunchActivationDaemon(java.lang.String containerName,
java.lang.String daemonName)
Allow the user to use a different activation daemon for container launch Currently, it does not change the activation daemon configured with the domain manager which starts the auto-launch containers. |
void |
shutdownMFContainer(java.lang.String canonicalName)
Shutdown the monitored container. |
void |
startMFComponent(java.lang.String containerName,
java.lang.String componentName)
Starts the MF component if it has not already been started. |
Method Detail |
---|
void launchMFContainer(java.lang.String containerID) throws ESBAPIException
containerID
- The configuration ID of the container
ESBAPIException
- If the container cannot be found or if there's a problem
with communications with the activation daemon or if there is a problem during the launchvoid shutdownMFContainer(java.lang.String canonicalName) throws ESBAPIException
canonicalName
- The runtime name of the container in <domainName>.<containerName> form
ESBAPIException
- if there is a problem communicating with the container or there
is a problem during the shutdown.void restartMFContainer(java.lang.String canonicalName) throws ESBAPIException
canonicalName
- The runtime id of the running container in the form <domainName>.<containerName>
ESBAPIException
- if there is a problem communicating to the container or if there is a problem
restarting the containerboolean isMFComponentOnline(java.lang.String containerName, java.lang.String componentName) throws ESBAPIException
containerName
- The runtime ID of the MF container in the canonical form <domainName>.<containerName>
or the logical configuration ID of the container, ie. /Containers/dev_ESBTest. This
parameter should not be null, as this method checks that the container is online
using the container runtime ID derived from this argument.componentName
- The simple component name, for instance "dev_ESBCore", or the
logical configuration ID of the container, ie. /ESBContainers/dev_ESBTest or the complete
runtime ID of the component, for instance, Domain1.dev_ESBTest:ID=dev_ESBTest.
ESBAPIException
- If there is an error during the invocation of the reload operation,
or the container doesn't existvoid reloadMFComponent(java.lang.String containerName, java.lang.String componentName) throws ESBAPIException
containerName
- The runtime ID of the MF container in the canonical form <domainName>.<containerName>
or the logical configuration ID of the container, ie. /Containers/dev_ESBTest. This
parameter should not be null, as this method checks that the container is online
using the container runtime ID derived from this argument.componentName
- The simple component name, for instance "dev_ESBCore", or the
logical configuration ID of the container, ie. /ESBContainers/dev_ESBTest or the complete
runtime ID of the component, for instance, Domain1.dev_ESBTest:ID=dev_ESBTest.
ESBAPIException
- If there is an error during the invocation of the reload operation,
or the container doesn't exist or the container is not online.void startMFComponent(java.lang.String containerName, java.lang.String componentName) throws ESBAPIException
containerName
- The runtime ID of the MF container in the canonical form <domainName>.<containerName>
or the logical configuration ID of the container, ie. /Containers/dev_ESBTest. This
parameter should not be null, as this method checks that the container is online
using the container runtime ID derived from this argument.componentName
- The simple component name, for instance "dev_ESBCore", or the
logical configuration ID of the container, ie. /ESBContainers/dev_ESBTest or the complete
runtime ID of the component, for instance, Domain1.dev_ESBTest:ID=dev_ESBTest.
ESBAPIException
- If there's an invocation exception during the start operation of the
component, or the container is not online or doesn't exist or if the component doesn't exist in
the container.com.sonicsw.mf.common.runtime.IContainerState getMFContainerState(java.lang.String containerName) throws ESBAPIException
containerName
- The runtime ID of the container in the form <domainName>.<containerName>
or the configuration name of the container.
ESBAPIException
- If there is a problem communicating with the domain manager or
an underlying error getting the state of the container.void setContainerLaunchActivationDaemon(java.lang.String containerName, java.lang.String daemonName) throws ESBAPIException
containerName
- The container name of MF container which contains the daemon, for instance, "DomainManager"daemonName
- The name of the activation daemon, for instance, "AutoLaunchDaemon". This is the name
used when adding the daemon to the container.
ESBAPIException
- If there's an error constructing the JMX object name of the daemon to be
used for container startup.void clearLogFiles(java.lang.String containerRuntimeID) throws ESBAPIException
containerRuntimeID
- The runtime ID of the container, in <domainName>.<containerName> form
ESBAPIException
- If the container is not found, or the container is not online, or there
is an error during the invocation of the clearLogFile JMX operation of the Agent.
|
Sonic ESB API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |