com.ibm.soa.common.mbean
Interface ServiceComponent

All Superinterfaces:
java.io.Serializable

public interface ServiceComponent
extends java.io.Serializable

The ServiceComponent interface provides a way for a Web Service implementation to integrate a management MBean into the Console. After registering the component that implements this interface, the component will be called to initialize the MBean.
The interfaces provided in the com.ibm.soa.common.mbean package are intended for guidence purposes only, and are provided as-is.

Version:
1.3

Method Summary
 java.lang.String getBeanName(java.lang.String componentName)
          Get the MBean name string for the service implementation.
 java.lang.String getObjectName(java.lang.String componentName)
          Get the MBean ObjectName string from the service implementation.
 java.lang.String getString(java.lang.String componentName, java.lang.String key, java.util.Locale locale)
          Get a resource string.
 void initialize(java.lang.String componentName, java.lang.String displayName)
          initialize the MBean.
 void registerMBean(java.lang.String componentName)
          Register the MBean.
 void unregisterMBean(java.lang.String componentName)
          unregister the MBean.
 

Method Detail

getObjectName

java.lang.String getObjectName(java.lang.String componentName)
                               throws java.rmi.RemoteException
Get the MBean ObjectName string from the service implementation.

Parameters:
componentName - the componentName
Returns:
the ObjectName string of the MBean.
Throws:
java.rmi.RemoteException - on a communication error

getBeanName

java.lang.String getBeanName(java.lang.String componentName)
                             throws java.rmi.RemoteException
Get the MBean name string for the service implementation.

Parameters:
componentName - the componentName
Returns:
the display name of the bean
Throws:
java.rmi.RemoteException - on a communication error

registerMBean

void registerMBean(java.lang.String componentName)
                   throws java.rmi.RemoteException
Register the MBean.

Parameters:
componentName - the componentName
Throws:
java.rmi.RemoteException - on a communication error

unregisterMBean

void unregisterMBean(java.lang.String componentName)
                     throws java.rmi.RemoteException
unregister the MBean.

Parameters:
componentName - the componentName
Throws:
java.rmi.RemoteException - on a communication error

initialize

void initialize(java.lang.String componentName,
                java.lang.String displayName)
                throws java.rmi.RemoteException
initialize the MBean.

Parameters:
componentName - the componentName
displayName - the display name
Throws:
java.rmi.RemoteException - on a communication error

getString

java.lang.String getString(java.lang.String componentName,
                           java.lang.String key,
                           java.util.Locale locale)
                           throws java.rmi.RemoteException
Get a resource string.

Parameters:
componentName - the componentName
key - the key
locale - the locale
Returns:
the value of the key, or null
Throws:
java.rmi.RemoteException - on a communication error


Copyright © 2006 IBM Corp. All Rights Reserved.