JBIAdminCommands (jbi-admin-common 2.4.3 API)

All Known Implementing Classes:

JBIAdminCommandsClientImpl
```
public interface JBIAdminCommands
```
Author:

graj

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_CONFIGURATION_NAME_KEY`
`static String`	`CUSTOM_LOGGER_NAME_KEY`
`static String`	`DOMAIN_TARGET_KEY`
`static String`	`SERVER_TARGET_KEY`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`addApplicationConfiguration(String componentName, String targetName, String name, Properties config)` Add a named application configuration to a component installed on a given target.
`String`	`addApplicationVariables(String componentName, String targetName, Properties appVariables)` Add application variables to a component installed on a given target.
`String`	`deleteApplicationConfiguration(String componentName, String targetName, String name)` Delete a named application configuration in a component installed on a given target.
`String`	`deleteApplicationVariables(String componentName, String targetName, String[] appVariableNames)` Delete application variables from a component installed on a given target.
`String`	`deployServiceAssembly(String zipFilePath, String targetName)` deploys service assembly
`Map<String,String>`	`deployServiceAssembly(String zipFilePath, String[] targetNames)` deploys service assembly
`String`	`deployServiceAssemblyFromDomain(String assemblyName, String targetName)` deploys service assembly
`Map<String,String>`	`deployServiceAssemblyFromDomain(String assemblyName, String[] targetNames)` deploys service assembly
`String`	`exportApplicationConfiguration(String applicationName, String targetName, String configDir)` This method is used to export the application variables and application configuration objects used by the given application in the specified target.
`Properties`	`getApplicationConfiguration(String componentName, String targetName, String name)` Get a specific named configuration.
`Map<String,Properties>`	`getApplicationConfigurations(String componentName, String targetName)` Get all the application configurations set on a component.
`Properties`	`getApplicationVariables(String componentName, String targetName)` Get all the application variables set on a component.
`Properties`	`getComponentConfiguration(String componentName, String targetName)` Retrieve component configuration
`Map<String,ObjectName[]>`	`getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName)` Gets the extension MBean object names
`ObjectName[]`	`getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName)` Gets the extension MBean object names
`String`	`getComponentInstallationDescriptor(String componentName)` Returns the jbi.xml Installation Descriptor for a Service Engine/Binding Component.
`Map<String,String>`	`getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName)` Gets the component custom loggers and their display names.
`Map<String,Level>`	`getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName)` Gets the component custom loggers and their levels
`TabularData`	`getComponentStats(String componentName, String targetName)` This method is used to provide statistics for the given component in the given target
`TabularData`	`getConsumingEndpointsForComponent(String componentName, String targetName)` This method is used to provide a list of consuming endpoints for a component.
`Properties`	`getDefaultRuntimeConfiguration()` This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
`TabularData`	`getEndpointStats(String endpointName, String targetName)` This method is used to provide statistic information about the given endpoint in the given target
`TabularData`	`getFrameworkStats(String targetName)` This method is used to provide JBIFramework statistics in the given target.
`TabularData`	`getNMRStats(String targetName)` This method is used to provide statistics about the message service in the given target.
`TabularData`	`getProvidingEndpointsForComponent(String componentName, String targetName)` This method is used to provide a list of provisioning endpoints for a component.
`Properties`	`getRuntimeConfiguration(String targetName)` This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
`Properties`	`getRuntimeConfigurationMetaData(String propertyKeyName)` This method returns the runtime configuration metadata associated with the specified property.
`String`	`getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName)` Return the display name for a runtime logger
`String`	`getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName)` Return the display name for a runtime logger
`Level`	`getRuntimeLoggerLevel(String runtimeLoggerName, String targetName)` Lookup the level of one runtime logger
`Level`	`getRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName)` Lookup the level of one runtime logger
`Map<String,Level>`	`getRuntimeLoggerLevels(String targetName)` Gets all the runtime loggers and their levels
`Map<String,Level>`	`getRuntimeLoggerLevels(String targetName, String targetInstanceName)` Gets all the runtime loggers and their levels
`Map<String,String>`	`getRuntimeLoggerNames(String targetName)` Gets all the runtime loggers and their display names
`Map<String,String>`	`getRuntimeLoggerNames(String targetName, String targetInstanceName)` Gets all the runtime loggers and their display names
`String`	`getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)` Returns the jbi.xml Deployment Descriptor for a Service Assembly.
`TabularData`	`getServiceAssemblyStats(String saName, String targetName)` This method is used to provide statistics about a Service Assembly in the given target.
`String`	`getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName)` Returns the jbi.xml Deployment Descriptor for a Service Unit.
`String`	`getSharedLibraryInstallationDescriptor(String sharedLibraryName)` Returns the jbi.xml Installation Descriptor for a Shared Library.
`String`	`installComponent(String zipFilePath, Properties paramProps, String targetName)` installs component ( service engine, binding component)
`Map<String,String>`	`installComponent(String zipFilePath, Properties paramProps, String[] targetNames)` installs component ( service engine, binding component)
`String`	`installComponent(String zipFilePath, String targetName)` installs component ( service engine, binding component)
`Map<String,String>`	`installComponent(String zipFilePath, String[] targetNames)` installs component ( service engine, binding component)
`String`	`installComponentFromDomain(String componentName, Properties properties, String targetName)` installs component ( service engine, binding component)
`Map<String,String>`	`installComponentFromDomain(String componentName, Properties properties, String[] targetNames)` installs component ( service engine, binding component)
`String`	`installComponentFromDomain(String componentName, String targetName)` installs component ( service engine, binding component)
`Map<String,String>`	`installComponentFromDomain(String componentName, String[] targetNames)` installs component ( service engine, binding component)
`String`	`installSharedLibrary(String zipFilePath, String targetName)` installs shared library
`Map<String,String>`	`installSharedLibrary(String zipFilePath, String[] targetNames)` installs shared library
`String`	`installSharedLibraryFromDomain(String libraryName, String targetName)` installs shared library
`Map<String,String>`	`installSharedLibraryFromDomain(String libraryName, String[] targetNames)` installs shared library
`boolean`	`isAppConfigSupported(String componentName, String targetName)` Detect the components support for application configuration.
`boolean`	`isAppVarsSupported(String componentName, String targetName)` Detect the components support for application variables.
`boolean`	`isComponentConfigSupported(String componentName, String targetName)` Detect the components support for component configuration.
`boolean`	`isJBIRuntimeEnabled()` Checks to see if the JBI Runtime is enabled.
`boolean`	`isServerRestartRequired()` checks if the server need to be restarted to apply the changes made to some of the configuration parameters.
`boolean`	`isTargetUp(String targetName)` Checks to see if the Target (server, cluster) is up or down.
`String[]`	`listApplicationConfigurationNames(String componentName, String targetName)` List all the application configurations in a component.
`String`	`listBindingComponents(String targetName)` return component info xml text that has only binding component infos.
`Map<String,String>`	`listBindingComponents(String[] targetNames)` return component info xml text that has only binding component infos.
`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.
`Map<String,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.
`String`	`listServiceAssemblies(String targetName)` returns a list of Service Assembly Infos in a xml format.
`Map<String,String>`	`listServiceAssemblies(String[] targetNames)` returns a list of Service Assembly Infos in a xml format.
`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.
`Map<String,String>`	`listServiceAssemblies(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.
`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.
`Map<String,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.
`String`	`listServiceEngines(String targetName)` return component info xml text that has only service engine infos.
`Map<String,String>`	`listServiceEngines(String[] targetNames)` return component info xml text that has only service engine infos.
`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.
`Map<String,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.
`String`	`listSharedLibraries(String targetName)` return component info xml text that has only shared library infos.
`Map<String,String>`	`listSharedLibraries(String[] targetNames)` return component info xml text that has only shared library infos.
`String`	`listSharedLibraries(String componentName, String targetName)` returns the list of Shared Library infos in the in a xml format
`Map<String,String>`	`listSharedLibraries(String componentName, String[] targetNames)` returns the list of Shared Library infos in the in a xml format
`String`	`listSharedLibraryDependents(String sharedLibraryName, String targetName)` returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library
`Map<String,String>`	`listSharedLibraryDependents(String sharedLibraryName, String[] targetNames)` returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library
`CompositeType`	`queryApplicationConfigurationType(String componentName, String targetName)` Get the CompositeType definition for the components application configuration
`String`	`retrieveConfigurationDisplayData(String componentName, String targetName)` Retrieves the component configuration metadata.
`String`	`retrieveConfigurationDisplaySchema(String componentName, String targetname)` Retrieves the component specific configuration schema.
`String`	`setApplicationConfiguration(String componentName, String targetName, String name, Properties config)` Update a named application configuration in a component installed on a given target.
`String`	`setApplicationVariables(String componentName, String targetName, Properties appVariables)` Set application variables on a component installed on a given target.
`String`	`setComponentConfiguration(String targetName, String componentName, Properties configurationValues)` Will return jbi mgmt message with success, failure, or partial success per instance.
`void`	`setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName)` Sets the component log level for a given custom logger
`boolean`	`setRuntimeConfiguration(Properties parameters, String targetName)` This method sets one or more configuration parameters on the runtime with a list of name/value pairs passed as a properties object.
`void`	`setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName)` Sets the log level for a given runtime logger
`void`	`setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName)` Sets the log level for a given runtime logger
`String`	`showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName)` return component info xml text for the specified binding component if exists.
`Map<String,String>`	`showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)` return component info xml text for the specified binding component if exists.
`String`	`showServiceAssembly(String name, String state, String componentName, String targetName)` return service assembly info xml text for the specified service assembly if exists.
`Map<String,String>`	`showServiceAssembly(String name, String state, String componentName, String[] targetNames)` return service assembly info xml text for the specified service assembly if exists.
`String`	`showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName)` return component info xml text for the specified service engine if exists.
`Map<String,String>`	`showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)` return component info xml text for the specified service engine if exists.
`String`	`showSharedLibrary(String name, String componentName, String targetName)` return component info xml text for the specified shared library if exists.
`Map<String,String>`	`showSharedLibrary(String name, String componentName, String[] targetNames)` return component info xml text for the specified shared library if exists.
`String`	`shutdownComponent(String componentName, boolean force, String targetName)` shuts down component ( service engine, binding component)
`Map<String,String>`	`shutdownComponent(String componentName, boolean force, String[] targetNames)` shuts down component ( service engine, binding component)
`String`	`shutdownComponent(String componentName, String targetName)` shuts down component ( service engine, binding component)
`Map<String,String>`	`shutdownComponent(String componentName, String[] targetNames)` shuts down component ( service engine, binding component)
`String`	`shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName)` shuts down service assembly
`Map<String,String>`	`shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames)` shuts down service assembly
`String`	`shutdownServiceAssembly(String serviceAssemblyName, String targetName)` shuts down service assembly
`Map<String,String>`	`shutdownServiceAssembly(String serviceAssemblyName, String[] targetNames)` shuts down service assembly
`String`	`startComponent(String componentName, String targetName)` starts component ( service engine, binding component)
`Map<String,String>`	`startComponent(String componentName, String[] targetNames)` starts component ( service engine, binding component)
`String`	`startServiceAssembly(String serviceAssemblyName, String targetName)` starts service assembly
`Map<String,String>`	`startServiceAssembly(String serviceAssemblyName, String[] targetNames)` starts service assembly
`String`	`stopComponent(String componentName, String targetName)` stops component ( service engine, binding component)
`Map<String,String>`	`stopComponent(String componentName, String[] targetNames)` stops component ( service engine, binding component)
`String`	`stopServiceAssembly(String serviceAssemblyName, String targetName)` stops service assembly
`Map<String,String>`	`stopServiceAssembly(String serviceAssemblyName, String[] targetNames)` stops service assembly
`String`	`undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String targetName)` undeploys service assembly
`Map<String,String>`	`undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String[] targetNames)` undeploys service assembly
`String`	`undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String targetName)` undeploys service assembly
`Map<String,String>`	`undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String[] targetNames)` undeploys service assembly
`String`	`undeployServiceAssembly(String serviceAssemblyName, String targetName)` undeploys service assembly
`Map<String,String>`	`undeployServiceAssembly(String serviceAssemblyName, String[] targetNames)` undeploys service assembly
`String`	`uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String targetName)` uninstalls component ( service engine, binding component)
`Map<String,String>`	`uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String[] targetNames)` uninstalls component ( service engine, binding component)
`String`	`uninstallComponent(String componentName, boolean forceDelete, String targetName)` uninstalls component ( service engine, binding component)
`Map<String,String>`	`uninstallComponent(String componentName, boolean forceDelete, String[] targetNames)` uninstalls component ( service engine, binding component)
`String`	`uninstallComponent(String componentName, String targetName)` uninstalls component ( service engine, binding component)
`Map<String,String>`	`uninstallComponent(String componentName, String[] targetNames)` uninstalls component ( service engine, binding component)
`String`	`uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String targetName)` uninstalls shared library
`Map<String,String>`	`uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String[] targetNames)` uninstalls shared library
`String`	`uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String targetName)` uninstalls shared library
`Map<String,String>`	`uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String[] targetNames)` uninstalls shared library
`String`	`uninstallSharedLibrary(String sharedLibraryName, String targetName)` uninstalls shared library
`Map<String,String>`	`uninstallSharedLibrary(String sharedLibraryName, String[] targetNames)` uninstalls shared library
`String`	`updateComponent(String componentName, String zipFilePath)` updates component ( service engine, binding component)
`CompositeData`	`verifyApplication(String applicationURL, String targetName, boolean generateTemplates, String templateDir, boolean includeDeployCommand)` This method is used to verify if the application variables and application configuration objects used in the given application are available in JBI runtime in the specified target.

- Field Detail
  - DOMAIN_TARGET_KEY
```
static final String DOMAIN_TARGET_KEY
```
    See Also:
    Constant Field Values
  - SERVER_TARGET_KEY
```
static final String SERVER_TARGET_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_CONFIGURATION_NAME_KEY
```
static final String CUSTOM_CONFIGURATION_NAME_KEY
```
    See Also:
    Constant Field Values
  - CUSTOM_LOGGER_NAME_KEY
