| com.sun.esb.management.api.runtime.RuntimeManagementService
All known Subclasses: com.sun.esb.management.impl.runtime.RuntimeManagementServiceMBeanImpl, com.sun.esb.management.impl.runtime.RuntimeManagementServiceImpl,
| RuntimeManagementService | | public interface RuntimeManagementService (Code) | | Defines operations for common runtime management services. Common runtime
management operations include listing component containers available in the
runtime, composite applications deployed, controlling lifecycle across the
runtime and composite applications, getting state of each container and
composite application, etc.
author:
graj |
| Method Summary | |
| public String | listBindingComponents(String targetName)
return component info xml text that has only binding component infos. | | public String | listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. | | public Map<String /* targetName */, String | listBindingComponents(String[] targetNames)
return component info xml text that has only binding component infos. | | public Map<String /* targetName */, String | listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)
return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. | | public String | listServiceAssemblies(String targetName)
returns a list of Service Assembly Infos in a xml format. | | public String | listServiceAssemblies(String componentName, String targetName)
returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component. | | public String | listServiceAssemblies(String state, String componentName, String targetName)
returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
state - to return all the service assemblies that are in the specifiedstate. | | public Map<String /* targetName */, String | listServiceAssemblies(String[] targetNames)
returns a list of Service Assembly Infos in a xml format. | | public Map<String /* targetName */, String | listServiceAssemblies(String componentName, String[] targetNames)
returns the list of service assembly infos in a xml format that have the
service unit deployed on the specified component. | | public Map<String /* targetName */, String | listServiceAssemblies(String state, String componentName, String[] targetNames)
returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
state - to return all the service assemblies that are in the specifiedstate. | | public String | listServiceEngines(String targetName)
| | public String | listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. | | public Map<String /* targetName */, String | listServiceEngines(String[] targetNames)
return component info xml text that has only service engine infos. | | public Map<String /* targetName */, String | listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)
return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. | | public String | listSharedLibraries(String targetName)
return component info xml text that has only shared library infos. | | public String | listSharedLibraries(String componentName, String targetName)
returns the list of Shared Library infos in the in a xml format
Parameters:
componentName - to return only the shared libraries that are this componentdependents. | | public Map<String /* targetName */, String | listSharedLibraries(String[] targetNames)
return component info xml text that has only shared library infos. | | public Map<String /* targetName */, String | listSharedLibraries(String componentName, String[] targetNames)
returns the list of Shared Library infos in the in a xml format
Parameters:
componentName - to return only the shared libraries that are this componentdependents. | | public String | listSharedLibraryDependents(String sharedLibraryName, String targetName)
| | public Map<String /* targetName */, String | listSharedLibraryDependents(String sharedLibraryName, String[] targetNames)
| | public String | showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text for the specified binding component if
exists. | | public Map<String /* targetName */, String | showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)
return component info xml text for the specified binding component if
exists. | | public String | showServiceAssembly(String name, String state, String componentName, String targetName)
return service assembly info xml text for the specified service assembly
if exists. | | public Map<String /* targetName */, String | showServiceAssembly(String name, String state, String componentName, String[] targetNames)
return service assembly info xml text for the specified service assembly
if exists. | | public String | showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text for the specified service engine if
exists. | | public Map<String /* targetName */, String | showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)
return component info xml text for the specified service engine if
exists. | | public String | showSharedLibrary(String name, String componentName, String targetName)
return component info xml text for the specified shared library if
exists. | | public Map<String /* targetName */, String | showSharedLibrary(String name, String componentName, String[] targetNames)
return component info xml text for the specified shared library if
exists. | | public String | shutdownComponent(String componentName, boolean force, String target)
shutdown the component
Parameters:
componentName - name of the runtime component. | | public String | shutdownComponent(String componentName, String target)
shutdown the component
Parameters:
componentName - name of the runtime component. | | public Map<String /* targetName */, String | shutdownComponent(String componentName, String[] targetNames)
| | public Map<String /* targetName */, String | shutdownComponent(String componentName, boolean force, String[] targetNames)
| | public String | shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName)
| | public String | shutdownServiceAssembly(String serviceAssemblyName, String targetName)
| | public Map<String /* targetName */, String | shutdownServiceAssembly(String serviceAssemblyName, String[] targetNames)
| | public Map<String /* targetName */, String | shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames)
| | public String | startComponent(String componentName, String target)
start the component
Parameters:
componentName - name of the runtime component. | | public Map<String /* targetName */, String | startComponent(String componentName, String[] targetNames)
| | public String | startServiceAssembly(String serviceAssemblyName, String targetName)
| | public Map<String /* targetName */, String | startServiceAssembly(String serviceAssemblyName, String[] targetNames)
| | public String | stopComponent(String componentName, String target)
stop the component
Parameters:
componentName - name of the runtime component. | | public Map<String /* targetName */, String | stopComponent(String componentName, String[] targetNames)
| | public String | stopServiceAssembly(String serviceAssemblyName, String targetName)
| | public Map<String /* targetName */, String | stopServiceAssembly(String serviceAssemblyName, String[] targetNames)
|
| listBindingComponents | | public String listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the binding components that have a dependency onthe specified shared library. null value to ignore thisoption.
Parameters:
serviceAssemblyName - return all the binding components that have the specifiedservice assembly deployed on them. null value to ignore thisoption.
Parameters:
targetName - name of the target for this operation xml text contain the list of binding component infos
throws:
ManagementRemoteException - if error or exception occurs. |
| listBindingComponents | | public Map<String /* targetName */, String listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws ManagementRemoteException(Code) | | return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the binding components that have a dependency onthe specified shared library. null value to ignore thisoption.
Parameters:
serviceAssemblyName - return all the binding components that have the specifiedservice assembly deployed on them. null value to ignore thisoption.
Parameters:
targetName - xml text contain the list of binding component infos as map of[targetName, xmlString]
throws:
ManagementRemoteException - if error or exception occurs. |
| listServiceAssemblies | | public String listServiceAssemblies(String componentName, String targetName) throws ManagementRemoteException(Code) | | returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
targetName - name of the target for this operation xml string contain the list of service assembly infos
throws:
ManagementRemoteException - if error or exception occurs. |
| listServiceAssemblies | | public String listServiceAssemblies(String state, String componentName, String targetName) throws ManagementRemoteException(Code) | | returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
state - to return all the service assemblies that are in the specifiedstate. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN ornull for ANY state
Parameters:
componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
targetName - name of the target for this operation xml string contain the list of service assembly infos
throws:
ManagementRemoteException - if error or exception occurs. |
| listServiceAssemblies | | public Map<String /* targetName */, String listServiceAssemblies(String componentName, String[] targetNames) throws ManagementRemoteException(Code) | | returns the list of service assembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
targetNames - xml string contain the list of service assembly infos as map of[targetName, xmlString]
throws:
ManagementRemoteException - if error or exception occurs. |
| listServiceAssemblies | | public Map<String /* targetName */, String listServiceAssemblies(String state, String componentName, String[] targetNames) throws ManagementRemoteException(Code) | | returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
state - to return all the service assemblies that are in the specifiedstate. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN ornull for ANY state
Parameters:
componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
targetNames - xml string contain the list of service assembly infos as map of[targetName, xmlString]
throws:
ManagementRemoteException - if error or exception occurs. |
| listServiceEngines | | public String listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the service engines that have a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return all the service engines that have the specified serviceassembly deployed on them. null value to ignore this option.
Parameters:
targetName - name of the target for this operation xml text contain the list of service engine component infos
throws:
ManagementRemoteException - if error or exception occurs. |
| listServiceEngines | | public Map<String /* targetName */, String listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws ManagementRemoteException(Code) | | return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the service engines that have a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return all the service engines that have the specified serviceassembly deployed on them. null value to ignore this option.
Parameters:
targetName - xml text contain the map of service engine component infos as[targetName, xmlString]
throws:
ManagementRemoteException - if error or exception occurs. |
| listSharedLibraries | | public String listSharedLibraries(String componentName, String targetName) throws ManagementRemoteException(Code) | | returns the list of Shared Library infos in the in a xml format
Parameters:
componentName - to return only the shared libraries that are this componentdependents. null for listing all the shared libraries in thesystem.
Parameters:
targetName - name of the target for this operation xml string contain the list of componentinfos for sharedlibraries.
throws:
ManagementRemoteException - if error or exception occurs. |
| listSharedLibraries | | public Map<String /* targetName */, String listSharedLibraries(String componentName, String[] targetNames) throws ManagementRemoteException(Code) | | returns the list of Shared Library infos in the in a xml format
Parameters:
componentName - to return only the shared libraries that are this componentdependents. null for listing all the shared libraries in thesystem.
Parameters:
targetName - xml string contains the map of componentinfos for sharedlibraries as [targetName, xmlString].
throws:
ManagementRemoteException - if error or exception occurs. |
| listSharedLibraryDependents | | public String listSharedLibraryDependents(String sharedLibraryName, String targetName) throws ManagementRemoteException(Code) | | returns a list of Binding Component and Service Engine infos in xml
format, that are dependent upon a specified Shared Library
Parameters:
sharedLibraryName - the shared library name
Parameters:
targetName - name of the target for this operation xml string containing the list of componentInfos
throws:
ManagementRemoteException - on error |
| listSharedLibraryDependents | | public Map<String /* targetName */, String listSharedLibraryDependents(String sharedLibraryName, String[] targetNames) throws ManagementRemoteException(Code) | | returns a list of Binding Component and Service Engine infos in xml
format, that are dependent upon a specified Shared Library
Parameters:
sharedLibraryName - the shared library name
Parameters:
targetName - xml string containing the map of componentInfos as [targetName,xmlString]
throws:
ManagementRemoteException - on error |
| showBindingComponent | | public String showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | return component info xml text for the specified binding component if
exists. If no binding component with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the binding component to lookup
Parameters:
state - return the binding component that is in the specified state.valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLEDor null for ANY state
Parameters:
sharedLibraryName - return the binding component that has a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return the binding component that has the specified serviceassembly deployed on it. null value to ignore this option.
Parameters:
targetName - name of the target for this operation xml text contain the binding component info that confirms to thecomponent info list xml grammer.
throws:
ManagementRemoteException - if error or exception occurs. |
| showBindingComponent | | public Map<String /* targetName */, String showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws ManagementRemoteException(Code) | | return component info xml text for the specified binding component if
exists. If no binding component with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the binding component to lookup
Parameters:
state - return the binding component that is in the specified state.valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLEDor null for ANY state
Parameters:
sharedLibraryName - return the binding component that has a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return the binding component that has the specified serviceassembly deployed on it. null value to ignore this option.
Parameters:
targetName - xml text contain the binding component info that confirms to thecomponent info list xml grammer as a map of [targetName,xmlString].
throws:
ManagementRemoteException - if error or exception occurs. |
| showServiceAssembly | | public String showServiceAssembly(String name, String state, String componentName, String targetName) throws ManagementRemoteException(Code) | | return service assembly info xml text for the specified service assembly
if exists. If no service assembly with that name exists, it returns the
xml with empty list.
Parameters:
name - name of the service assembly to lookup
Parameters:
state - return the service assembly that is in the specified state.JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null forANY state
Parameters:
componentName - return the service assembly that has service units on thiscomponent.
Parameters:
targetName - name of the target for this operation xml string contain service assembly info that confirms to theservice assembly list xml grammer.
throws:
ManagementRemoteException - if error or exception occurs. |
| showServiceAssembly | | public Map<String /* targetName */, String showServiceAssembly(String name, String state, String componentName, String[] targetNames) throws ManagementRemoteException(Code) | | return service assembly info xml text for the specified service assembly
if exists. If no service assembly with that name exists, it returns the
xml with empty list.
Parameters:
name - name of the service assembly to lookup
Parameters:
state - return the service assembly that is in the specified state.JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null forANY state
Parameters:
componentName - return the service assembly that has service units on thiscomponent.
Parameters:
targetNames - xml string contain service assembly info that confirms to theservice assembly list xml grammer as [targetName, xmlString] map.
throws:
ManagementRemoteException - if error or exception occurs. |
| showServiceEngine | | public String showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | return component info xml text for the specified service engine if
exists. If no service engine with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the service engine to lookup
Parameters:
state - return service engine that is in the specified state. validstates are JBIComponentInfo.STARTED, STOPPED, INSTALLED ornull for ANY state
Parameters:
sharedLibraryName - return service engine that has a dependency on the specifiedshared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return the service engine that has the specified serviceassembly deployed on it. null value to ignore this option.
Parameters:
targetName - name of the target for this operation xml text contain the service engine component info that confirmsto the component info list xml grammer.
throws:
ManagementRemoteException - if error or exception occurs. |
| showServiceEngine | | public Map<String /* targetName */, String showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws ManagementRemoteException(Code) | | return component info xml text for the specified service engine if
exists. If no service engine with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the service engine to lookup
Parameters:
state - return service engine that is in the specified state. validstates are JBIComponentInfo.STARTED, STOPPED, INSTALLED ornull for ANY state
Parameters:
sharedLibraryName - return service engine that has a dependency on the specifiedshared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return the service engine that has the specified serviceassembly deployed on it. null value to ignore this option.
Parameters:
targetName - xml text contain the service engine component info that confirmsto the component info list xml grammer as a map of [targetName,xmlString].
throws:
ManagementRemoteException - if error or exception occurs. |
| showSharedLibrary | | public String showSharedLibrary(String name, String componentName, String targetName) throws ManagementRemoteException(Code) | | return component info xml text for the specified shared library if
exists. If no shared library with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the shared library to lookup
Parameters:
componentName - return the shared library that is this component dependents.null to ignore this option.
Parameters:
targetName - name of the target for this operation xml string contain shared library component info that confirms tothe component info list xml grammer.
throws:
ManagementRemoteException - if error or exception occurs. |
| showSharedLibrary | | public Map<String /* targetName */, String showSharedLibrary(String name, String componentName, String[] targetNames) throws ManagementRemoteException(Code) | | return component info xml text for the specified shared library if
exists. If no shared library with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the shared library to lookup
Parameters:
componentName - return the shared library that is this component dependents.null to ignore this option.
Parameters:
targetName - xml string contain shared library component info that confirms tothe component info list xml grammer as a map of [targetName,xmlString].
throws:
ManagementRemoteException - if error or exception occurs. |
| shutdownComponent | | public String shutdownComponent(String componentName, boolean force, String target) throws ManagementRemoteException(Code) | | shutdown the component
Parameters:
componentName - name of the runtime component. The name should uniquelyidentify within the runtime application server
Parameters:
force - forcefully shutdown the component
Parameters:
target - -name of server target for which this operation is invoked result string of the operation
throws:
ManagementRemoteException - on error |
| shutdownComponent | | public String shutdownComponent(String componentName, String target) throws ManagementRemoteException(Code) | | shutdown the component
Parameters:
componentName - name of the runtime component. The name should uniquelyidentify within the runtime application server
Parameters:
target - -name of server target for which this operation is invoked result string of the operation
throws:
ManagementRemoteException - on error |
| shutdownComponent | | public Map<String /* targetName */, String shutdownComponent(String componentName, boolean force, String[] targetNames) throws ManagementRemoteException(Code) | | shuts down component (service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
force - true to force shutdown
Parameters:
targetNames - name of the component as [targetName, string] map
throws:
ManagementRemoteException - on error |
| shutdownServiceAssembly | | public String shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName) throws ManagementRemoteException(Code) | | shuts down service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceShutdown -
Parameters:
targetName - name of the target for this operation result as a management message xml text
throws:
ManagementRemoteException - on error |
| shutdownServiceAssembly | | public String shutdownServiceAssembly(String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | shuts down service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
targetName - name of the target for this operation result as a management message xml text
throws:
ManagementRemoteException - on error |
| shutdownServiceAssembly | | public Map<String /* targetName */, String shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames) throws ManagementRemoteException(Code) | | shuts down service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceShutdown -
Parameters:
targetName - name of the target for this operation Map of targetName and result as a management message xml textstrings.
throws:
ManagementRemoteException - on error |
| startComponent | | public String startComponent(String componentName, String target) throws ManagementRemoteException(Code) | | start the component
Parameters:
componentName - name of the runtime component. The name should uniquelyidentify within the runtime application server
Parameters:
target - -name of server target for which this operation is invoked result string of the operation
throws:
ManagementRemoteException - on error |
| startServiceAssembly | | public String startServiceAssembly(String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | starts service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
targetName - name of the target for this operation result as a management message xml text
throws:
ManagementRemoteException - on error |
| stopComponent | | public String stopComponent(String componentName, String target) throws ManagementRemoteException(Code) | | stop the component
Parameters:
componentName - name of the runtime component. The name should uniquelyidentify within the runtime application server
Parameters:
target - -name of server target for which this operation is invoked result string of the operation
throws:
ManagementRemoteException - on error |
| stopServiceAssembly | | public String stopServiceAssembly(String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code) | | stops service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
targetName - name of the target for this operation result as a management message xml text
throws:
ManagementRemoteException - on error |
|
|