Sonic ESB API

com.sonicsw.esb.mgmtapi.runtime
Interface IContainerRuntimeAPI


public interface IContainerRuntimeAPI


Method Summary
 boolean abortContainer()
           
 ESBArtifactInfo[] abortProcesses(java.lang.String[] processNames)
          Abort ESB processes
 ESBArtifactInfo[] abortServices(java.lang.String[] serviceNames)
          Abort ESB services
 ESBArtifactInfo[] getArtifacts()
          List all the artifacts (services and processes) deployed in this ESB container.
 ESBArtifactInfo getProcessInfo(java.lang.String processName)
          Get runtime information about a process deployed in the container.
 ESBArtifactInfo getServiceInfo(java.lang.String serviceName)
          Get runtime information about a service deployed in the container.
 ESBArtifactInfo[] reloadProcesses(java.lang.String[] processNames)
          Reload ESB processes
 ESBArtifactInfo[] reloadServices(java.lang.String[] serviceNames)
          Reload ESB services
 ESBArtifactInfo[] startProcesses(java.lang.String[] processNames)
          Start ESB processes
 ESBArtifactInfo[] startServices(java.lang.String[] serviceNames)
          Start ESB services
 ESBArtifactInfo[] stopProcesses(java.lang.String[] processNames)
          Stop ESB processes
 ESBArtifactInfo[] stopServices(java.lang.String[] serviceNames)
          Stop ESB services
 

Method Detail

getArtifacts

ESBArtifactInfo[] getArtifacts()
List all the artifacts (services and processes) deployed in this ESB container.

Returns:
An array of ESBArtifactInfo objects that represent all the services and processes deployed in the container.

getServiceInfo

ESBArtifactInfo getServiceInfo(java.lang.String serviceName)
Get runtime information about a service deployed in the container.

Returns:
An ESBArtifactInfo object with information about the service.

getProcessInfo

ESBArtifactInfo getProcessInfo(java.lang.String processName)
Get runtime information about a process deployed in the container.

Returns:
An ESBArtifactInfo object with information about the process.

stopServices

ESBArtifactInfo[] stopServices(java.lang.String[] serviceNames)
Stop ESB services

Parameters:
serviceNames - An array of service names to be stopped
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the services being stopped

startServices

ESBArtifactInfo[] startServices(java.lang.String[] serviceNames)
Start ESB services

Parameters:
serviceNames - An array of service names to be started
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the services being started.

abortServices

ESBArtifactInfo[] abortServices(java.lang.String[] serviceNames)
Abort ESB services

Parameters:
serviceNames - An array of service names to be aborted
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the services being aborted

reloadServices

ESBArtifactInfo[] reloadServices(java.lang.String[] serviceNames)
Reload ESB services

Parameters:
serviceNames - An array of service names to be reloaded
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the services being reloaded

stopProcesses

ESBArtifactInfo[] stopProcesses(java.lang.String[] processNames)
Stop ESB processes

Parameters:
processNames - An array of process names to be stopped
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the processes being stopped

startProcesses

ESBArtifactInfo[] startProcesses(java.lang.String[] processNames)
Start ESB processes

Parameters:
processNames - An array of process names to be started
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the processes being started

abortProcesses

ESBArtifactInfo[] abortProcesses(java.lang.String[] processNames)
Abort ESB processes

Parameters:
processNames - An array of process names to be aborted
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the processes being aborted

reloadProcesses

ESBArtifactInfo[] reloadProcesses(java.lang.String[] processNames)
Reload ESB processes

Parameters:
processNames - An array of process names to be reloaded
Returns:
An array of ESBArtifactInfo objects to represent the updated state for the processes being reloaded

abortContainer

boolean abortContainer()

Sonic ESB API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.