```
static final String CUSTOM_LOGGER_NAME_KEY
```
    See Also:
    Constant Field Values
- Method Detail
  - installComponent
```
String installComponent(String zipFilePath,
                      Properties paramProps,
                      String targetName)
                        throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    paramProps - Properties object contains name/value pair.
    zipFilePath - archive file in a zip format
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installComponent
```
String installComponent(String zipFilePath,
                      String targetName)
                        throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    zipFilePath - archive file in a zip format
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallComponent
```
String uninstallComponent(String componentName,
                        String targetName)
                          throws JBIRemoteException
```
    uninstalls component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installSharedLibrary
```
String installSharedLibrary(String zipFilePath,
                          String targetName)
                            throws JBIRemoteException
```
    installs shared library
    
    Parameters:
    zipFilePath - archive file in a zip format
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallSharedLibrary
```
String uninstallSharedLibrary(String sharedLibraryName,
                            String targetName)
                              throws JBIRemoteException
```
    uninstalls shared library
    
    Parameters:
    sharedLibraryName - name of the shared library
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - startComponent
```
String startComponent(String componentName,
                    String targetName)
                      throws JBIRemoteException
```
    starts component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - stopComponent
```
String stopComponent(String componentName,
                   String targetName)
                     throws JBIRemoteException
```
    stops component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownComponent
```
String shutdownComponent(String componentName,
                       String targetName)
                         throws JBIRemoteException
```
    shuts down component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownComponent
```
String shutdownComponent(String componentName,
                       boolean force,
                       String targetName)
                         throws JBIRemoteException
```
    shuts down component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    force - true if component should be shutdown in any case, else false.
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - deployServiceAssembly
```
String deployServiceAssembly(String zipFilePath,
                           String targetName)
                             throws JBIRemoteException
```
    deploys service assembly
    
    Parameters:
    zipFilePath - fie path
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - undeployServiceAssembly
```
String undeployServiceAssembly(String serviceAssemblyName,
                             String targetName)
                               throws JBIRemoteException
```
    undeploys service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - startServiceAssembly
```
String startServiceAssembly(String serviceAssemblyName,
                          String targetName)
                            throws JBIRemoteException
```
    starts service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - stopServiceAssembly
```
String stopServiceAssembly(String serviceAssemblyName,
                         String targetName)
                           throws JBIRemoteException
```
    stops service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownServiceAssembly
```
String shutdownServiceAssembly(String serviceAssemblyName,
                             String targetName)
                               throws JBIRemoteException
```
    shuts down service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownServiceAssembly
```
String shutdownServiceAssembly(String serviceAssemblyName,
                             boolean forceShutdown,
                             String targetName)
                               throws JBIRemoteException
```
    shuts down service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    forceShutdown -
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - listServiceEngines
```
String listServiceEngines(String targetName)
                          throws JBIRemoteException
```
    return component info xml text that has only service engine infos.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    the component info xml text.
    
    Throws:
    
    JBIRemoteException - on error
  - listServiceEngines
```
String listServiceEngines(String state,
                        String sharedLibraryName,
                        String serviceAssemblyName,
                        String targetName)
                          throws JBIRemoteException
```
    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 specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return all the service engines that have a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return all the service engines that have the specified service assembly deployed on them. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the list of service engine component infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listBindingComponents
```
String listBindingComponents(String targetName)
                             throws JBIRemoteException
```
    return component info xml text that has only binding component infos.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    the component info xml text.
    
    Throws:
    
    JBIRemoteException - on error
  - listBindingComponents
```
String listBindingComponents(String state,
                           String sharedLibraryName,
                           String serviceAssemblyName,
                           String targetName)
                             throws JBIRemoteException
```
    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 specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return all the binding components that have a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return all the binding components that have the specified service assembly deployed on them. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the list of binding component infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listSharedLibraryDependents
```
String listSharedLibraryDependents(String sharedLibraryName,
                                 String targetName)
                                   throws JBIRemoteException
```
    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
    targetName - name of the target for this operation
    
    Returns:
    xml string containing the list of componentInfos
    
    Throws:
    
    JBIRemoteException - on error
  - listSharedLibraries
```
String listSharedLibraries(String targetName)
                           throws JBIRemoteException
```
    return component info xml text that has only shared library infos.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    the component info xml text.
    
    Throws:
    
    JBIRemoteException - on error
  - listSharedLibraries
```
String listSharedLibraries(String componentName,
                         String targetName)
                           throws JBIRemoteException
```
    returns the list of Shared Library infos in the in a xml format
    
    Parameters:
    componentName - to return only the shared libraries that are this component dependents. null for listing all the shared libraries in the schemaorg_apache_xmlbeans.system.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain the list of componentinfos for shared libraries.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listServiceAssemblies
```
String listServiceAssemblies(String targetName)
                             throws JBIRemoteException
```
    returns a list of Service Assembly Infos in a xml format.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    xml text containing the Service Assembly infos
    
    Throws:
    
    JBIRemoteException - on error
  - listServiceAssemblies
```
String listServiceAssemblies(String componentName,
                           String targetName)
                             throws JBIRemoteException
```
    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 deployments on this component.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain the list of service assembly infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listServiceAssemblies
```
String listServiceAssemblies(String state,
                           String componentName,
                           String targetName)
                             throws JBIRemoteException
```
    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 specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state
    componentName - to list all the service assemblies that have some deployments on this component.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain the list of service assembly infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showServiceEngine
```
String showServiceEngine(String name,
                       String state,
                       String sharedLibraryName,
                       String serviceAssemblyName,
                       String targetName)
                         throws JBIRemoteException
```
    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
    state - return service engine that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return service engine that has a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return the service engine that has the specified service assembly deployed on it. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the service engine component info that confirms to the component info list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showBindingComponent
```
String showBindingComponent(String name,
                          String state,
                          String sharedLibraryName,
                          String serviceAssemblyName,
                          String targetName)
                            throws JBIRemoteException
```
    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
    state - return the binding component that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return the binding component that has a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return the binding component that has the specified service assembly deployed on it. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the binding component info that confirms to the component info list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showSharedLibrary
```
String showSharedLibrary(String name,
                       String componentName,
                       String targetName)
                         throws JBIRemoteException
```
    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
    componentName - return the shared library that is this component dependents. null to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain shared library component info that confirms to the component info list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showServiceAssembly
```
String showServiceAssembly(String name,
                         String state,
                         String componentName,
                         String targetName)
                           throws JBIRemoteException
```
    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
    state - return the service assembly that is in the specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state
    componentName - return the service assembly that has service units on this component.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain service assembly info that confirms to the service assembly list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - installComponent
```
Map<String,String> installComponent(String zipFilePath,
                                  Properties paramProps,
                                  String[] targetNames)
                                    throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    paramProps - Properties object contains name/value pair.
    zipFilePath - archive file in a zip format
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installComponent
```
Map<String,String> installComponent(String zipFilePath,
                                  String[] targetNames)
                                    throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    zipFilePath - archive file in a zip format
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallComponent
```
Map<String,String> uninstallComponent(String componentName,
                                    String[] targetNames)
                                      throws JBIRemoteException
```
    uninstalls component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installSharedLibrary
```
Map<String,String> installSharedLibrary(String zipFilePath,
                                      String[] targetNames)
                                        throws JBIRemoteException
```
    installs shared library
    
    Parameters:
    zipFilePath - archive file in a zip format
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallSharedLibrary
```
Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        String[] targetNames)
                                          throws JBIRemoteException
```
    uninstalls shared library
    
    Parameters:
    sharedLibraryName - name of the shared library
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - startComponent
```
Map<String,String> startComponent(String componentName,
                                String[] targetNames)
                                  throws JBIRemoteException
```
    starts component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - stopComponent
