com.sun.jbi.management.binding

Class ModelBindingComponent

java.lang.Object

com.sun.jbi.management.binding.ModelBindingComponent

All Implemented Interfaces:

ControllerMBean, Component, ComponentLifeCycle, ServiceUnitManager, NotificationBroadcaster, NotificationEmitter

public abstract class ModelBindingComponent
extends Object
implements Component, ControllerMBean, ComponentLifeCycle, ServiceUnitManager, NotificationEmitter

The ModelBindingComponent implements the management controls for a standard JBI Framework binding component, and can be extended to provide a full binding implementation.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectName	mControllerMBeanName
protected ObjectName	mDeployerMBeanName JMX object names for component-only mbeans:
protected String	mDisplayName User-friendly display name to be used by ModelBindingComponent methods:
protected ComponentContext	mEnv
protected MBeanSet	mInitialMBeans
protected JbiNameInfo	mJbiNameInfo handle to jbi schemaorg_apache_xmlbeans.system or installed component identification:
protected ObjectName	mLifeCycleMBeanName JMX object names for standard mbeans:
protected Logger	mLogger Logger to be used by ModelBindingComponent methods:
protected ObjectName	mLoggerMBeanName
protected MBeanNames	mMBeanNames handle to our MBean Namer:
protected MBeanServer	mMBeanServer handle to our MBean Server:
protected String	mModelName
protected MBeanSet	mStartMBeans
protected StringTranslator	mTranslator Handle to StringTranslator for message translation:

Constructor Summary

Constructors

Constructor and Description
ModelBindingComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Adds a listener to this MBean.
protected void	bootstrap() perform one-time startup tasks for this model
String	deploy(String serviceUnitName, String serviceUnitRootPath) Deploy a Service Unit to the component.
String	getComponentInfo() Return current version and other info about this component.
String	getcomponentName() Return the componentName
ObjectName	getDefaultLoggerMBean() Return the ObjectName of the default LoggerMBean for this component.
ObjectName	getDeployerMBean() Return the JMX ObjectName for this component's DeployerMBean or null.
ObjectName	getExtensionMBeanName() Get the JMX object name for the extension MBean for this component; if there is none, return null.
String	getHelp() Return help text about this component.
ComponentLifeCycle	getLifeCycle() Get the life cycle control interface for this component.
ObjectName	getLifeCycleMBean() Return the JMX ObjectName for this component's LifeCycleMBean or null.
ObjectName	getLoggerMBeanByName(String aLoggerName) Return the ObjectName for LoggerMBean named aLoggerName, or null, if the named logger does not exist in this component.
ObjectName[]	getLoggerMBeans() Return the ObjectNames for all of the LoggerMBean's for this component.
NotificationBroadcasterSupport	getNotificationBroadcaster() Getter for local NotificationBroadcaster.
MBeanNotificationInfo[]	getNotificationInfo() Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
Document	getServiceDescription(ServiceEndpoint endpoint) Retrieves a DOM representation containing metadata which describes the service provided by this component, through the given endpoint.
ServiceUnitManager	getServiceUnitManager() Get the Service Unit manager for this component.
void	init(ComponentContext context) Initialize the component.
void	init(String serviceUnitName, String serviceUnitRootPath) Initialize the given deployed service unit.
protected void	initModelBindingComponent(ComponentContext anEnv, JbiNameInfo aJbiName) allocate a logger, and then initialize the ModelBindingComponent.
protected void	initModelBindingComponent(ComponentContext anEnv, Logger aLogger, JbiNameInfo aJbiName) Initialize the ModelBindingComponent.
boolean	isExchangeWithConsumerOkay(ServiceEndpoint endpoint, MessageExchange exchange) This method is called by JBI to check if this component, in the role of provider of the service indicated by the given exchange, can actually perform the operation desired.
boolean	isExchangeWithProviderOkay(ServiceEndpoint endpoint, MessageExchange exchange) This method is called by JBI to check if this component, in the role of consumer of the service indicated by the given exchange, can actually interact with the provider properly.
String	messageDeployOkay()
String	messageUnDeployOkay()
void	removeNotificationListener(NotificationListener listener) Removes a listener from this MBean.
void	removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) Removes a listener from this MBean.
ServiceEndpoint	resolveEndpointReference(DocumentFragment epr) Resolve the given endpoint reference.
void	shutDown() Shut down the component.
void	shutDown(String serviceUnitName) Shut down the deployment.
void	start() Start the component.
void	start(String serviceUnitName) Start the deployed service unit.
void	stop() Stop the component.
void	stop(String serviceUnitName) Stop the deployed service unit.
String	undeploy(String serviceUnitName, String serviceUnitRootPath) Undeploy a service unit from the component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mEnv

