com.sonicsw.esb.mgmtapi.runtime
Interface ESBArtifactInfo

public interface ESBArtifactInfo

Encapsulates all the relevant runtime information about the artifacts (services and processes) deployed to an ESB container

Method Summary

int	getCurrentState() Returns the current state of the artifact.
java.lang.String	getESBTypeInfo() Returns the ESB configuration type information.
java.lang.String	getLastError() Returns the most recent error (if any) for this artifact.
java.lang.String	getName() Return the name of the artifact.
int	getType() Returns the type of the artifact.

Method Detail

getName

java.lang.String getName()

Return the name of the artifact. This is the name of the ESB service or ESB process.

getType

int getType()

Returns the type of the artifact. In this version the runtime mgmt API lists the deployed services and processes. This method will return XQConstants.ADDRESS_SERVICE for a service and XQConstants.ADDRESS_PROCESS for a process.

getCurrentState

int getCurrentState()

Returns the current state of the artifact. The state is returned as an integer. To get the corresponding XQState object use the XQState.get() method.

getLastError

java.lang.String getLastError()

Returns the most recent error (if any) for this artifact. This error message could either indicate an initialization failure or a failure during start/stop/abort.

getESBTypeInfo

java.lang.String getESBTypeInfo()

Returns the ESB configuration type information. If the artifact is an ESB service then this will return the service type name. If the artifact is an ESB process then this will return the process name.