```
Map<String,String> stopComponent(String componentName,
                               String[] targetNames)
                                 throws JBIRemoteException
```
    stops component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownComponent
```
Map<String,String> shutdownComponent(String componentName,
                                   String[] targetNames)
                                     throws JBIRemoteException
```
    shuts down component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownComponent
```
Map<String,String> shutdownComponent(String componentName,
                                   boolean force,
                                   String[] targetNames)
                                     throws JBIRemoteException
```
    shuts down component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    force - true if component should be shutdown in any case, else false.
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - deployServiceAssembly
```
Map<String,String> deployServiceAssembly(String zipFilePath,
                                       String[] targetNames)
                                         throws JBIRemoteException
```
    deploys service assembly
    
    Parameters:
    zipFilePath - fie path
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - undeployServiceAssembly
```
Map<String,String> undeployServiceAssembly(String serviceAssemblyName,
                                         String[] targetNames)
                                           throws JBIRemoteException
```
    undeploys service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - startServiceAssembly
```
Map<String,String> startServiceAssembly(String serviceAssemblyName,
                                      String[] targetNames)
                                        throws JBIRemoteException
```
    starts service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - stopServiceAssembly
```
Map<String,String> stopServiceAssembly(String serviceAssemblyName,
                                     String[] targetNames)
                                       throws JBIRemoteException
```
    stops service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownServiceAssembly
```
Map<String,String> shutdownServiceAssembly(String serviceAssemblyName,
                                         String[] targetNames)
                                           throws JBIRemoteException
```
    shuts down service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - shutdownServiceAssembly
```
Map<String,String> shutdownServiceAssembly(String serviceAssemblyName,
                                         boolean forceShutdown,
                                         String[] targetNames)
                                           throws JBIRemoteException
```
    shuts down service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    forceShutdown -
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - listServiceEngines
```
Map<String,String> listServiceEngines(String[] targetNames)
                                      throws JBIRemoteException
```
    return component info xml text that has only service engine infos.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    the component info xml text.
    
    Throws:
    
    JBIRemoteException - on error
  - listServiceEngines
```
Map<String,String> listServiceEngines(String state,
                                    String sharedLibraryName,
                                    String serviceAssemblyName,
                                    String[] targetNames)
                                      throws JBIRemoteException
```
    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 specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return all the service engines that have a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return all the service engines that have the specified service assembly deployed on them. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the list of service engine component infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listBindingComponents
```
Map<String,String> listBindingComponents(String[] targetNames)
                                         throws JBIRemoteException
```
    return component info xml text that has only binding component infos.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    the component info xml text.
    
    Throws:
    
    JBIRemoteException - on error
  - listBindingComponents
```
Map<String,String> listBindingComponents(String state,
                                       String sharedLibraryName,
                                       String serviceAssemblyName,
                                       String[] targetNames)
                                         throws JBIRemoteException
```
    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 specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return all the binding components that have a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return all the binding components that have the specified service assembly deployed on them. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the list of binding component infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listSharedLibraryDependents
```
Map<String,String> listSharedLibraryDependents(String sharedLibraryName,
                                             String[] targetNames)
                                               throws JBIRemoteException
```
    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
    targetName - name of the target for this operation
    
    Returns:
    xml string containing the list of componentInfos
    
    Throws:
    
    JBIRemoteException - on error
  - listSharedLibraries
```
Map<String,String> listSharedLibraries(String[] targetNames)
                                       throws JBIRemoteException
```
    return component info xml text that has only shared library infos.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    the component info xml text.
    
    Throws:
    
    JBIRemoteException - on error
  - listSharedLibraries
```
Map<String,String> listSharedLibraries(String componentName,
                                     String[] targetNames)
                                       throws JBIRemoteException
```
    returns the list of Shared Library infos in the in a xml format
    
    Parameters:
    componentName - to return only the shared libraries that are this component dependents. null for listing all the shared libraries in the schemaorg_apache_xmlbeans.system.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain the list of componentinfos for shared libraries.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listServiceAssemblies
```
Map<String,String> listServiceAssemblies(String[] targetNames)
                                         throws JBIRemoteException
```
    returns a list of Service Assembly Infos in a xml format.
    
    Parameters:
    targetName - name of the target for this operation
    
    Returns:
    xml text containing the Service Assembly infos
    
    Throws:
    
    JBIRemoteException - on error
  - listServiceAssemblies
```
Map<String,String> listServiceAssemblies(String componentName,
                                       String[] targetNames)
                                         throws JBIRemoteException
```
    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 deployments on this component.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain the list of service assembly infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - listServiceAssemblies
```
Map<String,String> listServiceAssemblies(String state,
                                       String componentName,
                                       String[] targetNames)
                                         throws JBIRemoteException
```
    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 specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state
    componentName - to list all the service assemblies that have some deployments on this component.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain the list of service assembly infos
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showServiceEngine
```
Map<String,String> showServiceEngine(String name,
                                   String state,
                                   String sharedLibraryName,
                                   String serviceAssemblyName,
                                   String[] targetNames)
                                     throws JBIRemoteException
```
    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
    state - return service engine that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return service engine that has a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return the service engine that has the specified service assembly deployed on it. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the service engine component info that confirms to the component info list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showBindingComponent
```
Map<String,String> showBindingComponent(String name,
                                      String state,
                                      String sharedLibraryName,
                                      String serviceAssemblyName,
                                      String[] targetNames)
                                        throws JBIRemoteException
```
    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
    state - return the binding component that is in the specified state. valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or null for ANY state
    sharedLibraryName - return the binding component that has a dependency on the specified shared library. null value to ignore this option.
    serviceAssemblyName - return the binding component that has the specified service assembly deployed on it. null value to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml text contain the binding component info that confirms to the component info list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showSharedLibrary
```
Map<String,String> showSharedLibrary(String name,
                                   String componentName,
                                   String[] targetNames)
                                     throws JBIRemoteException
```
    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
    componentName - return the shared library that is this component dependents. null to ignore this option.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain shared library component info that confirms to the component info list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - showServiceAssembly