protected ComponentContext mEnv

mInitialMBeans

protected MBeanSet mInitialMBeans

mStartMBeans

protected MBeanSet mStartMBeans

mLogger

protected Logger mLogger

Logger to be used by ModelBindingComponent methods:

mMBeanServer

protected MBeanServer mMBeanServer

handle to our MBean Server:

mMBeanNames

protected MBeanNames mMBeanNames

handle to our MBean Namer:

mJbiNameInfo

protected JbiNameInfo mJbiNameInfo

handle to jbi schemaorg_apache_xmlbeans.system or installed component identification:

mDisplayName

protected String mDisplayName

User-friendly display name to be used by ModelBindingComponent methods:

mLifeCycleMBeanName

protected ObjectName mLifeCycleMBeanName

JMX object names for standard mbeans:

mLoggerMBeanName

protected ObjectName mLoggerMBeanName

mModelName

protected final String mModelName

See Also:

Constant Field Values

mTranslator

protected StringTranslator mTranslator

Handle to StringTranslator for message translation:

mDeployerMBeanName

protected ObjectName mDeployerMBeanName

JMX object names for component-only mbeans:

mControllerMBeanName

protected ObjectName mControllerMBeanName

Constructor Detail

ModelBindingComponent

public ModelBindingComponent()

Method Detail

initModelBindingComponent

protected void initModelBindingComponent(ComponentContext anEnv,
                             JbiNameInfo aJbiName)

allocate a logger, and then initialize the ModelBindingComponent.

initModelBindingComponent

protected void initModelBindingComponent(ComponentContext anEnv,
                             Logger aLogger,
                             JbiNameInfo aJbiName)

Initialize the ModelBindingComponent. This does not register any mbeans.

bootstrap

protected void bootstrap()

perform one-time startup tasks for this model

getLifeCycle

public ComponentLifeCycle getLifeCycle()

Get the life cycle control interface for this component. This interface allows the JBI implementation to control the running state of this component.

This method must be called before any other methods of this interface are called. In addition, the JBI implementation must call the init() method of the component life cycle returned by this method before calling any other methods on this interface, or the component life cycle interface.

Specified by:

getLifeCycle in interface Component

Returns:

the life cycle control interface for this component; must be non-null.

getServiceUnitManager

public ServiceUnitManager getServiceUnitManager()

Get the Service Unit manager for this component. If this component does not support deployments, it must return null.

Specified by:

getServiceUnitManager in interface Component

Returns:

the ServiceUnitManager for this component, or null if there is none.

getServiceDescription

public Document getServiceDescription(ServiceEndpoint endpoint)

Retrieves a DOM representation containing metadata which describes the service provided by this component, through the given endpoint. The result can use WSDL 1.1 or WSDL 2.0.

Specified by:

getServiceDescription in interface Component

Parameters:

endpoint - the service endpoint.

Returns:

the description for the specified service endpoint.

isExchangeWithConsumerOkay

public boolean isExchangeWithConsumerOkay(ServiceEndpoint endpoint,
                                 MessageExchange exchange)

This method is called by JBI to check if this component, in the role of provider of the service indicated by the given exchange, can actually perform the operation desired.

Specified by:

isExchangeWithConsumerOkay in interface Component

Parameters:

