Sonic ESB API

com.sonicsw.esb.mgmtapi
Interface ESBAPI


public interface ESBAPI

This interface provides access to the sub-components of the ESB API. An implementation instance is obtained by using ESBAPIFactory.createAPI A typical usage pattern is to create an instance of the API connected to a domain, perform the required operations and then dispose of the API. Note that the various configuration API's can be utilized against either a running Domain manager or a ds.xml file (with the exception of the MonitoredContainerConfigAPI). The runtime API's can only be used when communicating with a running domain manager.


Method Summary
 void dispose()
          Cleanup the resources used by the API instance (JMX/JMS connections).
 IContainerConfigAPI getContainerConfigAPI()
          Obtain a connected instance of the Container configuration API.
 IContainerRuntimeAPI getContainerRuntimeAPI(java.lang.String mfContainerName, java.lang.String esbContainerName)
          Obtain a connected instance of the Container runtime API (only with running domain manager).
 IEndpointConfigAPI getEndpointConfigAPI()
          Obtain a connected instance of the Endpoint configuration API.
 IMonitoredContainerConfigAPI getMonitoredContainersConfigAPI()
          Obtain a connected instance of the Monitored container configuration API (only with running domain manager).
 IMonitoredContainerRuntimeAPI getMonitoredContainersRuntimeAPI()
          Obtain a connected instance of the Monitored container runtime API (only with running domain manager) This API is used internally.
 IProcessConfigAPI getProcessConfigAPI()
          Obtain a connected instance of the Process configuration API.
 IServiceConfigAPI getServiceConfigAPI()
          Obtain a connected instance of the Service configuration API.
 

Method Detail

getContainerConfigAPI

IContainerConfigAPI getContainerConfigAPI()
Obtain a connected instance of the Container configuration API. This API provides methods for configuring ESB containers.

Returns:
an instance of IContainerConfigAPI IContainerConfigAPI

getServiceConfigAPI

IServiceConfigAPI getServiceConfigAPI()
Obtain a connected instance of the Service configuration API. This API provides methods for configuring ESB services.

Returns:
an instance of IServiceConfigAPI IServiceConfigAPI

getProcessConfigAPI

IProcessConfigAPI getProcessConfigAPI()
Obtain a connected instance of the Process configuration API. This API provides methods for configuring ESB processes.

Returns:
an instance of IProcessConfigAPI IProcessConfigAPI

getEndpointConfigAPI

IEndpointConfigAPI getEndpointConfigAPI()
Obtain a connected instance of the Endpoint configuration API. This API provides methods for configuring ESB endpoints and connections.

Returns:
an instance of IEndpointConfigAPI IEndpointConfigAPI

getMonitoredContainersConfigAPI

IMonitoredContainerConfigAPI getMonitoredContainersConfigAPI()
Obtain a connected instance of the Monitored container configuration API (only with running domain manager). This API is used internally.

Returns:
an instance of IMonitoredContainerConfigAPI IMonitoredContainerConfigAPI

getMonitoredContainersRuntimeAPI

IMonitoredContainerRuntimeAPI getMonitoredContainersRuntimeAPI()
Obtain a connected instance of the Monitored container runtime API (only with running domain manager) This API is used internally.

Returns:
an instance of IMonitoredContainerRuntimeAPI IMonitoredContainerRuntimeAPI

getContainerRuntimeAPI

IContainerRuntimeAPI getContainerRuntimeAPI(java.lang.String mfContainerName,
                                            java.lang.String esbContainerName)
Obtain a connected instance of the Container runtime API (only with running domain manager). This API allows managing ESB containers and other artifacts' lifecycle.

Returns:
an instance of IContainerConfigAPI IContainerRuntimeAPI

dispose

void dispose()
Cleanup the resources used by the API instance (JMX/JMS connections).


Sonic ESB API

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