```
Map<String,String> showServiceAssembly(String name,
                                     String state,
                                     String componentName,
                                     String[] targetNames)
                                       throws JBIRemoteException
```
    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
    state - return the service assembly that is in the specified state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for ANY state
    componentName - return the service assembly that has service units on this component.
    targetName - name of the target for this operation
    
    Returns:
    xml string contain service assembly info that confirms to the service assembly list xml grammer.
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - isJBIRuntimeEnabled
```
boolean isJBIRuntimeEnabled()
                            throws JBIRemoteException
```
    Checks to see if the JBI Runtime is enabled.
    
    Returns:
    true if JBI Runtime Framework is available, false if not
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - getComponentInstallationDescriptor
```
String getComponentInstallationDescriptor(String componentName)
                                          throws JBIRemoteException
```
    Returns the jbi.xml Installation Descriptor for a Service Engine/Binding Component.
    
    Parameters:
    the - name of the ServiceEngine or Binding Component
    
    Returns:
    the jbi.xml deployment descriptor of the archive
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - getSharedLibraryInstallationDescriptor
```
String getSharedLibraryInstallationDescriptor(String sharedLibraryName)
                                              throws JBIRemoteException
```
    Returns the jbi.xml Installation Descriptor for a Shared Library.
    
    Parameters:
    the - name of the Shared Library
    
    Returns:
    the jbi.xml deployment descriptor of the archive
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - getServiceAssemblyDeploymentDescriptor
```
String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
                                              throws JBIRemoteException
```
    Returns the jbi.xml Deployment Descriptor for a Service Assembly.
    
    Parameters:
    the - name of the Service Assembly
    
    Returns:
    the jbi.xml deployment descriptor of the archive
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - getServiceUnitDeploymentDescriptor
```
String getServiceUnitDeploymentDescriptor(String serviceAssemblyName,
                                        String serviceUnitName)
                                          throws JBIRemoteException
```
    Returns the jbi.xml Deployment Descriptor for a Service Unit.
    
    Parameters:
    the - name of the Service Assembly
    the - name of the Service Unit
    
    Returns:
    the jbi.xml deployment descriptor of the archive
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - installComponentFromDomain
```
String installComponentFromDomain(String componentName,
                                String targetName)
                                  throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component.
    targetName - name of the target for this operation
    
    Returns:
    result.
    
    Throws:
    
    JBIRemoteException - on error
  - installComponentFromDomain
```
String installComponentFromDomain(String componentName,
                                Properties properties,
                                String targetName)
                                  throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component.
    component - configuration properties
    targetName - name of the target for this operation
    
    Returns:
    result.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallComponent
```
String uninstallComponent(String componentName,
                        boolean forceDelete,
                        String targetName)
                          throws JBIRemoteException
```
    uninstalls component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    forceDelete - true to delete, false to not
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installSharedLibraryFromDomain
```
String installSharedLibraryFromDomain(String libraryName,
                                    String targetName)
                                      throws JBIRemoteException
```
    installs shared library
    
    Parameters:
    libraryName - Shared Library Name
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallSharedLibrary
```
String uninstallSharedLibrary(String sharedLibraryName,
                            boolean forceDelete,
                            String targetName)
                              throws JBIRemoteException
```
    uninstalls shared library
    
    Parameters:
    sharedLibraryName - name of the shared library
    forceDelete - true to delete, false to not
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - deployServiceAssemblyFromDomain
```
String deployServiceAssemblyFromDomain(String assemblyName,
                                     String targetName)
                                       throws JBIRemoteException
```
    deploys service assembly
    
    Parameters:
    assemblyName - service assembly name
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - undeployServiceAssembly
```
String undeployServiceAssembly(String serviceAssemblyName,
                             boolean forceDelete,
                             String targetName)
                               throws JBIRemoteException
```
    undeploys service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    forceDelete - forces deletion of the assembly if true, false if not
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installComponentFromDomain
```
Map<String,String> installComponentFromDomain(String componentName,
                                            String[] targetNames)
                                              throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetNames - array of targets for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installComponentFromDomain
```
Map<String,String> installComponentFromDomain(String componentName,
                                            Properties properties,
                                            String[] targetNames)
                                              throws JBIRemoteException
```
    installs component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    targetNames - array of targets for this operation
    component - configuration properties
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallComponent
```
Map<String,String> uninstallComponent(String componentName,
                                    boolean forceDelete,
                                    String[] targetNames)
                                      throws JBIRemoteException
```
    uninstalls component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    forceDelete - true to delete, false to not
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - installSharedLibraryFromDomain
```
Map<String,String> installSharedLibraryFromDomain(String libraryName,
                                                String[] targetNames)
                                                  throws JBIRemoteException
```
    installs shared library
    
    Parameters:
    libraryName - name of the library
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallSharedLibrary
```
Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        boolean forceDelete,
                                        String[] targetNames)
                                          throws JBIRemoteException
```
    uninstalls shared library
    
    Parameters:
    sharedLibraryName - name of the shared library
    forceDelete - true to delete, false to not
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - deployServiceAssemblyFromDomain
```
Map<String,String> deployServiceAssemblyFromDomain(String assemblyName,
                                                 String[] targetNames)
                                                   throws JBIRemoteException
```
    deploys service assembly
    
    Parameters:
    assemblyName - name of the service assembly
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - undeployServiceAssembly
```
Map<String,String> undeployServiceAssembly(String serviceAssemblyName,
                                         boolean forceDelete,
                                         String[] targetNames)
                                           throws JBIRemoteException
```
    undeploys service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    forceDelete - true to delete, false to not
    targetName - name of the target for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallComponent
```
String uninstallComponent(String componentName,
                        boolean forceDelete,
                        boolean retainInDomain,
                        String targetName)
                          throws JBIRemoteException
```
    uninstalls component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    forceDelete - true to delete, false to not
    retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.
    targetName - name of the target for this operation
    
    Returns:
    component name string.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallSharedLibrary
```
String uninstallSharedLibrary(String sharedLibraryName,
                            boolean forceDelete,
                            boolean retainInDomain,
                            String targetName)
                              throws JBIRemoteException
```
    uninstalls shared library
    
    Parameters:
    sharedLibraryName - name of the shared library
    forceDelete - true to delete, false to not
    retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.
    targetName - name of the target for this operation
    
    Returns:
    shared library name string.
    
    Throws:
    
    JBIRemoteException - on error
  - undeployServiceAssembly
```
String undeployServiceAssembly(String serviceAssemblyName,
                             boolean forceDelete,
                             boolean retainInDomain,
                             String targetName)
                               throws JBIRemoteException
```
    undeploys service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    forceDelete - forces deletion of the assembly if true, false if not
    retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.
    targetName - name of the target for this operation
    
    Returns:
    result as a management message xml text string.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallComponent
```
Map<String,String> uninstallComponent(String componentName,
                                    boolean forceDelete,
                                    boolean retainInDomain,
                                    String[] targetNames)
                                      throws JBIRemoteException
```
    uninstalls component ( service engine, binding component)
    
    Parameters:
    componentName - name of the component
    forceDelete - true to delete, false to not
    retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.
    targetNames - array of targets for this operation
    
    Returns:
    Map of targetName and component name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - uninstallSharedLibrary
```
Map<String,String> uninstallSharedLibrary(String sharedLibraryName,
                                        boolean forceDelete,
                                        boolean retainInDomain,
                                        String[] targetNames)
                                          throws JBIRemoteException
```
    uninstalls shared library
    
    Parameters:
    sharedLibraryName - name of the shared library
    forceDelete - true to delete, false to not
    retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.
    targetNames - array of targets for this operation
    
    Returns:
    Map of targetName and shared library name strings.
    
    Throws:
    
    JBIRemoteException - on error
  - undeployServiceAssembly
```
Map<String,String> undeployServiceAssembly(String serviceAssemblyName,
                                         boolean forceDelete,
                                         boolean retainInDomain,
                                         String[] targetNames)
                                           throws JBIRemoteException
```
    undeploys service assembly
    
    Parameters:
    serviceAssemblyName - name of the service assembly
    forceDelete - forces deletion of the assembly if true, false if not
    retainInDomain - true to not delete it from the domain target, false to also delete it from the domain target.
    targetNames - array of targets for this operation
    
    Returns:
    Map of targetName and result as a management message xml text strings.
    
    Throws:
    
    JBIRemoteException - on error
  - getComponentLoggerLevels
```
Map<String,Level> getComponentLoggerLevels(String componentName,
                                         String targetName,
                                         String targetInstanceName)
                                           throws JBIRemoteException