endpoint - the endpoint to be used by the consumer; must be non-null.

exchange - the proposed message exchange to be performed; must be non-null.

Returns:

true if this provider component can perform the given exchange with the described consumer.

isExchangeWithProviderOkay

public boolean isExchangeWithProviderOkay(ServiceEndpoint endpoint,
                                 MessageExchange exchange)

This method is called by JBI to check if this component, in the role of consumer of the service indicated by the given exchange, can actually interact with the provider properly. The provider is described by the given endpoint and the service description supplied by that endpoint.

Specified by:

isExchangeWithProviderOkay in interface Component

Parameters:

endpoint - the endpoint to be used by the provider; must be non-null.

exchange - the proposed message exchange to be performed; must be non-null.

Returns:

true if this consumer component can interact with the described provider to perform the given exchange.

resolveEndpointReference

public ServiceEndpoint resolveEndpointReference(DocumentFragment epr)

Resolve the given endpoint reference. This is called by JBI when it is attempting to resolve the given EPR on behalf of a component.

If this component returns a non-null result, it must conform to the following:

• This component implements the ServiceEndpoint returned.
• The result must not be registered or activated with the JBI implementation.

Dynamically resolved endpoints are distinct from static ones; they must not be activated (see ComponentContext.activateEndpoint(QName, String)), nor registered (see ComponentContext) by components. They can only be used to address message exchanges; the JBI implementation must deliver such exchanges to the component that resolved the endpoint reference (see ComponentContext.resolveEndpointReference(DocumentFragment)).

Specified by:

resolveEndpointReference in interface Component

Parameters:

epr - the endpoint reference, in some XML dialect understood by the appropriate component (usually a binding); must be non-null.

Returns:

the service endpoint for the EPR; null if the EPR cannot be resolved by this component.

getExtensionMBeanName

public ObjectName getExtensionMBeanName()

Get the JMX object name for the extension MBean for this component; if there is none, return null.

Specified by:

getExtensionMBeanName in interface ComponentLifeCycle

Returns:

the JMX object name of the additional MBean or null if there is no additional MBean.

init

public void init(ComponentContext context)
          throws JBIException

Initialize the component. This performs initialization required by the component but does not make it ready to process messages. This method is called once for each life cycle of the component.

If the component needs to register an additional MBean to extend its life cycle, or provide other component management tasks, it should be registered during this call.

Specified by:

init in interface ComponentLifeCycle

Parameters:

context - the component's context, providing access to component data provided by the JBI environment; must be non-null.

Throws:

JBIException - if the component is unable to initialize.

shutDown

public void shutDown()
              throws JBIException

Shut down the component. This performs clean-up, releasing all run-time resources used by the component. Once this method has been called, init(ComponentContext) must be called before the component can be started again with a call to start().

Specified by:

shutDown in interface ComponentLifeCycle

Throws:

JBIException - if the component is unable to shut down.

start

public void start()
           throws JBIException

Start the component. This makes the component ready to process messages. This method is called after init(ComponentContext), both when the component is being started for the first time and when the component is being restarted after a previous call to shutDown(). If stop() was called previously but shutDown() was not, start() can be called again without another call to init(ComponentContext).

Specified by:

start in interface ComponentLifeCycle

Throws:

JBIException - if the component is unable to start.

stop

public void stop()
          throws JBIException

Stop the component. This makes the component stop accepting messages for processing. After a call to this method, start() may be called again without first calling init(ComponentContext).

Specified by:

stop in interface ComponentLifeCycle

Throws:

JBIException - if the component is unable to stop.

deploy

public String deploy(String serviceUnitName,
            String serviceUnitRootPath)
              throws DeploymentException

Deploy a Service Unit to the component. This is called by the JBI implementation in order to deploy the given artifact to the implementing component.

Upon successful deployment, a non-empty result string must be returned, that starts with the JBI-defined component-task-result element. For example:

 <component-task-result>
   <component-name>BC1</component-name>
   <component-task-result-details
     xmlns="http://java.sun.com/xml/ns/jbi/management-message">
       <task-result-details>
           <task-id>deploy</task-id>
           <task-result>SUCCESS</task-result>
       </task-result-details>
   </component-task-result-details>
 </component-task-result>
 

