| java.lang.Object
 com.sun.jbi.ui.client.JBIAdminCommandsClientImpl
| JBIAdminCommandsClientImpl | | public class JBIAdminCommandsClientImpl implements Serializable,JBIAdminCommands(Code) | | Implements the JBIAdminCommands interfaces on the client side.
author:
graj |
| Method Summary | |
| public String | addApplicationConfiguration(String componentName, String targetName, String name, Properties config)
Add a named application configuration to a component installed on a given
target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | addApplicationVariables(String componentName, String targetName, Properties appVariables)
Add application variables to a component installed on a given target. | | public String | deleteApplicationConfiguration(String componentName, String targetName, String name)
Delete a named application configuration in a component installed on a
given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | deleteApplicationVariables(String componentName, String targetName, String[] appVariableNames)
Delete application variables from a component installed on a given
target. | | public String | deployServiceAssembly(String zipFilePath, String targetName)
| | public Map<String, String> | deployServiceAssembly(String zipFilePath, String[] targetNames)
| | public String | deployServiceAssemblyFromDomain(String assemblyName, String targetName)
| | public Map<String /* targetName */, String | deployServiceAssemblyFromDomain(String assemblyName, String[] targetNames)
| | public static void | displayResult(String testingOperation, String result)
| | public static void | displayResult(String testingOperation, Map<String, String> resultObject)
| | public 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. | | public static String | formatTargetNames(String target)
| | public static String | formatTargetNames(String[] target)
| | protected AdministrationService | getAdministrationService()
| | public Properties | getApplicationConfiguration(String componentName, String targetName, String name)
Get a specific named configuration. | | public Map<String, Properties> | getApplicationConfigurations(String componentName, String targetName)
Get all the application configurations set on a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public Properties | getApplicationVariables(String componentName, String targetName)
Get all the application variables set on a component.
all the application variables et on the component. | | public Properties | getComponentConfiguration(String componentName, String targetName)
| | public Map<String /* targetInstanceName */, ObjectName[]> | getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName)
| | public ObjectName[] | getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName)
| | public String | getComponentInstallationDescriptor(String componentName)
Retrieve the Component Installation descriptor for the server target.
The Installation descriptor will never be different for a component name
in a JBI system because there's only one component allowed with that same
name. | | public Map<String /* loggerCustomName */, String | getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName)
Gets the component custom loggers and their display names. | | public Map<String /* loggerCustomName */, Level | getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName)
| | public TabularData | getComponentStats(String componentName, String targetName)
| | protected ConfigurationService | getConfigurationService()
| | public TabularData | getConsumingEndpointsForComponent(String componentName, String targetName)
This method is used to provide a list of consuming endpoints for a component.
Parameters:
componentName - component name
Parameters:
target - target name. | | public Properties | getDefaultRuntimeConfiguration()
This method returns a tabular data of a complex open data objects that
represent the runtime configuration parameter descriptor. | | protected DeploymentService | getDeploymentService()
| | public TabularData | getEndpointStats(String endpointName, String targetName)
| | public TabularData | getFrameworkStats(String targetName)
This method is used to provide JBIFramework statistics in the
given target.
Parameters:
target - target name. | | protected static I18NBundle | getI18NBundle()
| | protected InstallationService | getInstallationService()
| | public TabularData | getNMRStats(String targetName)
This method is used to provide statistics about the message service in the
given target.
Parameters:
target - target name. | | protected PerformanceMeasurementService | getPerformanceMeasurementService()
| | public TabularData | getProvidingEndpointsForComponent(String componentName, String targetName)
This method is used to provide a list of provisioning endpoints for a component.
Parameters:
componentName - component name
Parameters:
target - target name. | | public Properties | getRuntimeConfiguration(String targetName)
This method returns a tabular data of a complex open data objects that
represent the runtime configuration parameter descriptor. | | public Properties | getRuntimeConfigurationMetaData(String propertyKeyName)
This method returns the runtime configuration metadata associated with
the specified property. | | public String | getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName)
Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. | | public String | getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName)
Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. | | public Level | getRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName)
Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. | | public Level | getRuntimeLoggerLevel(String runtimeLoggerName, String targetName)
Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. | | public Map<String /* runtimeLoggerName */, Level | getRuntimeLoggerLevels(String targetName, String targetInstanceName)
| | public Map<String /* runtimeLoggerName */, Level | getRuntimeLoggerLevels(String targetName)
| | public Map<String /* display name */, String | getRuntimeLoggerNames(String targetName, String targetInstanceName)
| | public Map<String /* display name */, String | getRuntimeLoggerNames(String targetName)
| | protected RuntimeManagementService | getRuntimeManagementService()
| | public String | getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
Retrieve the Service Assembly Deployment descriptor for the domain
target.
The deployment descriptor will never be different for a service assembly
name in a JBI system because there's only one Service Assembly allowed
with that same name. | | public TabularData | getServiceAssemblyStats(String saName, String targetName)
This method is used to provide statistics about a Service Assembly
in the given target.
Parameters:
target - target name.
Parameters:
saName - the service assembly name. | | public String | getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName)
Returns the jbi.xml Deployment Descriptor for a Service Unit. | | public String | getSharedLibraryInstallationDescriptor(String sharedLibraryName)
Retrieve the Shared Library Installation descriptor for the server
target.
The Installation descriptor will never be different for a Shared Library
name in a JBI system because there's only one Shared Library allowed with
that same name. | | public String | installComponent(String zipFilePath, Properties paramProps, String targetName)
| | public String | installComponent(String zipFilePath, String targetName)
| | public Map<String, String> | installComponent(String zipFilePath, Properties paramProps, String[] targetNames)
| | public Map<String, String> | installComponent(String zipFilePath, String[] targetNames)
| | public String | installComponentFromDomain(String componentName, String targetName)
| | public String | installComponentFromDomain(String componentName, Properties properties, String targetName)
| | public Map<String /* targetName */, String | installComponentFromDomain(String componentName, String[] targetNames)
| | public Map<String /* targetName */, String | installComponentFromDomain(String componentName, Properties properties, String[] targetNames)
| | public String | installSharedLibrary(String zipFilePath, String targetName)
| | public Map<String, String> | installSharedLibrary(String zipFilePath, String[] targetNames)
| | public String | installSharedLibraryFromDomain(String libraryName, String targetName)
| | public Map<String /* targetName */, String | installSharedLibraryFromDomain(String libraryName, String[] targetNames)
| | public boolean | isAppConfigSupported(String componentName, String targetName)
Detect the components support for application configuration. | | public boolean | isAppVarsSupported(String componentName, String targetName)
Detect the components support for application variables. | | public boolean | isComponentConfigSupported(String componentName, String targetName)
Detect the components support for component configuration. | | public boolean | isJBIRuntimeEnabled()
Test whether the JBI Runtime is enabled. | | boolean | isRemoteConnection()
| | public boolean | isServerRestartRequired()
checks if the server need to be restarted to apply the changes made to
some of the configuration parameters.
true if server need to be restarted for updated configuration totake effect. | | public boolean | isTargetUp(String targetName)
Checks to see if the Target (server, cluster) is up or down. | | public String[] | listApplicationConfigurationNames(String componentName, String targetName)
List all the application configurations in a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | listBindingComponents(String targetName)
return component info xml text that has only binding component infos. | | public String | listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. | | public Map<String, String> | listBindingComponents(String[] targetNames)
return component info xml text that has only binding component infos. | | public 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.
Parameters:
state - return all the binding components that are in the specifiedstate. | | public String | listServiceAssemblies(String targetName)
returns a list of Service Assembly Infos in a xml format. | | public String | listServiceAssemblies(String componentName, String targetName)
returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component. | | public String | listServiceAssemblies(String state, String componentName, String targetName)
returns the list of service asssembly infos in a xml format that have the
service unit deployed on the specified component.
Parameters:
state - to return all the service assemblies that are in the specifiedstate. | | public Map<String, String> | listServiceAssemblies(String[] targetNames)
returns a list of Service Assembly Infos in a xml format. | | public 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. | | public 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.
Parameters:
state - to return all the service assemblies that are in the specifiedstate. | | public String | listServiceEngines(String targetName)
return component info xml text that has only service engine infos. | | public String | listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. | | public Map<String, String> | listServiceEngines(String[] targetNames)
return component info xml text that has only service engine infos. | | public 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.
Parameters:
state - return all the service engines that are in the specifiedstate. | | public String | listSharedLibraries(String targetName)
return component info xml text that has only shared library infos. | | public String | listSharedLibraries(String componentName, String targetName)
returns the list of Shared Library infos in the in a xml format
Parameters:
componentName - to return only the shared libraries that are this componentdependents. | | public Map<String, String> | listSharedLibraries(String[] targetNames)
return component info xml text that has only shared library infos. | | public Map<String, String> | listSharedLibraries(String componentName, String[] targetNames)
returns the list of Shared Library infos in the in a xml format
Parameters:
componentName - to return only the shared libraries that are this componentdependents. | | public String | listSharedLibraryDependents(String sharedLibraryName, String targetName)
| | public Map<String, String> | listSharedLibraryDependents(String sharedLibraryName, String[] targetNames)
| | public static void | main(String[] args)
| | public CompositeType | queryApplicationConfigurationType(String componentName, String targetName)
Get the CompositeType definition for the components application configuration
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | retrieveConfigurationDisplayData(String componentName, String targetName)
Retrieves the component configuration metadata. | | public String | retrieveConfigurationDisplaySchema(String componentName, String targetName)
Retrieves the component specific configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | setApplicationConfiguration(String componentName, String targetName, String name, Properties config)
Update a named application configuration in a component installed on a
given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | setApplicationVariables(String componentName, String targetName, Properties appVariables)
Set application variables on a component installed on a given target. | | public Properties | setComponentConfiguration(String componentName, Properties configurationValues, String targetName)
Will return jbi mgmt message with success, failure, or partial success
per instance. | | public String | setComponentConfiguration(String targetName, String componentName, Properties configurationValues)
Will return jbi mgmt message with success, failure, or partial success
per instance. | | public void | setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName)
| | public 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. | | public void | setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName)
| | public void | setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName)
| | public String | showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text for the specified binding component if
exists. | | public Map<String, String> | showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)
return component info xml text for the specified binding component if
exists. | | public String | showServiceAssembly(String name, String state, String componentName, String targetName)
return service assembly info xml text for the specified service assembly
if exists. | | public Map<String, String> | showServiceAssembly(String name, String state, String componentName, String[] targetNames)
return service assembly info xml text for the specified service assembly
if exists. | | public String | showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName)
return component info xml text for the specified service engine if
exists. | | public Map<String, String> | showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames)
return component info xml text for the specified service engine if
exists. | | public String | showSharedLibrary(String name, String componentName, String targetName)
return component info xml text for the specified shared library if
exists. | | public Map<String, String> | showSharedLibrary(String name, String componentName, String[] targetNames)
return component info xml text for the specified shared library if
exists. | | public String | shutdownComponent(String componentName, String targetName)
| | public String | shutdownComponent(String componentName, boolean force, String targetName)
| | public Map<String, String> | shutdownComponent(String componentName, String[] targetNames)
| | public Map<String, String> | shutdownComponent(String componentName, boolean force, String[] targetNames)
| | public String | shutdownServiceAssembly(String serviceAssemblyName, String targetName)
| | public String | shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName)
| | public Map<String /* targetName */, String | shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames)
| | public Map<String, String> | shutdownServiceAssembly(String serviceAssemblyName, String[] targetNames)
| | public String | startComponent(String componentName, String targetName)
| | public Map<String, String> | startComponent(String componentName, String[] targetNames)
| | public String | startServiceAssembly(String serviceAssemblyName, String targetName)
| | public Map<String, String> | startServiceAssembly(String serviceAssemblyName, String[] targetNames)
| | public String | stopComponent(String componentName, String targetName)
| | public Map<String, String> | stopComponent(String componentName, String[] targetNames)
| | public String | stopServiceAssembly(String serviceAssemblyName, String targetName)
| | public Map<String, String> | stopServiceAssembly(String serviceAssemblyName, String[] targetNames)
| | public static void | testCleanupSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
| | public static void | testMultipleTargetsCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String[] targetName)
| | public static void | testPrepareSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
| | public static void | testShowSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
| | public static void | testSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
| | public String | undeployServiceAssembly(String serviceAssemblyName, String targetName)
| | public Map<String, String> | undeployServiceAssembly(String serviceAssemblyName, String[] targetNames)
| | public String | undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String targetName)
| | public Map<String /* targetName */, String | undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String[] targetNames)
| | public String | undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String targetName)
| | public Map<String /* targetName */, String | undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String[] targetNames)
| | public String | uninstallComponent(String componentName, String targetName)
| | public Map<String, String> | uninstallComponent(String componentName, String[] targetNames)
| | public String | uninstallComponent(String componentName, boolean forceDelete, String targetName)
| | public Map<String /* targetName */, String | uninstallComponent(String componentName, boolean forceDelete, String[] targetNames)
| | public String | uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String targetName)
| | public Map<String /* targetName */, String | uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String[] targetNames)
| | public String | uninstallSharedLibrary(String sharedLibraryName, String targetName)
| | public Map<String, String> | uninstallSharedLibrary(String sharedLibraryName, String[] targetNames)
| | public String | uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String targetName)
| | public Map<String /* targetName */, String | uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String[] targetNames)
| | public String | uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String targetName)
| | public Map<String /* targetName */, String | uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String[] targetNames)
| | public String | updateComponent(String componentName, String zipFilePath)
| | String | validateServiceAssembly(String zipFilePath)
| | public 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. |
| isRemoteConnection | | boolean isRemoteConnection(Code) | | is this a local or remote connection
|
| mLastUploadId | | protected Object mLastUploadId(Code) | | last uploaded object reference
|
| serialVersionUID | | final static long serialVersionUID(Code) | | Determines if a de-serialized file is compatible with this class.
1. Run serialver -show from the command line 2. Point the tool to the
class file including the package, for example:
com.sun.jbi.ui.client.JBIAdminCommandsClientImpl - without the .class The
serialver docs for Windows OS is at:
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/serialver.html and
Unix OS is at:
http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/serialver.html
Maintainers must change this value if and only if the new version of this
class is not compatible with old versions. See Sun docs for details.
|
| JBIAdminCommandsClientImpl | | public JBIAdminCommandsClientImpl()(Code) | | Constructor
|
| JBIAdminCommandsClientImpl | | public JBIAdminCommandsClientImpl(MBeanServerConnection serverConnection, boolean isRemoteConnection)(Code) | | Constructor
|
| addApplicationConfiguration | | public String addApplicationConfiguration(String componentName, String targetName, String name, Properties config) throws JBIRemoteException(Code) | | Add a named application configuration to a component installed on a given
target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
name - application configuration name
Parameters:
config - application configuration represented as a set of properties. a JBI Management message indicating the status of the operation.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| addApplicationVariables | | public String addApplicationVariables(String componentName, String targetName, Properties appVariables) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
appVariables - -set of application variables to add. The values of theapplication variables have the application variable type andvalue and the format is "[type]value" a JBI Management message indicating the status of the operation.In case a variable is not added the management message has aERROR task status message giving the details of the failure.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| deleteApplicationConfiguration | | public String deleteApplicationConfiguration(String componentName, String targetName, String name) throws JBIRemoteException(Code) | | Delete a named application configuration in a component installed on a
given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
name - name of application configuration to be deleted a JBI Management message indicating the status of the operation.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| deleteApplicationVariables | | public String deleteApplicationVariables(String componentName, String targetName, String[] appVariableNames) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
appVariableNames - -names of application variables to delete. a JBI Management message indicating the status of the operation.In case a variable is not deleted the management message has aERROR task status message giving the details of the failure.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| deployServiceAssemblyFromDomain | | public String deployServiceAssemblyFromDomain(String assemblyName, String targetName) throws JBIRemoteException(Code) | | deploys service assembly
Parameters:
assemblyName - service assembly name
Parameters:
targetName - name of the target for this operation Map of targetName and management message xml text strings.
throws:
JBIRemoteException - on error |
| deployServiceAssemblyFromDomain | | public Map<String /* targetName */, String deployServiceAssemblyFromDomain(String assemblyName, String[] targetNames) throws JBIRemoteException(Code) | | deploys service assembly from domain target
Parameters:
assemblyName - name of the service assembly
Parameters:
targetName - name of the target for this operation Map of targetName and management message xml text strings.
throws:
JBIRemoteException - on error |
| displayResult | | public static void displayResult(String testingOperation, String result)(Code) | | Displays the result
Parameters:
result - |
| displayResult | | public static void displayResult(String testingOperation, Map<String, String> resultObject)(Code) | | Displays the result map
Parameters:
resultObject - |
| exportApplicationConfiguration | | public String exportApplicationConfiguration(String applicationName, String targetName, String configDir) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - the target whose configuration has to be exported
Parameters:
configDir - the dir to store the configurations
throws:
JBIRemoteException - if the application configuration could not be exportedNote: param configDir is used between ant/cli and common client client.The return value is used between common client server and common clientclient. |
| getApplicationConfiguration | | public Properties getApplicationConfiguration(String componentName, String targetName, String name) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. the application configuration represented as a set of properties.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| getApplicationConfigurations | | public Map<String, Properties> getApplicationConfigurations(String componentName, String targetName) throws JBIRemoteException(Code) | | Get all the application configurations set on a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. a map of all the application configurations keyed by theconfiguration name.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| getApplicationVariables | | public Properties getApplicationVariables(String componentName, String targetName) throws JBIRemoteException(Code) | | Get all the application variables set on a component.
all the application variables et on the component. The returnproerties set has the name="[type]value" pairs for theapplication variables. a JBI Management message indicating the status of the operation.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| getComponentConfiguration | | public Properties getComponentConfiguration(String componentName, String targetName) throws JBIRemoteException(Code) | | Retrieve component configuration
Parameters:
componentName -
Parameters:
targetName - the targetName as key and the name/value pairs as properties |
| getComponentExtensionMBeanObjectNames | | public Map<String /* targetInstanceName */, ObjectName[]> getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName) throws JBIRemoteException(Code) | | Gets the extension MBean object names
Parameters:
componentName - name of the component
Parameters:
extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
throws:
JBIRemoteException - on error |
| getComponentExtensionMBeanObjectNames | | public ObjectName[] getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Gets the extension MBean object names
Parameters:
componentName - name of the component
Parameters:
extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) an array of ObjectName(s)
throws:
JBIRemoteException - on error |
| getComponentLoggerDisplayNames | | public Map<String /* loggerCustomName */, String getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Gets the component custom loggers and their display names.
Parameters:
componentName - name of the component
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their display names
throws:
JBIRemoteException - on error |
| getComponentLoggerLevels | | public Map<String /* loggerCustomName */, Level getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Gets the component custom loggers and their levels
Parameters:
componentName - name of the component
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their log levels
throws:
JBIRemoteException - on error |
| getComponentStats | | public TabularData getComponentStats(String componentName, String targetName) throws JBIRemoteException(Code) | | This method is used to provide statistics for the given component
in the given target
Parameters:
targetName - target name
Parameters:
componentName - component name TabularData table of component statisticsIf 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 referto JBIStatisticsMBean |
| getConsumingEndpointsForComponent | | public TabularData getConsumingEndpointsForComponent(String componentName, String targetName) throws JBIRemoteException(Code) | | This method is used to provide a list of consuming endpoints for a component.
Parameters:
componentName - component name
Parameters:
target - target name. TabularData list of consuming endpoints 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 typeString - "InstanceName",String[] - "Endpoints", |
| getDefaultRuntimeConfiguration | | public Properties getDefaultRuntimeConfiguration() throws JBIRemoteException(Code) | | 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 whichconfiguration parameters will be set. null to represent thedefault instance which is admin server Map that represents the list of configurationparameter descriptors.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| getEndpointStats | | public TabularData getEndpointStats(String endpointName, String targetName) throws JBIRemoteException(Code) | | This method is used to provide statistic information about the given
endpoint in the given target
Parameters:
targetName - target name
Parameters:
endpointName - the endpoint Name TabularData table of endpoint statisticsIf 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 referto JBIStatisticsMBean |
| getFrameworkStats | | public TabularData getFrameworkStats(String targetName) throws JBIRemoteException(Code) | | This method is used to provide JBIFramework statistics in the
given target.
Parameters:
target - target name. 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 referto JBIStatisticsMBean |
| getI18NBundle | | protected static I18NBundle getI18NBundle()(Code) | | gives the I18N bundle
I18NBundle object |
| getNMRStats | | public TabularData getNMRStats(String targetName) throws JBIRemoteException(Code) | | This method is used to provide statistics about the message service in the
given target.
Parameters:
target - target name. 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 referto JBIStatisticsMBean |
| getProvidingEndpointsForComponent | | public TabularData getProvidingEndpointsForComponent(String componentName, String targetName) throws JBIRemoteException(Code) | | This method is used to provide a list of provisioning endpoints for a component.
Parameters:
componentName - component name
Parameters:
target - target name. TabularData list of provisioning endpoints 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 typeString - "InstanceName",String[] - "Endpoints", |
| getRuntimeConfiguration | | public Properties getRuntimeConfiguration(String targetName) throws JBIRemoteException(Code) | | 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 whichconfiguration parameters will be set. null to represent thedefault instance which is admin server Map that represents the list of configurationparameter descriptors.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| getRuntimeConfigurationMetaData | | public Properties getRuntimeConfigurationMetaData(String propertyKeyName) throws JBIRemoteException(Code) | | 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 - Properties that represent runtime configuration metadata
throws:
JBIRemoteException - |
| getRuntimeLoggerDisplayName | | public String getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) the display name for the given logger
throws:
JBIRemoteException - on error |
| getRuntimeLoggerDisplayName | | public String getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName) throws JBIRemoteException(Code) | | Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) the display name for the given logger
throws:
JBIRemoteException - on error |
| getRuntimeLoggerLevel | | public Level getRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their log levels
throws:
JBIRemoteException - on error |
| getRuntimeLoggerLevel | | public Level getRuntimeLoggerLevel(String runtimeLoggerName, String targetName) throws JBIRemoteException(Code) | | Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) a Map of loggerCustomName to their log levels
throws:
JBIRemoteException - on error |
| getRuntimeLoggerLevels | | public Map<String /* runtimeLoggerName */, Level getRuntimeLoggerLevels(String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Gets all the runtime loggers and their levels
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their log levels
throws:
JBIRemoteException - on error |
| getRuntimeLoggerLevels | | public Map<String /* runtimeLoggerName */, Level getRuntimeLoggerLevels(String targetName) throws JBIRemoteException(Code) | | Gets all the runtime loggers and their levels
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) a Map of loggerCustomName to their log levels
throws:
JBIRemoteException - on error |
| getRuntimeLoggerNames | | public Map<String /* display name */, String getRuntimeLoggerNames(String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Gets all the runtime loggers and their display names
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of display names to their logger names
throws:
JBIRemoteException - on error |
| getRuntimeLoggerNames | | public Map<String /* display name */, String getRuntimeLoggerNames(String targetName) throws JBIRemoteException(Code) | | Gets all the runtime loggers and their display names
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) a Map of display names to their logger names
throws:
JBIRemoteException - on error |
| getServiceAssemblyStats | | public TabularData getServiceAssemblyStats(String saName, String targetName) throws JBIRemoteException(Code) | | This method is used to provide statistics about a Service Assembly
in the given target.
Parameters:
target - target name.
Parameters:
saName - the service assembly name. 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 referto JBIStatisticsMBean |
| getServiceUnitDeploymentDescriptor | | public String getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName) throws JBIRemoteException(Code) | | Returns the jbi.xml Deployment Descriptor for a Service Unit.
Parameters:
the - name of the Service Assembly
Parameters:
the - name of the Service Unit the jbi.xml deployment descriptor of the archive
throws:
JBIRemoteException - if error or exception occurs. |
| installComponentFromDomain | | public String installComponentFromDomain(String componentName, String targetName) throws JBIRemoteException(Code) | | installs component ( service engine, binding component)
Parameters:
componentName - name of the component.
Parameters:
targetName - name of the target for this operation result.
throws:
JBIRemoteException - on error |
| installComponentFromDomain | | public String installComponentFromDomain(String componentName, Properties properties, String targetName) throws JBIRemoteException(Code) | | installs component ( service engine, binding component)
Parameters:
componentName - name of the component.
Parameters:
component - configuration properties
Parameters:
targetName - name of the target for this operation result.
throws:
JBIRemoteException - on error |
| installComponentFromDomain | | public Map<String /* targetName */, String installComponentFromDomain(String componentName, String[] targetNames) throws JBIRemoteException(Code) | | installs component from domain ( service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
targetNames - array of targets for this operation Map of targetName and component name strings.
throws:
JBIRemoteException - on error |
| installComponentFromDomain | | public Map<String /* targetName */, String installComponentFromDomain(String componentName, Properties properties, String[] targetNames) throws JBIRemoteException(Code) | | installs component from domain ( service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
component - configuration properties
Parameters:
targetNames - array of targets for this operation Map of targetName and component name strings.
throws:
JBIRemoteException - on error |
| installSharedLibraryFromDomain | | public String installSharedLibraryFromDomain(String libraryName, String targetName) throws JBIRemoteException(Code) | | installs shared library
Parameters:
libraryName - Shared Library Name
Parameters:
targetName - name of the target for this operation Map of targetName and shared library name strings.
throws:
JBIRemoteException - on error |
| installSharedLibraryFromDomain | | public Map<String /* targetName */, String installSharedLibraryFromDomain(String libraryName, String[] targetNames) throws JBIRemoteException(Code) | | installs shared library from domain
Parameters:
libraryName - name of the library
Parameters:
targetName - name of the target for this operation Map of targetName and shared library name strings.
throws:
JBIRemoteException - on error |
| isAppConfigSupported | | public boolean isAppConfigSupported(String componentName, String targetName) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. true if the components configuration MBean implements all theoperations for application configuration.
throws:
JBIRemoteException - if the component is not installed or is not in the Started state. |
| isAppVarsSupported | | public boolean isAppVarsSupported(String componentName, String targetName) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. true if the components configuration MBean implements all theoperations for application variables.
throws:
JBIRemoteException - if the component is not installed or is not in the Started state. |
| isComponentConfigSupported | | public boolean isComponentConfigSupported(String componentName, String targetName) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. true if the components configuration MBean has configuration attributes
throws:
JBIRemoteException - if the component is not installed or is not in the Started state. |
| isRemoteConnection | | boolean isRemoteConnection()(Code) | | is this a local or remote connection
true if remote, false if local |
| isServerRestartRequired | | public boolean isServerRestartRequired() throws JBIRemoteException(Code) | | checks if the server need to be restarted to apply the changes made to
some of the configuration parameters.
true if server need to be restarted for updated configuration totake effect. false if no server restart is needed. |
| isTargetUp | | public boolean isTargetUp(String targetName) throws JBIRemoteException(Code) | | Checks to see if the Target (server, cluster) is up or down.
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) true if Target is up, false if not
throws:
JBIRemoteException - if error or exception occurs. |
| listApplicationConfigurationNames | | public String[] listApplicationConfigurationNames(String componentName, String targetName) throws JBIRemoteException(Code) | | List all the application configurations in a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. an array of names of all the application configurations.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| listBindingComponents | | public String listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws JBIRemoteException(Code) | | return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the binding components that have a dependency onthe specified shared library. null value to ignore thisoption.
Parameters:
serviceAssemblyName - return all the binding components that have the specifiedservice assembly deployed on them. null value to ignore thisoption.
Parameters:
targetName - xml text contain the list of binding component infos
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.listBindingComponents(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| listBindingComponents | | public Map<String, String> listBindingComponents(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code) | | return component info xml text that has only binding component infos
which satisfies the options passed to the method.
Parameters:
state - return all the binding components that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the binding components that have a dependency onthe specified shared library. null value to ignore thisoption.
Parameters:
serviceAssemblyName - return all the binding components that have the specifiedservice assembly deployed on them. null value to ignore thisoption.
Parameters:
targetNames - xml text contain the list of binding component infos
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.listBindingComponents(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String[]) |
| listServiceEngines | | public String listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws JBIRemoteException(Code) | | return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the service engines that have a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return all the service engines that have the specified serviceassembly deployed on them. null value to ignore this option.
Parameters:
targetName - xml text contain the list of service engine component infos
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.listServiceEngines(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| listServiceEngines | | public Map<String, String> listServiceEngines(String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code) | | return component info xml text that has only service engine infos which
satisfies the options passed to the method.
Parameters:
state - return all the service engines that are in the specifiedstate. valid states are JBIComponentInfo.STARTED, STOPPED,INSTALLED or null for ANY state
Parameters:
sharedLibraryName - return all the service engines that have a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return all the service engines that have the specified serviceassembly deployed on them. null value to ignore this option.
Parameters:
targetNames - xml text contain the list of service engine component infos
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.listServiceEngines(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String[]) |
| main | | public static void main(String[] args)(Code) | |
Parameters:
args - |
| queryApplicationConfigurationType | | public CompositeType queryApplicationConfigurationType(String componentName, String targetName) throws JBIRemoteException(Code) | | Get the CompositeType definition for the components application configuration
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. the CompositeType for the components application configuration. |
| retrieveConfigurationDisplayData | | public String retrieveConfigurationDisplayData(String componentName, String targetName) throws JBIRemoteException(Code) | | Retrieves the component configuration metadata. The XML data conforms to
the component configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. a String containing the configuration metadata.
throws:
ManagementRemoteException - on errors |
| retrieveConfigurationDisplaySchema | | public String retrieveConfigurationDisplaySchema(String componentName, String targetName) throws JBIRemoteException(Code) | | Retrieves the component specific configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. a String containing the configuration schema.
throws:
ManagementRemoteException - on errors. |
| setApplicationConfiguration | | public String setApplicationConfiguration(String componentName, String targetName, String name, Properties config) throws JBIRemoteException(Code) | | Update a named application configuration in a component installed on a
given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
name - application configuration name
Parameters:
config - application configuration represented as a set of properties. a JBI Management message indicating the status of the operation.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| setApplicationVariables | | public String setApplicationVariables(String componentName, String targetName, Properties appVariables) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
appVariables - -set of application variables to update. The values of theapplication variables have the application variable type andvalue and the format is "[type]value" a JBI Management message indicating the status of the operation.In case a variable is not set the management message has a ERRORtask status message giving the details of the failure.
throws:
JBIRemoteException - if there is a jmx error accessing the instance |
| setComponentConfiguration | | public Properties setComponentConfiguration(String componentName, Properties configurationValues, String targetName) throws JBIRemoteException(Code) | | Will return jbi mgmt message with success, failure, or partial success
per instance. The Map entry per instance will have value as Properties
object. String object should be returned when there is a failure to
retrieve the configuration on a particular instance. The other way is to
have Properties object in both success and failure case, but in the
failure case, the Properties object will have a predefined name, value
pair ("com.sun.jbi.cluster.instance.error", "xml text" ) in the
properties object.
Parameters:
componentName -
Parameters:
configurationValue -
Parameters:
targetName - |
| setComponentConfiguration | | public String setComponentConfiguration(String targetName, String componentName, Properties configurationValues) throws JBIRemoteException(Code) | | 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
Parameters:
componentName - the component name
Parameters:
configurationValues - the configuration properties |
| setComponentLoggerLevel | | public void setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Sets the component log level for a given custom logger
Parameters:
componentName - name of the component
Parameters:
loggerCustomName - the custom logger name
Parameters:
logLevel - the level to set the logger
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
throws:
JBIRemoteException - on error |
| setRuntimeConfiguration | | public boolean setRuntimeConfiguration(Properties parameters, String targetName) throws JBIRemoteException(Code) | | 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:
Map - params Properties object that containsname/value pairs corresponding to the configuration parametersto be set on the runtime.
Parameters:
targetName - cluster or instance name ( e.g. cluster1, instance1 ) on whichconfiguration parameters will be set. null to represent thedefault instance which is admin server true if server restart is required, false if not
throws:
JBIRemoteException - if there is a jmx error or a invalid parameter is passed inthe params properties object. In case of an error setting thea particular parameter, the error message should list theinvalid parameters. |
| setRuntimeLoggerLevel | | public void setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName) throws JBIRemoteException(Code) | | Sets the log level for a given runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger
Parameters:
logLevel - the level to set the logger
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
throws:
JBIRemoteException - on error |
| setRuntimeLoggerLevel | | public void setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName) throws JBIRemoteException(Code) | | Sets the log level for a given runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger
Parameters:
logLevel - the level to set the logger
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
throws:
JBIRemoteException - on error |
| showBindingComponent | | public String showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws JBIRemoteException(Code) | | return component info xml text for the specified binding component if
exists. If no binding component with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the binding component to lookup
Parameters:
state - return the binding component that is in the specified state.valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLEDor null for ANY state
Parameters:
sharedLibraryName - return the binding component that has a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return the binding component that has the specified serviceassembly deployed on it. null value to ignore this option.
Parameters:
targetName - xml text contain the binding component info that confirms to thecomponent info list xml grammer.
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.showBindingComponent(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| showBindingComponent | | public Map<String, String> showBindingComponent(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code) | | return component info xml text for the specified binding component if
exists. If no binding component with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the binding component to lookup
Parameters:
state - return the binding component that is in the specified state.valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLEDor null for ANY state
Parameters:
sharedLibraryName - return the binding component that has a dependency on thespecified shared library. null value to ignore this option.
Parameters:
serviceAssemblyName - return the binding component that has the specified serviceassembly deployed on it. null value to ignore this option.
Parameters:
targetNames - xml text contain the binding component info that confirms to thecomponent info list xml grammer.
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.showBindingComponent(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String[]) |
| showServiceEngine | | public String showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws JBIRemoteException(Code) | | return component info xml text for the specified service engine if
exists. If no service engine with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the service engine to lookup
Parameters:
state - to return all the service engines that are in the specifiedstate. JBIComponentInfo.STARTED, STOPPED, INSTALLED or nullfor ANY state
Parameters:
sharedLibraryName - to return all the service engines that have a dependency onthe specified shared library. Could be null for not filteringthe service engines for this dependency.
Parameters:
serviceAssemblyName - to return all the service engines that have the specifiedservice assembly deployed on them. Could be null for notfiltering the service engines for this dependency.
Parameters:
targetName - xml string contain service engine component info
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.showServiceEngine(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| showServiceEngine | | public Map<String, String> showServiceEngine(String name, String state, String sharedLibraryName, String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code) | | return component info xml text for the specified service engine if
exists. If no service engine with that name exists, it returns the xml
with empty list.
Parameters:
name - name of the service engine to lookup
Parameters:
state - to return all the service engines that are in the specifiedstate. JBIComponentInfo.STARTED, STOPPED, INSTALLED or nullfor ANY state
Parameters:
sharedLibraryName - to return all the service engines that have a dependency onthe specified shared library. Could be null for not filteringthe service engines for this dependency.
Parameters:
serviceAssemblyName - to return all the service engines that have the specifiedservice assembly deployed on them. Could be null for notfiltering the service engines for this dependency.
Parameters:
targetNames - xml string contain service engine component info
throws:
JBIRemoteException - if error or exception occurs.
See Also: com.sun.jbi.ui.common.JBIAdminCommands.showServiceEngine(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String[]) |
| shutdownServiceAssembly | | public String shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName) throws JBIRemoteException(Code) | | shuts down service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceShutdown -
Parameters:
targetName - name of the target for this operation Map of targetName and result as a management message xml textstrings.
throws:
JBIRemoteException - on error |
| shutdownServiceAssembly | | public Map<String /* targetName */, String shutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames) throws JBIRemoteException(Code) | | shuts down service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceShutdown -
Parameters:
targetName - name of the target for this operation Map of targetName and result as a management message xml textstrings.
throws:
JBIRemoteException - on error |
| testCleanupSingleTargetCases | | public static void testCleanupSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)(Code) | | Cleanup Single target test cases
Parameters:
commands -
Parameters:
bindingName -
Parameters:
bindingArtifactFile -
Parameters:
engineName -
Parameters:
engineArtifactFile -
Parameters:
libraryName -
Parameters:
libraryArtifactFile -
Parameters:
targetName - |
| testMultipleTargetsCases | | public static void testMultipleTargetsCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String[] targetName)(Code) | | Testing Multiple Targets Use-Cases
Parameters:
commands -
Parameters:
bindingName -
Parameters:
bindingArtifactFile -
Parameters:
engineName -
Parameters:
engineArtifactFile -
Parameters:
libraryName -
Parameters:
libraryArtifactFile -
Parameters:
assemblyName -
Parameters:
assemblyArtifactFile -
Parameters:
targetName - |
| testPrepareSingleTargetCases | | public static void testPrepareSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)(Code) | | Prepare Single target test cases
Parameters:
commands -
Parameters:
bindingName -
Parameters:
bindingArtifactFile -
Parameters:
engineName -
Parameters:
engineArtifactFile -
Parameters:
libraryName -
Parameters:
libraryArtifactFile -
Parameters:
targetName - |
| testShowSingleTargetCases | | public static void testShowSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)(Code) | | list/show Single target test cases
Parameters:
commands -
Parameters:
bindingName -
Parameters:
bindingArtifactFile -
Parameters:
engineName -
Parameters:
engineArtifactFile -
Parameters:
libraryName -
Parameters:
libraryArtifactFile -
Parameters:
targetName - |
| testSingleTargetCases | | public static void testSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)(Code) | | Testing Single Target Use-Cases
Parameters:
commands -
Parameters:
bindingName -
Parameters:
bindingArtifactFile -
Parameters:
engineName -
Parameters:
engineArtifactFile -
Parameters:
libraryName -
Parameters:
libraryArtifactFile -
Parameters:
assemblyName -
Parameters:
assemblyArtifactFile -
Parameters:
targetName - |
| undeployServiceAssembly | | public String undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String targetName) throws JBIRemoteException(Code) | | undeploys service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceDelete - forces deletion of the assembly if true, false if not
Parameters:
targetName - name of the target for this operation Map of targetName and result as a management message xml textstrings.
throws:
JBIRemoteException - on error |
| undeployServiceAssembly | | public Map<String /* targetName */, String undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String[] targetNames) throws JBIRemoteException(Code) | | undeploys service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceDelete - true to delete, false to not
Parameters:
targetName - name of the target for this operation Map of targetName and result as a management message xml textstrings.
throws:
JBIRemoteException - on error |
| undeployServiceAssembly | | public String undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String targetName) throws JBIRemoteException(Code) | | undeploys service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceDelete - forces deletion of the assembly if true, false if not
Parameters:
retainInDomain - true to not delete it from the domain target, false to alsodelete it from the domain target.
Parameters:
targetName - name of the target for this operation result as a management message xml text string.
throws:
JBIRemoteException - on error |
| undeployServiceAssembly | | public Map<String /* targetName */, String undeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String[] targetNames) throws JBIRemoteException(Code) | | undeploys service assembly
Parameters:
serviceAssemblyName - name of the service assembly
Parameters:
forceDelete - forces deletion of the assembly if true, false if not
Parameters:
retainInDomain - true to not delete it from the domain target, false to alsodelete it from the domain target.
Parameters:
targetNames - array of targets for this operation Map of targetName and result as a management message xml textstrings.
throws:
JBIRemoteException - on error |
| uninstallComponent | | public String uninstallComponent(String componentName, boolean forceDelete, String targetName) throws JBIRemoteException(Code) | | uninstalls component ( service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
forceDelete - true to delete, false to not
Parameters:
targetName - name of the target for this operation Map of targetName and component name strings.
throws:
JBIRemoteException - on error |
| uninstallComponent | | public Map<String /* targetName */, String uninstallComponent(String componentName, boolean forceDelete, String[] targetNames) throws JBIRemoteException(Code) | | Forcefully uninstalls component ( service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
forceDelete - true to delete, false to not
Parameters:
targetName - name of the target for this operation Map of targetName and component name strings.
throws:
JBIRemoteException - on error |
| uninstallComponent | | public String uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String targetName) throws JBIRemoteException(Code) | | uninstalls component ( service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
forceDelete - true to delete, false to not
Parameters:
retainInDomain - true to not delete it from the domain target, false to alsodelete it from the domain target.
Parameters:
targetName - name of the target for this operation component name string.
throws:
JBIRemoteException - on error |
| uninstallComponent | | public Map<String /* targetName */, String uninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String[] targetNames) throws JBIRemoteException(Code) | | uninstalls component ( service engine, binding component)
Parameters:
componentName - name of the component
Parameters:
forceDelete - true to delete, false to not
Parameters:
retainInDomain - true to not delete it from the domain target, false to alsodelete it from the domain target.
Parameters:
targetNames - array of targets for this operation Map of targetName and component name strings.
throws:
JBIRemoteException - on error |
| uninstallSharedLibrary | | public String uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String targetName) throws JBIRemoteException(Code) | | uninstalls shared library
Parameters:
sharedLibraryName - name of the shared library
Parameters:
forceDelete - true to delete, false to not
Parameters:
targetName - name of the target for this operation Map of targetName and shared library name strings.
throws:
JBIRemoteException - on error |
| uninstallSharedLibrary | | public Map<String /* targetName */, String uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String[] targetNames) throws JBIRemoteException(Code) | | Forcefully uninstalls shared library
Parameters:
sharedLibraryName - name of the shared library
Parameters:
forceDelete - true to delete, false to not
Parameters:
targetName - name of the target for this operation Map of targetName and shared library name strings.
throws:
JBIRemoteException - on error |
| uninstallSharedLibrary | | public String uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String targetName) throws JBIRemoteException(Code) | | uninstalls shared library
Parameters:
sharedLibraryName - name of the shared library
Parameters:
forceDelete - true to delete, false to not
Parameters:
retainInDomain - true to not delete it from the domain target, false to alsodelete it from the domain target.
Parameters:
targetName - name of the target for this operation shared library name string.
throws:
JBIRemoteException - on error |
| uninstallSharedLibrary | | public Map<String /* targetName */, String uninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String[] targetNames) throws JBIRemoteException(Code) | | uninstalls shared library
Parameters:
sharedLibraryName - name of the shared library
Parameters:
forceDelete - true to delete, false to not
Parameters:
retainInDomain - true to not delete it from the domain target, false to alsodelete it from the domain target.
Parameters:
targetNames - array of targets for this operation Map of targetName and shared library name strings.
throws:
JBIRemoteException - on error |
| updateComponent | | public String updateComponent(String componentName, String zipFilePath) throws JBIRemoteException(Code) | | updates component (service engine, binding component)
Parameters:
componentName - Name of the component to update.
Parameters:
zipFilePath - archive file in a zip format The name of the component if successful
throws:
JBIRemoteException - on error |
| validateServiceAssembly | | String validateServiceAssembly(String zipFilePath)(Code) | | Retrieve the Service Assembly Name
Parameters:
zipFilePath - the name of the Service Assembly or null |
| verifyApplication | | public CompositeData verifyApplication(String applicationURL, String targetName, boolean generateTemplates, String templateDir, boolean includeDeployCommand) throws JBIRemoteException(Code) | | 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
Parameters:
targetName - the target on which the application has to be verified
Parameters:
generateTemplates - true if templates have to be generated
Parameters:
templateDir - the dir to store the generated templates
Parameters:
includeDeployCommand - true if the generated script should includedeploy command
throws:
JBIRemoteException - if the application could not be verifiedNote: param templateDir is used between ant/cli and common client clientTemplateZIPID is used between common client server and common client client |
|
|