```
    Gets the component custom loggers and their levels
    
    Parameters:
    componentName - name of the component
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    a Map of loggerCustomName to their log levels
    
    Throws:
    
    JBIRemoteException - on error
  - getComponentLoggerDisplayNames
```
Map<String,String> getComponentLoggerDisplayNames(String componentName,
                                                String targetName,
                                                String targetInstanceName)
                                                  throws JBIRemoteException
```
    Gets the component custom loggers and their display names.
    
    Parameters:
    componentName - name of the component
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    a Map of loggerCustomName to their log levels
    
    Throws:
    
    JBIRemoteException - on error
  - setComponentLoggerLevel
```
void setComponentLoggerLevel(String componentName,
                           String loggerCustomName,
                           Level logLevel,
                           String targetName,
                           String targetInstanceName)
                             throws JBIRemoteException
```
    Sets the component log level for a given custom logger
    
    Parameters:
    componentName - name of the component
    loggerCustomName - the custom logger name
    logLevel - the level to set the logger
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerLevels
```
Map<String,Level> getRuntimeLoggerLevels(String targetName,
                                       String targetInstanceName)
                                         throws JBIRemoteException
```
    Gets all the runtime loggers and their levels
    
    Parameters:
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    a Map of loggerCustomName to their log levels
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerLevel
```
Level getRuntimeLoggerLevel(String runtimeLoggerName,
                          String targetName,
                          String targetInstanceName)
                            throws JBIRemoteException
```
    Lookup the level of one runtime logger
    
    Parameters:
    runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    a Map of loggerCustomName to their log levels
    
    Throws:
    
    JBIRemoteException - on error
  - setRuntimeLoggerLevel
```
void setRuntimeLoggerLevel(String runtimeLoggerName,
                         Level logLevel,
                         String targetName,
                         String targetInstanceName)
                           throws JBIRemoteException
```
    Sets the log level for a given runtime logger
    
    Parameters:
    runtimeLoggerName - name of the runtime logger
    logLevel - the level to set the logger
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerNames
```
Map<String,String> getRuntimeLoggerNames(String targetName,
                                       String targetInstanceName)
                                         throws JBIRemoteException
```
    Gets all the runtime loggers and their display names
    
    Parameters:
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    a Map of display names to their logger names
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerDisplayName
```
String getRuntimeLoggerDisplayName(String runtimeLoggerName,
                                 String targetName,
                                 String targetInstanceName)
                                   throws JBIRemoteException
```
    Return the display name for a runtime logger
    
    Parameters:
    runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    the display name for the given logger
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerLevels
```
Map<String,Level> getRuntimeLoggerLevels(String targetName)
                                         throws JBIRemoteException
```
    Gets all the runtime loggers and their levels
    
    Parameters:
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    a Map of loggerCustomName to their log levels
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerLevel
```
Level getRuntimeLoggerLevel(String runtimeLoggerName,
                          String targetName)
                            throws JBIRemoteException
```
    Lookup the level of one runtime logger
    
    Parameters:
    runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    a Map of loggerCustomName to their log levels
    
    Throws:
    
    JBIRemoteException - on error
  - setRuntimeLoggerLevel
```
void setRuntimeLoggerLevel(String runtimeLoggerName,
                         Level logLevel,
                         String targetName)
                           throws JBIRemoteException
```
    Sets the log level for a given runtime logger
    
    Parameters:
    runtimeLoggerName - name of the runtime logger
    logLevel - the level to set the logger
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerNames
```
Map<String,String> getRuntimeLoggerNames(String targetName)
                                         throws JBIRemoteException
```
    Gets all the runtime loggers and their display names
    
    Parameters:
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    a Map of display names to their logger names
    
    Throws:
    
    JBIRemoteException - on error
  - getRuntimeLoggerDisplayName
```
String getRuntimeLoggerDisplayName(String runtimeLoggerName,
                                 String targetName)
                                   throws JBIRemoteException
```
    Return the display name for a runtime logger
    
    Parameters:
    runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    the display name for the given logger
    
    Throws:
    
    JBIRemoteException - on error
  - getComponentExtensionMBeanObjectNames
```
Map<String,ObjectName[]> getComponentExtensionMBeanObjectNames(String componentName,
                                                             String extensionName,
                                                             String targetName)
                                                               throws JBIRemoteException
```
    Gets the extension MBean object names
    
    Parameters:
    componentName - name of the component
    extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    
    Throws:
    
    JBIRemoteException - on error
  - getComponentExtensionMBeanObjectNames
```
ObjectName[] getComponentExtensionMBeanObjectNames(String componentName,
                                                 String extensionName,
                                                 String targetName,
                                                 String targetInstanceName)
                                                   throws JBIRemoteException
```
    Gets the extension MBean object names
    
    Parameters:
    componentName - name of the component
    extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
    targetName - name of the target (e.g., cluster1, server, etc.)
    targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
    
    Returns:
    an array of ObjectName(s)
    
    Throws:
    
    JBIRemoteException - on error
  - getComponentConfiguration
```
Properties getComponentConfiguration(String componentName,
                                   String targetName)
                                     throws JBIRemoteException
```
    Retrieve component configuration
    
    Parameters:
    componentName -
    targetName -
    
    Returns:
    the targetName as key and the name/value pairs as properties
    
    Throws:
    
    JBIRemoteException
  - setComponentConfiguration
```
String setComponentConfiguration(String targetName,
                               String componentName,
                               Properties configurationValues)
                                 throws JBIRemoteException
```
    Will return jbi mgmt message with success, failure, or partial success per instance. The entry per instance will have value as part of the management message (XML) String.
    
    Parameters:
    targetName - the name of the JBI target
    componentName - the component name
    configurationValues - the configuration properties
    
    Returns:
    
    Throws:
    
    JBIRemoteException
  - updateComponent
```
String updateComponent(String componentName,
                     String zipFilePath)
                       throws JBIRemoteException
```
    updates component ( service engine, binding component)
    
    Parameters:
    componentName - Name of the component to update.
    zipFilePath - archive file in a zip format
    
    Returns:
    The name of the component if successful
    
    Throws:
    
    JBIRemoteException - on error
  - isTargetUp
```
boolean isTargetUp(String targetName)
                   throws JBIRemoteException
```
    Checks to see if the Target (server, cluster) is up or down.
    
    Parameters:
    targetName - name of the target (e.g., cluster1, server, etc.)
    
    Returns:
    true if Target is up, false if not
    
    Throws:
    
    JBIRemoteException - if error or exception occurs.
  - getRuntimeConfigurationMetaData
```
Properties getRuntimeConfigurationMetaData(String propertyKeyName)
                                           throws JBIRemoteException
```
    This method returns the runtime configuration metadata associated with the specified property. The metadata contain name-value pairs like: default, descriptionID, descriptorType, displayName, displayNameId, isStatic, name, resourceBundleName, tooltip, tooltipId, etc.
    
    Parameters:
    propertyKeyName -
    
    Returns:
    Properties that represent runtime configuration metadata
    
    Throws:
    
    JBIRemoteException
  - setRuntimeConfiguration
```
boolean setRuntimeConfiguration(Properties parameters,
                              String targetName)
                                throws JBIRemoteException