A failed deployment of the service unit must be reported using the component-task-result element as well; the task-result must be set to FAILED.

Specified by:

deploy in interface ServiceUnitManager

Parameters:

serviceUnitName - name of the service unit being deployed; must be non-null and non-empty and unique among service units already deployed to the component.

serviceUnitRootPath - path of the service unit artifact root, in platform specific format; must be non-null and non-empty.

Returns:

a deployment status message, which is an XML string that conforms to the schema given in the MBean Status and Result Strings section of the Management chapter of the JBI specification; must be non-null and non-empty.

Throws:

DeploymentException - if the deployment operation is unsuccessful.

init

public void init(String serviceUnitName,
        String serviceUnitRootPath)
          throws DeploymentException

Initialize the given deployed service unit. This is the first phase of a two-phase start, where the component must prepare to receive service requests related to the deployment (if any).

The serviceUnitRootPath parameter is provided to facilitate restart of the component. This allows simple components to rely entirely on JBI's ability to persist deployment information, avoiding the need for the component to provide its own persistence mechanism.

Specified by:

init in interface ServiceUnitManager

Parameters:

serviceUnitName - name of the service unit being initialized; must be non-null, non-empty, and match the name of a previously deployed (but not yet undeployed) service unit.

serviceUnitRootPath - path of the service unit artifact root, in platform specific format; must be non-null and non-empty.

Throws:

DeploymentException - if the service unit is not deployed, or if it is in an incorrect state.

start

public void start(String serviceUnitName)
           throws DeploymentException

Start the deployed service unit. This is the second phase of a two-phase start, where the component can now initiate service requests related to the deployment.

Specified by:

start in interface ServiceUnitManager

Parameters:

serviceUnitName - the name of the service unit being started; must be non-null, non-empty, and match the name of a previously deployed (but not yet undeployed) service unit.

Throws:

DeploymentException - if the service unit is not deployed, or if it is in an incorrect state.

stop

public void stop(String serviceUnitName)
          throws DeploymentException

Stop the deployed service unit. This causes the component to cease generating service requests related to the given service unit. This returns the service unit to a state equivalent to after init(String, String) was called.

Specified by:

stop in interface ServiceUnitManager

Parameters:

serviceUnitName - name of the service unit being stopped; must be non-null, non-empty, and match the name of a previously deployed (but not yet undeployed) service unit.

Throws:

DeploymentException - if the service unit is not deployed, or if it is in an incorrect state.

shutDown

public void shutDown(String serviceUnitName)
              throws DeploymentException

Shut down the deployment. This causes the deployment to return to the to the state it was in after deploy(String, String), and before init(String, String).

Specified by:

shutDown in interface ServiceUnitManager

Parameters:

serviceUnitName - name of the service unit being shut down; must be non-null, non-empty, and match the name of a previously deployed (but not yet undeployed) service unit.

Throws:

DeploymentException - if the service unit is not deployed, or if it is in an incorrect state.

undeploy

public String undeploy(String serviceUnitName,
              String serviceUnitRootPath)
                throws DeploymentException

Undeploy a service unit from the component. The service unit must be shut down to undeploy it.

Specified by:

undeploy in interface ServiceUnitManager

Parameters:

serviceUnitName - name of the service unit being undeployed; must be non-null, non-empty, and match the name of a previously deployed (but not yet undeployed) service unit.

serviceUnitRootPath - path of the service unit artifact root, in platform specific format; must be non-null and non-empty.

Returns:

deployment status message, which is an XML string that conforms to the component-task-result type from the schema given in the MBean Status and Result Strings section of the Management chapter of the JBI specification; must be non-null and non-empty.

Throws:

DeploymentException - if undeployment operation is unsuccessful, or if the service unit is in an incorrect state.

getComponentInfo

public String getComponentInfo()

