Java Doc for JBIAdminCommandsClientImpl.java in  » ESB » open-esb » com » sun » jbi » ui » client » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ESB » open esb » com.sun.jbi.ui.client 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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


Field Summary
protected transient  AdministrationServiceadministrationService
    
transient  ManagementClientclient
    
protected transient  ConfigurationServiceconfigurationService
    
protected transient  DeploymentServicedeploymentService
    
protected transient  InstallationServiceinstallationService
    
 booleanisRemoteConnection
    
protected  ObjectmLastUploadId
    
protected transient  PerformanceMeasurementServiceperformanceMeasurementService
    
transient  MBeanServerConnectionremoteConnection
    
protected transient  RuntimeManagementServiceruntimeManagementService
    
final static  longserialVersionUID
     Determines if a de-serialized file is compatible with this class. 1.

Constructor Summary
public  JBIAdminCommandsClientImpl()
    
public  JBIAdminCommandsClientImpl(MBeanServerConnection serverConnection)
    
public  JBIAdminCommandsClientImpl(MBeanServerConnection serverConnection, boolean isRemoteConnection)
    

Method Summary
public  StringaddApplicationConfiguration(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  StringaddApplicationVariables(String componentName, String targetName, Properties appVariables)
     Add application variables to a component installed on a given target.
public  StringdeleteApplicationConfiguration(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  StringdeleteApplicationVariables(String componentName, String targetName, String[] appVariableNames)
     Delete application variables from a component installed on a given target.
public  StringdeployServiceAssembly(String zipFilePath, String targetName)
    
public  Map<String, String>deployServiceAssembly(String zipFilePath, String[] targetNames)
    
public  StringdeployServiceAssemblyFromDomain(String assemblyName, String targetName)
    
public  Map<String /* targetName */, StringdeployServiceAssemblyFromDomain(String assemblyName, String[] targetNames)
    
public static  voiddisplayResult(String testingOperation, String result)
    
public static  voiddisplayResult(String testingOperation, Map<String, String> resultObject)
    
public  StringexportApplicationConfiguration(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  StringformatTargetNames(String target)
    
public static  StringformatTargetNames(String[] target)
    
protected  AdministrationServicegetAdministrationService()
    
public  PropertiesgetApplicationConfiguration(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  PropertiesgetApplicationVariables(String componentName, String targetName)
     Get all the application variables set on a component. all the application variables et on the component.
public  PropertiesgetComponentConfiguration(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  StringgetComponentInstallationDescriptor(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 */, StringgetComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName)
     Gets the component custom loggers and their display names.
public  Map<String /* loggerCustomName */, LevelgetComponentLoggerLevels(String componentName, String targetName, String targetInstanceName)
    
public  TabularDatagetComponentStats(String componentName, String targetName)
    
protected  ConfigurationServicegetConfigurationService()
    
public  TabularDatagetConsumingEndpointsForComponent(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  PropertiesgetDefaultRuntimeConfiguration()
     This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
protected  DeploymentServicegetDeploymentService()
    
public  TabularDatagetEndpointStats(String endpointName, String targetName)
    
public  TabularDatagetFrameworkStats(String targetName)
     This method is used to provide JBIFramework statistics in the given target.
Parameters:
  target - target name.
protected static  I18NBundlegetI18NBundle()
    
protected  InstallationServicegetInstallationService()
    
public  TabularDatagetNMRStats(String targetName)
     This method is used to provide statistics about the message service in the given target.
Parameters:
  target - target name.
protected  PerformanceMeasurementServicegetPerformanceMeasurementService()
    
public  TabularDatagetProvidingEndpointsForComponent(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  PropertiesgetRuntimeConfiguration(String targetName)
     This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
public  PropertiesgetRuntimeConfigurationMetaData(String propertyKeyName)
     This method returns the runtime configuration metadata associated with the specified property.
public  StringgetRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName)
     Return the display name for a runtime logger
Parameters:
  runtimeLoggerName - name of the logger (e.g.
public  StringgetRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName)
     Return the display name for a runtime logger
Parameters:
  runtimeLoggerName - name of the logger (e.g.
public  LevelgetRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName)
     Lookup the level of one runtime logger
Parameters:
  runtimeLoggerName - name of the runtime logger (e.g.
public  LevelgetRuntimeLoggerLevel(String runtimeLoggerName, String targetName)
     Lookup the level of one runtime logger
Parameters:
  runtimeLoggerName - name of the runtime logger (e.g.
public  Map<String /* runtimeLoggerName */, LevelgetRuntimeLoggerLevels(String targetName, String targetInstanceName)
    
public  Map<String /* runtimeLoggerName */, LevelgetRuntimeLoggerLevels(String targetName)
    
public  Map<String /* display name */, StringgetRuntimeLoggerNames(String targetName, String targetInstanceName)
    
public  Map<String /* display name */, StringgetRuntimeLoggerNames(String targetName)
    
protected  RuntimeManagementServicegetRuntimeManagementService()
    
public  StringgetServiceAssemblyDeploymentDescriptor(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  TabularDatagetServiceAssemblyStats(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  StringgetServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName)
     Returns the jbi.xml Deployment Descriptor for a Service Unit.
public  StringgetSharedLibraryInstallationDescriptor(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  StringinstallComponent(String zipFilePath, Properties paramProps, String targetName)
    
public  StringinstallComponent(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  StringinstallComponentFromDomain(String componentName, String targetName)
    
public  StringinstallComponentFromDomain(String componentName, Properties properties, String targetName)
    
public  Map<String /* targetName */, StringinstallComponentFromDomain(String componentName, String[] targetNames)
    
public  Map<String /* targetName */, StringinstallComponentFromDomain(String componentName, Properties properties, String[] targetNames)
    
public  StringinstallSharedLibrary(String zipFilePath, String targetName)
    
public  Map<String, String>installSharedLibrary(String zipFilePath, String[] targetNames)
    
public  StringinstallSharedLibraryFromDomain(String libraryName, String targetName)
    
public  Map<String /* targetName */, StringinstallSharedLibraryFromDomain(String libraryName, String[] targetNames)
    
public  booleanisAppConfigSupported(String componentName, String targetName)
     Detect the components support for application configuration.
public  booleanisAppVarsSupported(String componentName, String targetName)
     Detect the components support for application variables.
public  booleanisComponentConfigSupported(String componentName, String targetName)
     Detect the components support for component configuration.
public  booleanisJBIRuntimeEnabled()
     Test whether the JBI Runtime is enabled.
 booleanisRemoteConnection()
    
public  booleanisServerRestartRequired()
     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  booleanisTargetUp(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  StringlistBindingComponents(String targetName)
     return component info xml text that has only binding component infos.
public  StringlistBindingComponents(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  StringlistServiceAssemblies(String targetName)
     returns a list of Service Assembly Infos in a xml format.
public  StringlistServiceAssemblies(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  StringlistServiceAssemblies(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  StringlistServiceEngines(String targetName)
     return component info xml text that has only service engine infos.
public  StringlistServiceEngines(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  StringlistSharedLibraries(String targetName)
     return component info xml text that has only shared library infos.
public  StringlistSharedLibraries(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  StringlistSharedLibraryDependents(String sharedLibraryName, String targetName)
    
public  Map<String, String>listSharedLibraryDependents(String sharedLibraryName, String[] targetNames)
    
public static  voidmain(String[] args)
    
public  CompositeTypequeryApplicationConfigurationType(String componentName, String targetName)
     Get the CompositeType definition for the components application configuration
Parameters:
  componentName - component identification
Parameters:
  targetName - identification of the target.
public  StringretrieveConfigurationDisplayData(String componentName, String targetName)
     Retrieves the component configuration metadata.
public  StringretrieveConfigurationDisplaySchema(String componentName, String targetName)
     Retrieves the component specific configuration schema.
Parameters:
  componentName - component identification
Parameters:
  targetName - identification of the target.
public  StringsetApplicationConfiguration(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  StringsetApplicationVariables(String componentName, String targetName, Properties appVariables)
     Set application variables on a component installed on a given target.
public  PropertiessetComponentConfiguration(String componentName, Properties configurationValues, String targetName)
     Will return jbi mgmt message with success, failure, or partial success per instance.
public  StringsetComponentConfiguration(String targetName, String componentName, Properties configurationValues)
     Will return jbi mgmt message with success, failure, or partial success per instance.
public  voidsetComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName)
    
public  booleansetRuntimeConfiguration(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  voidsetRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName)
    
public  voidsetRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName)
    
public  StringshowBindingComponent(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  StringshowServiceAssembly(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  StringshowServiceEngine(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  StringshowSharedLibrary(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  StringshutdownComponent(String componentName, String targetName)
    
public  StringshutdownComponent(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  StringshutdownServiceAssembly(String serviceAssemblyName, String targetName)
    
public  StringshutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String targetName)
    
public  Map<String /* targetName */, StringshutdownServiceAssembly(String serviceAssemblyName, boolean forceShutdown, String[] targetNames)
    
public  Map<String, String>shutdownServiceAssembly(String serviceAssemblyName, String[] targetNames)
    
public  StringstartComponent(String componentName, String targetName)
    
public  Map<String, String>startComponent(String componentName, String[] targetNames)
    
public  StringstartServiceAssembly(String serviceAssemblyName, String targetName)
    
public  Map<String, String>startServiceAssembly(String serviceAssemblyName, String[] targetNames)
    
public  StringstopComponent(String componentName, String targetName)
    
public  Map<String, String>stopComponent(String componentName, String[] targetNames)
    
public  StringstopServiceAssembly(String serviceAssemblyName, String targetName)
    
public  Map<String, String>stopServiceAssembly(String serviceAssemblyName, String[] targetNames)
    
public static  voidtestCleanupSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
    
public static  voidtestMultipleTargetsCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String[] targetName)
    
public static  voidtestPrepareSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
    
public static  voidtestShowSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
    
public static  voidtestSingleTargetCases(JBIAdminCommands commands, String bindingName, String bindingArtifactFile, String engineName, String engineArtifactFile, String libraryName, String libraryArtifactFile, String assemblyName, String assemblyArtifactFile, String targetName)
    
public  StringundeployServiceAssembly(String serviceAssemblyName, String targetName)
    
public  Map<String, String>undeployServiceAssembly(String serviceAssemblyName, String[] targetNames)
    
public  StringundeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String targetName)
    
public  Map<String /* targetName */, StringundeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, String[] targetNames)
    
public  StringundeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String targetName)
    
public  Map<String /* targetName */, StringundeployServiceAssembly(String serviceAssemblyName, boolean forceDelete, boolean retainInDomain, String[] targetNames)
    
public  StringuninstallComponent(String componentName, String targetName)
    
public  Map<String, String>uninstallComponent(String componentName, String[] targetNames)
    
public  StringuninstallComponent(String componentName, boolean forceDelete, String targetName)
    
public  Map<String /* targetName */, StringuninstallComponent(String componentName, boolean forceDelete, String[] targetNames)
    
public  StringuninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String targetName)
    
public  Map<String /* targetName */, StringuninstallComponent(String componentName, boolean forceDelete, boolean retainInDomain, String[] targetNames)
    
public  StringuninstallSharedLibrary(String sharedLibraryName, String targetName)
    
public  Map<String, String>uninstallSharedLibrary(String sharedLibraryName, String[] targetNames)
    
public  StringuninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String targetName)
    
public  Map<String /* targetName */, StringuninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, String[] targetNames)
    
public  StringuninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String targetName)
    
public  Map<String /* targetName */, StringuninstallSharedLibrary(String sharedLibraryName, boolean forceDelete, boolean retainInDomain, String[] targetNames)
    
public  StringupdateComponent(String componentName, String zipFilePath)
    
 StringvalidateServiceAssembly(String zipFilePath)
    
public  CompositeDataverifyApplication(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
administrationService
protected transient AdministrationService administrationService(Code)



client
transient ManagementClient client(Code)



configurationService
protected transient ConfigurationService configurationService(Code)



deploymentService
protected transient DeploymentService deploymentService(Code)



installationService
protected transient InstallationService installationService(Code)



isRemoteConnection
boolean isRemoteConnection(Code)
is this a local or remote connection



mLastUploadId
protected Object mLastUploadId(Code)
last uploaded object reference



performanceMeasurementService
protected transient PerformanceMeasurementService performanceMeasurementService(Code)



remoteConnection
transient MBeanServerConnection remoteConnection(Code)
remote MBeanServer connection



runtimeManagementService
protected transient RuntimeManagementService runtimeManagementService(Code)



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.




Constructor Detail
JBIAdminCommandsClientImpl
public JBIAdminCommandsClientImpl()(Code)
Constructor



JBIAdminCommandsClientImpl
public JBIAdminCommandsClientImpl(MBeanServerConnection serverConnection)(Code)
Constructor



JBIAdminCommandsClientImpl
public JBIAdminCommandsClientImpl(MBeanServerConnection serverConnection, boolean isRemoteConnection)(Code)
Constructor




Method Detail
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



deployServiceAssembly
public String deployServiceAssembly(String zipFilePath, String targetName) throws JBIRemoteException(Code)
deploys service assembly result as a management message xml text
Parameters:
  zipFilePath - file path
Parameters:
  targetName -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.deployServiceAssembly(java.lang.Stringjava.lang.String)



deployServiceAssembly
public Map<String, String> deployServiceAssembly(String zipFilePath, String[] targetNames) throws JBIRemoteException(Code)
deploys service assembly result as a management message xml text
Parameters:
  zipFilePath - file path
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.deployServiceAssembly(java.lang.Stringjava.lang.String[])



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.



formatTargetNames
public static String formatTargetNames(String target)(Code)



formatTargetNames
public static String formatTargetNames(String[] target)(Code)



getAdministrationService
protected AdministrationService getAdministrationService() throws JBIRemoteException(Code)
the administrationService
throws:
  JBIRemoteException -



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



getComponentInstallationDescriptor
public String getComponentInstallationDescriptor(String componentName) throws JBIRemoteException(Code)
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. Therefore, this implies a registry lookup for the server target.
Parameters:
  Component - name as a string the Component Installation descriptor as a string
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.getComponentInstallationDescriptor(java.lang.String)



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



getConfigurationService
protected ConfigurationService getConfigurationService() throws JBIRemoteException(Code)
the configurationService
throws:
  JBIRemoteException -



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



getDeploymentService
protected DeploymentService getDeploymentService() throws JBIRemoteException(Code)
the deploymentService
throws:
  JBIRemoteException -



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



getInstallationService
protected InstallationService getInstallationService() throws JBIRemoteException(Code)
the installationService
throws:
  JBIRemoteException -



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



getPerformanceMeasurementService
protected PerformanceMeasurementService getPerformanceMeasurementService() throws JBIRemoteException(Code)
the performanceMeasurementService
throws:
  JBIRemoteException -



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



getRuntimeManagementService
protected RuntimeManagementService getRuntimeManagementService() throws JBIRemoteException(Code)
the runtimeManagementService
throws:
  JBIRemoteException -



getServiceAssemblyDeploymentDescriptor
public String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName) throws JBIRemoteException(Code)
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. Therefore, this implies a registry lookup for the domain target.
Parameters:
  service - assembly name as a string the service assembly deployment descriptor as a string
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.getServiceAssemblyDeploymentDescriptor(java.lang.String)



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.



getSharedLibraryInstallationDescriptor
public String getSharedLibraryInstallationDescriptor(String sharedLibraryName) throws JBIRemoteException(Code)
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. Therefore, this implies a registry lookup for the server target.
Parameters:
  Shared - Library name as a string the Shared Library Installation descriptor as a string
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.getSharedLibraryInstallationDescriptor(java.lang.String)



installComponent
public String installComponent(String zipFilePath, Properties paramProps, String targetName) throws JBIRemoteException(Code)
installs component ( service engine, binding component) name of the component.
Parameters:
  paramProps - Properties object contains name/value pair.
Parameters:
  zipFilePath - archive file in a zip format
Parameters:
  targetName -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.installComponent(java.lang.Stringjava.util.Propertiesjava.lang.String)



installComponent
public String installComponent(String zipFilePath, String targetName) throws JBIRemoteException(Code)
installs component (service engine, binding component) name of the component.
Parameters:
  zipFilePath - archive file in a zip format
Parameters:
  targetName -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.installComponent(java.lang.Stringjava.lang.String)



installComponent
public Map<String, String> installComponent(String zipFilePath, Properties paramProps, String[] targetNames) throws JBIRemoteException(Code)
installs component ( service engine, binding component) name of the component.
Parameters:
  paramProps - Properties object contains name/value pair.
Parameters:
  zipFilePath - archive file in a zip format
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.installComponent(java.lang.Stringjava.util.Propertiesjava.lang.String[])



installComponent
public Map<String, String> installComponent(String zipFilePath, String[] targetNames) throws JBIRemoteException(Code)
installs component (service engine, binding component) name of the component.
Parameters:
  zipFilePath - archive file in a zip format
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.installComponent(java.lang.Stringjava.lang.String[])



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



installSharedLibrary
public String installSharedLibrary(String zipFilePath, String targetName) throws JBIRemoteException(Code)
installs shared library shared library name.
Parameters:
  zipFilePath - archive file in a zip format
Parameters:
  targetName -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.installSharedLibrary(java.lang.Stringjava.lang.String)



installSharedLibrary
public Map<String, String> installSharedLibrary(String zipFilePath, String[] targetNames) throws JBIRemoteException(Code)
installs shared library shared library name.
Parameters:
  zipFilePath - archive file in a zip format
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.installSharedLibrary(java.lang.Stringjava.lang.String[])



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.



isJBIRuntimeEnabled
public boolean isJBIRuntimeEnabled() throws JBIRemoteException(Code)
Test whether the JBI Runtime is enabled. true when the mbean is registered, false otherwise
throws:
  JBIRemoteException -
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.isJBIRuntimeEnabled



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 targetName) throws JBIRemoteException(Code)
return component info xml text that has only binding component infos. the component info xml text.
Parameters:
  targetName -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listBindingComponents(java.lang.String)



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[] targetNames) throws JBIRemoteException(Code)
return component info xml text that has only binding component infos. the component info xml text.
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listBindingComponents(java.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[])



listServiceAssemblies
public String listServiceAssemblies(String targetName) throws JBIRemoteException(Code)
returns a list of Service Assembly Infos in a xml format.
Parameters:
  targetName - xml text containing the Service Assembly infos
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceAssemblies(java.lang.String)



listServiceAssemblies
public String listServiceAssemblies(String componentName, String targetName) throws JBIRemoteException(Code)
returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
Parameters:
  componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
  targetName - xml string contain the list of service assembly infos
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceAssemblies(java.lang.Stringjava.lang.String)



listServiceAssemblies
public String listServiceAssemblies(String state, String componentName, String targetName) throws JBIRemoteException(Code)
returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
Parameters:
  state - to return all the service assemblies that are in the specifiedstate. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN ornull for ANY state
Parameters:
  componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
  targetName - xml string contain the list of service assembly infos
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceAssemblies(java.lang.Stringjava.lang.Stringjava.lang.String)



listServiceAssemblies
public Map<String, String> listServiceAssemblies(String[] targetNames) throws JBIRemoteException(Code)
returns a list of Service Assembly Infos in a xml format.
Parameters:
  targetNames - xml text containing the Service Assembly infos
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceAssemblies(java.lang.String[])



listServiceAssemblies
public Map<String, String> listServiceAssemblies(String componentName, String[] targetNames) throws JBIRemoteException(Code)
returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
Parameters:
  componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
  targetNames - xml string contain the list of service assembly infos
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceAssemblies(java.lang.Stringjava.lang.String[])



listServiceAssemblies
public Map<String, String> listServiceAssemblies(String state, String componentName, String[] targetNames) throws JBIRemoteException(Code)
returns the list of service asssembly infos in a xml format that have the service unit deployed on the specified component.
Parameters:
  state - to return all the service assemblies that are in the specifiedstate. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN ornull for ANY state
Parameters:
  componentName - to list all the service assemblies that have some deploymentson this component.
Parameters:
  targetNames - xml string contain the list of service assembly infos
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceAssemblies(java.lang.Stringjava.lang.Stringjava.lang.String[])



listServiceEngines
public String listServiceEngines(String targetName) throws JBIRemoteException(Code)
return component info xml text that has only service engine infos.
Parameters:
  targetName - the component info xml text.
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceEngines(java.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[] targetNames) throws JBIRemoteException(Code)
return component info xml text that has only service engine infos.
Parameters:
  targetNames - the component info xml text.
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listServiceEngines(java.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[])



listSharedLibraries
public String listSharedLibraries(String targetName) throws JBIRemoteException(Code)
return component info xml text that has only shared library infos.
Parameters:
  targetName - the component info xml text.
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listSharedLibraries(java.lang.String)



listSharedLibraries
public String listSharedLibraries(String componentName, String targetName) throws JBIRemoteException(Code)
returns the list of Shared Library infos in the in a xml format
Parameters:
  componentName - to return only the shared libraries that are this componentdependents. null for listing all the shared libraries in thesystem.
Parameters:
  targetName - xml string contain the list of componentinfos for sharedlibraries.
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listSharedLibraries(java.lang.Stringjava.lang.String)



listSharedLibraries
public Map<String, String> listSharedLibraries(String[] targetNames) throws JBIRemoteException(Code)
return component info xml text that has only shared library infos.
Parameters:
  targetNames - the component info xml text.
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listSharedLibraries(java.lang.String[])



listSharedLibraries
public Map<String, String> listSharedLibraries(String componentName, String[] targetNames) throws JBIRemoteException(Code)
returns the list of Shared Library infos in the in a xml format
Parameters:
  componentName - to return only the shared libraries that are this componentdependents. null for listing all the shared libraries in thesystem.
Parameters:
  targetNames - xml string contain the list of componentinfos for sharedlibraries.
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listSharedLibraries(java.lang.Stringjava.lang.String[])



listSharedLibraryDependents
public String listSharedLibraryDependents(String sharedLibraryName, String targetName) throws JBIRemoteException(Code)
returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library
Parameters:
  sharedLibraryName - the shared library name
Parameters:
  targetName - xml string containing the list of componentInfos
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listSharedLibraryDependents(java.lang.Stringjava.lang.String)



listSharedLibraryDependents
public Map<String, String> listSharedLibraryDependents(String sharedLibraryName, String[] targetNames) throws JBIRemoteException(Code)
returns a list of Binding Component and Service Engine infos in xml format, that are dependent upon a specified Shared Library
Parameters:
  sharedLibraryName - the shared library name
Parameters:
  targetNames - xml string containing the list of componentInfos
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.listSharedLibraryDependents(java.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[])



showServiceAssembly
public String showServiceAssembly(String name, String state, String componentName, String targetName) throws JBIRemoteException(Code)
return service assembly info xml text for the specified service assembly if exists. If no service assembly with that name exists, it returns the xml with empty list.
Parameters:
  name - name of the service assembly to lookup
Parameters:
  state - return the service assembly that is in the specified state.JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null forANY state
Parameters:
  componentName - return the service assembly that has service units on thiscomponent.
Parameters:
  targetName - xml string contain service assembly info that confirms to theservice assembly list xml grammer.
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.showServiceAssembly(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String)



showServiceAssembly
public Map<String, String> showServiceAssembly(String name, String state, String componentName, String[] targetNames) throws JBIRemoteException(Code)
return service assembly info xml text for the specified service assembly if exists. If no service assembly with that name exists, it returns the xml with empty list.
Parameters:
  name - name of the service assembly to lookup
Parameters:
  state - return the service assembly that is in the specified state.JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null forANY state
Parameters:
  componentName - return the service assembly that has service units on thiscomponent.
Parameters:
  targetNames - xml string contain service assembly info that confirms to theservice assembly list xml grammer.
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.showServiceAssembly(java.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[])



showSharedLibrary
public String showSharedLibrary(String name, String componentName, String targetName) throws JBIRemoteException(Code)
return component info xml text for the specified shared library if exists. If no shared library with that name exists, it returns the xml with empty list.
Parameters:
  name - name of the shared library to lookup
Parameters:
  componentName - return the shared library that is this component dependents.null to ignore this option.
Parameters:
  targetName - xml string contain shared library component info that confirms tothe component info list xml grammer.
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.showSharedLibrary(java.lang.Stringjava.lang.Stringjava.lang.String)



showSharedLibrary
public Map<String, String> showSharedLibrary(String name, String componentName, String[] targetNames) throws JBIRemoteException(Code)
return component info xml text for the specified shared library if exists. If no shared library with that name exists, it returns the xml with empty list.
Parameters:
  name - name of the shared library to lookup
Parameters:
  componentName - return the shared library that is this component dependents.null to ignore this option.
Parameters:
  targetNames - xml string contain shared library component info that confirms tothe component info list xml grammer.
throws:
  JBIRemoteException - if error or exception occurs.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.showSharedLibrary(java.lang.Stringjava.lang.Stringjava.lang.String[])



shutdownComponent
public String shutdownComponent(String componentName, String targetName) throws JBIRemoteException(Code)
shuts down component ( service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  targetName -
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.shutdownComponent(java.lang.Stringjava.lang.String)



shutdownComponent
public String shutdownComponent(String componentName, boolean force, String targetName) throws JBIRemoteException(Code)
shuts down component ( service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  force - true if component should be shutdown in any case, else false.
Parameters:
  targetName -
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.shutdownComponent(java.lang.Stringbooleanjava.lang.String)



shutdownComponent
public Map<String, String> shutdownComponent(String componentName, String[] targetNames) throws JBIRemoteException(Code)
shuts down component ( service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.shutdownComponent(java.lang.Stringjava.lang.String[])



shutdownComponent
public Map<String, String> shutdownComponent(String componentName, boolean force, String[] targetNames) throws JBIRemoteException(Code)
shuts down component ( service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  force - true if component should be shutdown in any case, else false.
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.shutdownComponent(java.lang.Stringbooleanjava.lang.String[])



shutdownServiceAssembly
public String shutdownServiceAssembly(String serviceAssemblyName, String targetName) throws JBIRemoteException(Code)
shuts down service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetName -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.shutdownServiceAssembly(java.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



shutdownServiceAssembly
public Map<String, String> shutdownServiceAssembly(String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code)
shuts down service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.shutdownServiceAssembly(java.lang.Stringjava.lang.String[])



startComponent
public String startComponent(String componentName, String targetName) throws JBIRemoteException(Code)
starts component ( service engine, binding component)
Parameters:
  componentName - name of the component
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.startComponent(java.lang.Stringjava.lang.String)



startComponent
public Map<String, String> startComponent(String componentName, String[] targetNames) throws JBIRemoteException(Code)

See Also:   com.sun.jbi.ui.common.JBIAdminCommands.startComponent(java.lang.Stringjava.lang.String[])



startServiceAssembly
public String startServiceAssembly(String serviceAssemblyName, String targetName) throws JBIRemoteException(Code)
starts service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetName -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.startServiceAssembly(java.lang.Stringjava.lang.String)



startServiceAssembly
public Map<String, String> startServiceAssembly(String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code)
starts service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.startServiceAssembly(java.lang.Stringjava.lang.String[])



stopComponent
public String stopComponent(String componentName, String targetName) throws JBIRemoteException(Code)
stops component (service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  targetName -
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.stopComponent(java.lang.Stringjava.lang.String)



stopComponent
public Map<String, String> stopComponent(String componentName, String[] targetNames) throws JBIRemoteException(Code)
stops component (service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error name of the component
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.stopComponent(java.lang.Stringjava.lang.String)
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.stopComponent(java.lang.Stringjava.lang.String[])



stopServiceAssembly
public String stopServiceAssembly(String serviceAssemblyName, String targetName) throws JBIRemoteException(Code)
stops service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetName -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.stopServiceAssembly(java.lang.Stringjava.lang.String)



stopServiceAssembly
public Map<String, String> stopServiceAssembly(String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code)
stops service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.stopServiceAssembly(java.lang.Stringjava.lang.String[])



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, String targetName) throws JBIRemoteException(Code)
undeploys service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetName -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.undeployServiceAssembly(java.lang.Stringjava.lang.String)



undeployServiceAssembly
public Map<String, String> undeployServiceAssembly(String serviceAssemblyName, String[] targetNames) throws JBIRemoteException(Code)
undeploys service assembly
Parameters:
  serviceAssemblyName - name of the service assembly
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error result as a management message xml text
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.undeployServiceAssembly(java.lang.Stringjava.lang.String[])



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, String targetName) throws JBIRemoteException(Code)
uninstalls component (service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  targetName - name of the component.
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.uninstallComponent(java.lang.Stringjava.lang.String)



uninstallComponent
public Map<String, String> uninstallComponent(String componentName, String[] targetNames) throws JBIRemoteException(Code)
uninstalls component (service engine, binding component)
Parameters:
  componentName - name of the component
Parameters:
  targetNames - name of the component.
throws:
  JBIRemoteException - on error
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.uninstallComponent(java.lang.Stringjava.lang.String[])



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, String targetName) throws JBIRemoteException(Code)
uninstalls shared library
Parameters:
  sharedLibraryName - name of the shared library
Parameters:
  targetName -
throws:
  JBIRemoteException - on error shared library name.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.uninstallSharedLibrary(java.lang.Stringjava.lang.String)



uninstallSharedLibrary
public Map<String, String> uninstallSharedLibrary(String sharedLibraryName, String[] targetNames) throws JBIRemoteException(Code)
uninstalls shared library
Parameters:
  sharedLibraryName - name of the shared library
Parameters:
  targetNames -
throws:
  JBIRemoteException - on error shared library name.
See Also:   com.sun.jbi.ui.common.JBIAdminCommands.uninstallSharedLibrary(java.lang.Stringjava.lang.String[])



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



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.