```
    This method sets one or more configuration parameters on the runtime with a list of name/value pairs passed as a properties object. The property name in the properties object should be an existing configuration parameter name. If user try to set the parameter that is not in the configuration parameters list, this method will throw an exception. The value of the property can be any object. If the value is non string object, its string value (Object.toString()) will be used as a value that will be set on the configuration. This method first validates whether all the paramters passed in properties object exist in the runtime configuration or not. If any one the parameters passed is not existing, it will return an error without settings the parameters that are passed in the properties including a valid parameters. If there is an error in setting a paramter, this method throws an exception with the list of parameters that were not set.
    
    Parameters:
    params - Properties object that contains name/value pairs corresponding to the configuration parameters to be set on the runtime.
    targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server
    
    Returns:
    true if server restart is required, false if not
    
    Throws:
    
    JBIRemoteException - if there is a jmx error or a invalid parameter is passed in the params properties object. In case of an error setting the a particular parameter, the error message should list the invalid parameters.
  - getRuntimeConfiguration
```
Properties getRuntimeConfiguration(String targetName)
                                   throws JBIRemoteException
```
    This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor. The parameter descriptor should contain the following data that represents the parameter. name : name of the parameter value : value of the parameter as a String type. type : type of the parameter. Basic data types only. description: (optional) description of the parameter. displayName: (optional) display name of the parameter readOnly : true/false validValues : (optional) list of string values with ',' as delimiter. or a range value with - with a '-' as delimiter. min and max strings will be converted to the parameter type and then used to validate the value of the parameter.
    
    Parameters:
    targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server
    
    Returns:
    Properties that represents the list of configuration parameter descriptors.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - getDefaultRuntimeConfiguration
```
Properties getDefaultRuntimeConfiguration()
                                          throws JBIRemoteException
```
    This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor. The parameter descriptor should contain the following data that represents the parameter. name : name of the parameter value : value of the parameter as a String type. type : type of the parameter. Basic data types only. description: (optional) description of the parameter. displayName: (optional) display name of the parameter readOnly : true/false validValues : (optional) list of string values with ',' as delimiter. or a range value with - with a '-' as delimiter. min and max strings will be converted to the parameter type and then used to validate the value of the parameter.
    
    Parameters:
    targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server
    
    Returns:
    Properties that represents the list of configuration parameter descriptors.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - isServerRestartRequired
```
boolean isServerRestartRequired()
                                throws JBIRemoteException
```
    checks if the server need to be restarted to apply the changes made to some of the configuration parameters.
    
    Returns:
    true if server needs to be restarted for updated configuration to take effect. false if no server restart is needed.
    
    Throws:
    
    JBIRemoteException
  - verifyApplication
```
CompositeData verifyApplication(String applicationURL,
                              String targetName,
                              boolean generateTemplates,
                              String templateDir,
                              boolean includeDeployCommand)
                                throws JBIRemoteException
```
    This method is used to verify if the application variables and application configuration objects used in the given application are available in JBI runtime in the specified target. Also this method verifies if all necessary components are installed. If generateTemplates is true templates for missing application variables and application configurations are generated. A command script that uses the template files to set configuration objects is generated.
    
    Parameters:
    applicationURL - the URL for the application zip file
    targetName - the target on which the application has to be verified
    generateTemplates - true if templates have to be generated
    templateDir - the dir to store the generated templates
    includeDeployCommand - true if the generated script should include deploy command
    
    Throws:
    
    JBIRemoteException - if the application could not be verified Note: param templateDir is used between ant/cli and common client client TemplateZIPID is used between common client server and common client client
  - exportApplicationConfiguration
```
String exportApplicationConfiguration(String applicationName,
                                    String targetName,
                                    String configDir)
                                      throws JBIRemoteException
```
    This method is used to export the application variables and application configuration objects used by the given application in the specified target.
    
    Parameters:
    applicationName - the name of the application
    targetName - the target whose configuration has to be exported
    configDir - the dir to store the configurations
    
    Returns:
    String the id for the zip file with exported configurations
    
    Throws:
    
    JBIRemoteException - if the application configuration could not be exported Note: param configDir is used between ant/cli and common client client. The return value is used between common client server and common client client.
  - isAppVarsSupported
```
boolean isAppVarsSupported(String componentName,
                         String targetName)
                           throws JBIRemoteException
```
    Detect the components support for application variables. This method returns true if the component has a configuration MBean and implements all the operations for application variable management.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    true if the components configuration MBean implements all the operations for application variables.
    
    Throws:
    
    JBIRemoteException - if the component is not installed or is not in the Started state.
  - addApplicationVariables
```
String addApplicationVariables(String componentName,
                             String targetName,
                             Properties appVariables)
                               throws JBIRemoteException
```
    Add application variables to a component installed on a given target. If even a variable from the set is already set on the component, this operation fails.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    appVariables - - set of application variables to add. The values of the application variables have the application variable type and value and the format is "[type]value"
    
    Returns:
    a JBI Management message indicating the status of the operation. In case a variable is not added the management message has a ERROR task status message giving the details of the failure.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - setApplicationVariables
```
String setApplicationVariables(String componentName,
                             String targetName,
                             Properties appVariables)
                               throws JBIRemoteException
```
    Set application variables on a component installed on a given target. If even a variable from the set has not been added to the component, this operation fails.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    appVariables - - set of application variables to update. The values of the application variables have the application variable type and value and the format is "[type]value"
    
    Returns:
    a JBI Management message indicating the status of the operation. In case a variable is not set the management message has a ERROR task status message giving the details of the failure.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - deleteApplicationVariables
```
String deleteApplicationVariables(String componentName,
                                String targetName,
                                String[] appVariableNames)
                                  throws JBIRemoteException
```
    Delete application variables from a component installed on a given target. If even a variable from the set has not been added to the component, this operation fails.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    appVariableNames - - names of application variables to delete.
    
    Returns:
    a JBI Management message indicating the status of the operation. In case a variable is not deleted the management message has a ERROR task status message giving the details of the failure.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - getApplicationVariables
```
Properties getApplicationVariables(String componentName,
                                 String targetName)
                                   throws JBIRemoteException
```
    Get all the application variables set on a component.
    
    Returns:
    all the application variables et on the component. The return proerties set has the name="[type]value" pairs for the application variables.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - isAppConfigSupported
```
boolean isAppConfigSupported(String componentName,
                           String targetName)
                             throws JBIRemoteException
```
    Detect the components support for application configuration. This method returns true if the component has a configuration MBean and implements all the operations for application configuration management.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    true if the components configuration MBean implements all the operations for application configuration.
    
    Throws:
    
    JBIRemoteException - if the component is not installed or is not in the Started state.
  - queryApplicationConfigurationType
```
CompositeType queryApplicationConfigurationType(String componentName,
                                              String targetName)
                                                throws JBIRemoteException
```
    Get the CompositeType definition for the components application configuration
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    the CompositeType for the components application configuration.
    
    Throws:
    
    JBIRemoteException
  - addApplicationConfiguration
```
String addApplicationConfiguration(String componentName,
                                 String targetName,
                                 String name,
                                 Properties config)
                                   throws JBIRemoteException
```
    Add a named application configuration to a component installed on a given target.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    name - application configuration name
    config - application configuration represented as a set of properties.
    
    Returns:
    a JBI Management message indicating the status of the operation.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - setApplicationConfiguration
```
String setApplicationConfiguration(String componentName,
                                 String targetName,
                                 String name,
                                 Properties config)
                                   throws JBIRemoteException