Return current version and other info about this component.

Specified by:

getComponentInfo in interface ControllerMBean

Returns:

info String

getHelp

public String getHelp()

Return help text about this component.

Specified by:

getHelp in interface ControllerMBean

Returns:

help text about this component.

getDeployerMBean

public ObjectName getDeployerMBean()

Return the JMX ObjectName for this component's DeployerMBean or null.

Specified by:

getDeployerMBean in interface ControllerMBean

Returns:

the JMX ObjectName for this component's DeployerMBean or null.

getLifeCycleMBean

public ObjectName getLifeCycleMBean()

Return the JMX ObjectName for this component's LifeCycleMBean or null.

Specified by:

getLifeCycleMBean in interface ControllerMBean

Returns:

the JMX ObjectName for this component's LifeCycleMBean or null.

getLoggerMBeanByName

public ObjectName getLoggerMBeanByName(String aLoggerName)

Return the ObjectName for LoggerMBean named aLoggerName, or null, if the named logger does not exist in this component.

Specified by:

getLoggerMBeanByName in interface ControllerMBean

Returns:

ObjectName of LoggerMBean.

getDefaultLoggerMBean

public ObjectName getDefaultLoggerMBean()

Return the ObjectName of the default LoggerMBean for this component.

Specified by:

getDefaultLoggerMBean in interface ControllerMBean

Returns:

ObjectName of default LoggerMBean or null.

getLoggerMBeans

public ObjectName[] getLoggerMBeans()

Return the ObjectNames for all of the LoggerMBean's for this component.

Specified by:

getLoggerMBeans in interface ControllerMBean

Returns:

array of ObjectName, possibly of zero length.

getcomponentName

public String getcomponentName()

Return the componentName

Specified by:

getcomponentName in interface ControllerMBean

Returns:

the componentName

addNotificationListener

public void addNotificationListener(NotificationListener listener,
                           NotificationFilter filter,
                           Object handback)
                             throws IllegalArgumentException

Adds a listener to this MBean.

Specified by:

addNotificationListener in interface NotificationBroadcaster

Parameters:

listener - The listener object which will handle the notifications emitted by the broadcaster.

filter - The filter object. If filter is null, no filtering will be performed before handling notifications.

handback - An opaque object to be sent back to the listener when a notification is emitted. This object cannot be used by the Notification broadcaster object. It should be resent unchanged with the notification to the listener.

Throws:

IllegalArgumentException - Listener parameter is null.

See Also:

removeNotificationListener(javax.management.NotificationListener)

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException

Removes a listener from this MBean. If the listener has been registered with different handback objects or notification filters, all entries corresponding to the listener will be removed.

Specified by:

removeNotificationListener in interface NotificationBroadcaster

Parameters:

listener - A listener that was previously added to this MBean.

Throws:

ListenerNotFoundException - The listener is not registered with the MBean.

See Also:

addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.

It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.

Specified by:

getNotificationInfo in interface NotificationBroadcaster

Returns:

the array of possible notifications.

removeNotificationListener

public void removeNotificationListener(NotificationListener listener,
                              NotificationFilter filter,
                              Object handback)
                                throws ListenerNotFoundException

Removes a listener from this MBean. The MBean must have a listener that exactly matches the given listener, filter, and handback parameters. If there is more than one such listener, only one is removed.

The filter and handback parameters may be null if and only if they are null in a listener to be removed.

Specified by:

removeNotificationListener in interface NotificationEmitter

Parameters:

listener - A listener that was previously added to this MBean.

filter - The filter that was specified when the listener was added.

handback - The handback that was specified when the listener was added.

Throws:

ListenerNotFoundException - The listener is not registered with the MBean, or it is not registered with the given filter and handback.

getNotificationBroadcaster

public NotificationBroadcasterSupport getNotificationBroadcaster()

Getter for local NotificationBroadcaster.

Returns:

NotificationBroadcaster

messageDeployOkay

public String messageDeployOkay()

messageUnDeployOkay

public String messageUnDeployOkay()