| Method Summary |
|
| public void | cancelComponentUpdate(String componentName)
Cancel a pending component update. |
| public void | cancelComponentUpgrade(String componentName)
Cancel a pending component upgrade. |
| public String | getAppServerInstallRoot()
Gets the AppServer installation root directory. |
| public String | getAppServerInstanceRoot()
Gets the AppServer instance root directory. |
| public String | getComponentId()
Get the component ID of the current component. |
| public List | getComponentIds(ComponentType type)
Get a list of component IDs for all registered components of a specified
type.
Parameters:
type - - the Component type: ComponentInfo.SHARED_NAME_SPACE,ComponentInfo.BINDING, ComponentInfo.ENGINE, ComponentInfo.ALL, orComponentInfo.BINDINGS_AND_ENGINES. |
| public List | getComponentIds(ComponentType type, ComponentState status)
Get a list of component IDs for all components of a specified type with
a specified status.
Parameters:
type - - the Component type: ComponentInfo.SHARED_NAME_SPACE,ComponentInfo.BINDING, ComponentInfo.ENGINE, ComponentInfo.ALL, orComponentInfo.BINDINGS_AND_ENGINES. |
| public ComponentInfo | getComponentInfo(String componentId)
Get the ComponentInfo for a particular component.
Parameters:
componentId - - the unique ID of the component being retrieved. |
| public javax.jbi.component.Component | getComponentInstance(String name)
Get the javax.jbi.component.Component instance.
Parameters:
name - - the unique name of the component being retrieved. |
| public ComponentManager | getComponentManager()
A scaffolded component manager. |
| public String | getComponentName()
Get the component name of the current component. |
| public ComponentQuery | getComponentQuery()
|
| public ComponentQuery | getComponentQuery(String targetName)
|
| public String | getComponentRoot()
Get the installation root directory of the specified Binding Component
(BC) or Business Process Engine (BPE). |
| public com.sun.jbi.messaging.ConnectionManager | getConnectionManager()
Get the Connection Manager handle. |
| public List | getDependentComponentIds(String snsId)
Get a list of component IDs that depend upon a specified Shared Library.
Parameters:
snsId - - the unique ID of the Shared Library. |
| public com.sun.jbi.framework.DeployerMBean | getDeployerInstance(String name)
Get the com.sun.jbi.framework.DeployerMBean instance.
Parameters:
name - - the unique name of the component. |
| public java.util.Properties | getInitialProperties()
Gets the initial properties specified in the domain.xml file. |
| public String | getJbiInstallRoot()
|
| public String | getJbiInstanceRoot()
|
| public Logger | getLogger()
Gets the logger for the framework. |
| public MBeanHelper | getMBeanHelper()
Get the MBeanHelper service handle. |
| public MBeanNames | getMBeanNames()
Get the MBeanNames service handle. |
| public javax.management.MBeanServer | getMBeanServer()
Get the MBean server used to register all MBeans in the JBI
framework. |
| public Object | getManagementClass(String aServiceName)
Get a handle to the class implementing management for the named
JBI system service. |
| public com.sun.jbi.management.ManagementMessageFactory | getManagementMessageFactory()
Get the management message factory which enables JBI components
to construct status and exception messages. |
| public javax.naming.InitialContext | getNamingContext()
Get the JNDI naming context. |
| public com.sun.jbi.framework.EventNotifierCommon | getNotifier()
Get the Event Notifier instance. |
| public com.sun.jbi.platform.PlatformContext | getPlatformContext()
Get the platform-specific context for this implementation. |
| public JBIProvider | getProvider()
|
| public org.w3c.dom.Document | getReadOnlyRegistry()
Get a read-only reference to the persisted JBI Registry. |
| public com.sun.jbi.registry.Registry | getRegistry()
Get a reference to the persisted JBI registry. |
| public ServiceUnitRegistration | getServiceUnitRegistration()
Get the ServiceUnitRegistration handle. |
| public ComponentInfo | getSharedLibraryInfo(String sharedLibraryName)
Get the ComponentInfo for a particular shared library.
Parameters:
sharedLibraryName - - the unique name of the shared library beingretrieved. |
| public ComponentState | getStatus(String componentId)
Get the current status of a component.
Parameters:
componentId - - the unique component ID. |
| public String | getString(String key)
Get a localized string using the specified resource key.
Parameters:
key - - the key to the localized string in the resource bundle. |
| public String | getString(String key, Object insert1)
Get a localized string using the specified resource key. |
| public String | getString(String key, Object insert1, Object insert2)
Get a localized string using the specified resource key. |
| public String | getString(String key, Object insert1, Object insert2, Object insert3)
Get a localized string using the specified resource key. |
| public String | getString(String key, Object insert1, Object insert2, Object insert3, Object insert4)
Get a localized string using the specified resource key. |
| public String | getString(String key, Object[] inserts)
Get a localized string using the specified resource key. |
| public StringTranslator | getStringTranslator(String packageName)
Get a StringTranslator for a specific package name.
Parameters:
packageName - - the name of the package for which a StringTranslatoris being requested. |
| public StringTranslator | getStringTranslatorFor(Object object)
Get a StringTranslator for a specific object.
Parameters:
object - - the object for which a StringTranslator is beingrequested, using the name of the package containing the object. |
| public javax.transaction.TransactionManager | getTransactionManager()
Get the TransactionManager. |
| public com.sun.jbi.VersionInfo | getVersionInfo()
Get the VersionInfo for this runtime. |
| public WsdlFactory | getWsdlFactory()
|
| public void | initService(EnvironmentContext aContext)
Initialize a service. |
| public void | installSharedLibrary(String id, String name, String description, String componentRoot, List elements)
Install a Shared Library into the JBI framework.
Parameters:
id - - the unique component ID assigned to the Shared Library.
Parameters:
name - - the unique name of the Shared Library.
Parameters:
description - - the description of the Shared Library.
Parameters:
componentRoot - - the root directory for the Shared Library.
Parameters:
elements - - the list of jar and class files included in thisshared namespace, as a List of String objects in the order in which theyshould appear in the class path. |
| public void | installSharedLibrary(String name, String description, String componentRoot, boolean isSelfFirst, List elements)
Install a Shared Library into the JBI framework.
Parameters:
name - - the unique component ID assigned to the Shared Library.
Parameters:
description - - the description of the Shared Library.
Parameters:
componentRoot - - the root directory for the Shared Library.
Parameters:
isSelfFirst - - set to true to force the class loader to use aself-first hierarchy, false for parent-first.
Parameters:
elements - - the list of jar and class files included in thisshared namespace, as a List of String objects in the order in which theyshould appear in the class path. |
| public boolean | isFrameworkReady(boolean start)
Indicates whether or not the JBI framework has been fully started. |
| public boolean | isStartOnDeployEnabled()
|
| public boolean | isStartOnVerifyEnabled()
This method is used to find out if start-onverify is enabled.
When this is enabled components are started automatically when
an application has to be verified for them
This is controlled by the property com.sun.jbi.startOnVerify.
By default start-on-verify is enabled. |
| public javax.management.ObjectName | loadBootstrap(InstallationContext installContext, String bootClassName, List bootClassPathElements, List snsIdList)
Load a Component bootstrap into the JBI framework. |
| public void | setAppServerInstallRoot(String asInstallRoot)
Sets the AppServer install root directory. |
| public void | setAppServerInstanceRoot(String asInstanceRoot)
Sets the AppServer instance root directory. |
| public void | setJbiInstallRoot(String jbiRoot)
|
| public void | setJbiInstanceRoot(String jbiRoot)
|
| public void | setMBeanServer(javax.management.MBeanServer mBeanServer)
Sets the main MBean server for use by all components. |
| public void | setProperty(String key, String value)
|
| public void | setRegistry(Registry registry)
Set a reference to JBI registry. |
| public String | stackTraceToString(Throwable ex)
Return a String containing the result of a printStackTrace() on an
exception.
Parameters:
ex - the exception for which a stack trace is requested. |
| public void | startService()
Start a service. |
| public void | stopService()
Stop a service. |
| public void | uninstallSharedLibrary(String name)
Uninstall a Shared Library from the JBI framework. |
| public void | unloadBootstrap(String componentName)
Unload a Component bootstrap from the JBI framework. |
| public void | updateComponent(com.sun.jbi.component.InstallationContext installContext, List bootClassPathElements)
Update an installed component. |
| public void | upgradeComponent(com.sun.jbi.component.InstallationContext installContext, String bootClassName, List<String> bootClassPathElements, List<String> sharedLibraryList)
Upgrade an installed component. |
| public void | validateComponentForUpdate(com.sun.jbi.component.InstallationContext installContext, List bootClassPathElements)
Validate a component for update. |
| public boolean | validateComponentForUpgrade(com.sun.jbi.component.InstallationContext installContext, String bootClassName, List<String> bootClassPathElements, List<String> sharedLibraryList)
Validate a component for upgrade. |