```
    Update a named application configuration in a component installed on a given target.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    name - application configuration name
    config - application configuration represented as a set of properties.
    
    Returns:
    a JBI Management message indicating the status of the operation.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - deleteApplicationConfiguration
```
String deleteApplicationConfiguration(String componentName,
                                    String targetName,
                                    String name)
                                      throws JBIRemoteException
```
    Delete a named application configuration in a component installed on a given target.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    name - name of application configuration to be deleted
    
    Returns:
    a JBI Management message indicating the status of the operation.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - listApplicationConfigurationNames
```
String[] listApplicationConfigurationNames(String componentName,
                                         String targetName)
                                           throws JBIRemoteException
```
    List all the application configurations in a component.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    an array of names of all the application configurations.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - getApplicationConfiguration
```
Properties getApplicationConfiguration(String componentName,
                                     String targetName,
                                     String name)
                                       throws JBIRemoteException
```
    Get a specific named configuration. If the named configuration does not exist in the component the returned properties is an empty set.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    the application configuration represented as a set of properties.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - getApplicationConfigurations
```
Map<String,Properties> getApplicationConfigurations(String componentName,
                                                  String targetName)
                                                    throws JBIRemoteException
```
    Get all the application configurations set on a component.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    a map of all the application configurations keyed by the configuration name.
    
    Throws:
    
    JBIRemoteException - if there is a jmx error accessing the instance
  - retrieveConfigurationDisplaySchema
```
String retrieveConfigurationDisplaySchema(String componentName,
                                        String targetname)
                                          throws JBIRemoteException
```
    Retrieves the component specific configuration schema.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    a String containing the configuration schema.
    
    Throws:
    
    JBIRemoteException
  - retrieveConfigurationDisplayData
```
String retrieveConfigurationDisplayData(String componentName,
                                      String targetName)
                                        throws JBIRemoteException
```
    Retrieves the component configuration metadata. The XML data conforms to the component configuration schema.
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    a String containing the configuration metadata.
    
    Throws:
    
    JBIRemoteException
  - isComponentConfigSupported
```
boolean isComponentConfigSupported(String componentName,
                                 String targetName)
                                   throws JBIRemoteException
```
    Detect the components support for component configuration. This method returns true if the component has a configuration MBean with configurable attributes
    
    Parameters:
    componentName - component identification
    targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
    
    Returns:
    true if the components configuration MBean has configuration attributes
    
    Throws:
    
    JBIRemoteException - if the component is not installed or is not in the Started state.
  - getFrameworkStats
```
TabularData getFrameworkStats(String targetName)
                              throws JBIRemoteException
```
    This method is used to provide JBIFramework statistics in the given target.
    
    Parameters:
    target - target name.
    
    Returns:
    TabularData table of framework statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean
    
    Throws:
    
    JBIRemoteException
  - getComponentStats
```
TabularData getComponentStats(String componentName,
                            String targetName)
                              throws JBIRemoteException
```
    This method is used to provide statistics for the given component in the given target
    
    Parameters:
    targetName - target name
    componentName - component name
    
    Returns:
    TabularData table of component statistics If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean
    
    Throws:
    
    JBIRemoteException
  - getEndpointStats
```
TabularData getEndpointStats(String endpointName,
                           String targetName)
                             throws JBIRemoteException
```
    This method is used to provide statistic information about the given endpoint in the given target
    
    Parameters:
    targetName - target name
    endpointName - the endpoint Name
    
    Returns:
    TabularData table of endpoint statistics If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean
    
    Throws:
    
    JBIRemoteException
  - getNMRStats
```
TabularData getNMRStats(String targetName)
                        throws JBIRemoteException
```
    This method is used to provide statistics about the message service in the given target.
    
    Parameters:
    target - target name.
    
    Returns:
    TabularData table of NMR statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean
    
    Throws:
    
    JBIRemoteException
  - getServiceAssemblyStats
```
TabularData getServiceAssemblyStats(String saName,
                                  String targetName)
                                    throws JBIRemoteException
```
    This method is used to provide statistics about a Service Assembly in the given target.
    
    Parameters:
    target - target name.
    saName - the service assembly name.
    
    Returns:
    TabularData table of NMR statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean
    
    Throws:
    
    JBIRemoteException
  - getConsumingEndpointsForComponent
```
TabularData getConsumingEndpointsForComponent(String componentName,
                                            String targetName)
                                              throws JBIRemoteException
```
    This method is used to provide a list of consuming endpoints for a component.
    
    Parameters:
    componentName - component name
    target - target name.
    
    Returns:
    TabularData list of consuming endpoints
    
    Throws:
    
    JBIRemoteException - if the list of endpoints could not be obtained. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. Each entry in this tabular data is of the following composite type String - "InstanceName", String[] - "Endpoints",
  - getProvidingEndpointsForComponent
```
TabularData getProvidingEndpointsForComponent(String componentName,
                                            String targetName)
                                              throws JBIRemoteException
```
    This method is used to provide a list of provisioning endpoints for a component.
    
    Parameters:
    componentName - component name
    target - target name.
    
    Returns:
    TabularData list of provisioning endpoints
    
    Throws:
    
    JBIRemoteException - if the list of endpoints could not be obtained. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. Each entry in this tabular data is of the following composite type String - "InstanceName", String[] - "Endpoints",

Interface JBIAdminCommands

Field Summary

Method Summary

Field Detail

DOMAIN_TARGET_KEY

SERVER_TARGET_KEY

CUSTOM_CONFIGURATION_NAME_KEY

CUSTOM_LOGGER_NAME_KEY

Method Detail

installComponent

installComponent

uninstallComponent

installSharedLibrary

uninstallSharedLibrary

startComponent

stopComponent

shutdownComponent

shutdownComponent

deployServiceAssembly

undeployServiceAssembly

startServiceAssembly

stopServiceAssembly

shutdownServiceAssembly

shutdownServiceAssembly

listServiceEngines

listServiceEngines

listBindingComponents

listBindingComponents

listSharedLibraryDependents

listSharedLibraries

listSharedLibraries

listServiceAssemblies

listServiceAssemblies

listServiceAssemblies

showServiceEngine

showBindingComponent

showSharedLibrary

showServiceAssembly

installComponent

installComponent

uninstallComponent

installSharedLibrary

uninstallSharedLibrary

startComponent

stopComponent

shutdownComponent

shutdownComponent

deployServiceAssembly

undeployServiceAssembly

startServiceAssembly

stopServiceAssembly

shutdownServiceAssembly

shutdownServiceAssembly

listServiceEngines

listServiceEngines

listBindingComponents

listBindingComponents

listSharedLibraryDependents

listSharedLibraries

listSharedLibraries

listServiceAssemblies

listServiceAssemblies

listServiceAssemblies

showServiceEngine

showBindingComponent

showSharedLibrary

showServiceAssembly

isJBIRuntimeEnabled

getComponentInstallationDescriptor

getSharedLibraryInstallationDescriptor

getServiceAssemblyDeploymentDescriptor

getServiceUnitDeploymentDescriptor

installComponentFromDomain

installComponentFromDomain

uninstallComponent

installSharedLibraryFromDomain

uninstallSharedLibrary

deployServiceAssemblyFromDomain

undeployServiceAssembly

installComponentFromDomain