net.openwings.component.utilities
Interface ComponentMBean

All Superinterfaces:

MBean

public interface ComponentMBean

extends MBean

This interface describes a management bean that can be used to access information about a component:

• Services used, provided, published, subscribed
• UIs associated with a service.
• Connectors associated with a service (future)
• Discovery mechanisms associated with a service (future).

The management bean can also be used to shut down the component

Every implementation of Component Services should register a ComponentMBean with the Management Services infrastructure.

Method Summary

ServiceDescriptor[]	getProvidedServices() This method is used to get all of the services being provided by this component.
ServiceDescriptor[]	getPublishedServices() This method is used to get all of the services being published by this component.
ServiceDescriptor[]	getSubscribedServices() This method is used to get all of the services being subscribed by this component.
ServiceDescriptor[]	getUsedServices() This method is used to get all of the services being used by this component.
UserInterfaceDescriptor[]	getUserInterfaceDescriptors(ServiceDescriptor descriptor) This method is used to get the UserInterfaces that were published with the service.
void	shutdown() This method shuts down the component, disconnecting all services used and provided by the component.

Methods inherited from interface net.openwings.management.MBean

getMBeanInfo

Method Detail

getUsedServices

public ServiceDescriptor[] getUsedServices()
                                    throws java.rmi.RemoteException

This method is used to get all of the services being used by this component.

Returns:

ServiceDescriptor[] services used by this component

Throws:

java.rmi.RemoteException - for communication errors

getProvidedServices

public ServiceDescriptor[] getProvidedServices()
                                        throws java.rmi.RemoteException

This method is used to get all of the services being provided by this component.

Returns:

ServiceDescriptor[] services provided by this component

Throws:

java.rmi.RemoteException - for communication errors

getSubscribedServices

public ServiceDescriptor[] getSubscribedServices()
                                          throws java.rmi.RemoteException

This method is used to get all of the services being subscribed by this component.

Returns:

ServiceDescriptor[] services subscribed by this component

Throws:

java.rmi.RemoteException - for communication errors

getPublishedServices

public ServiceDescriptor[] getPublishedServices()
                                         throws java.rmi.RemoteException

This method is used to get all of the services being published by this component.

Returns:

ServiceDescriptor[] services published by this component

Throws:

java.rmi.RemoteException - for communication errors

getUserInterfaceDescriptors

public UserInterfaceDescriptor[] getUserInterfaceDescriptors(ServiceDescriptor descriptor)
                                                      throws java.rmi.RemoteException

This method is used to get the UserInterfaces that were published with the service. This command only works with published or provided services. it will return null otherwise.

Parameters:

descriptor - of a provided or published service

Returns:

UserInterfaceDescriptor[] uis available for the particular service

Throws:

java.rmi.RemoteException - for communication errors

shutdown

public void shutdown()
              throws java.lang.SecurityException,
                     java.rmi.RemoteException

This method shuts down the component, disconnecting all services used and provided by the component. Behavior of subsequent method calls on the component made via the Component and ComponentManagement interfaces is undefined.

Throws:

java.rmi.RemoteException - for communication errors

java.lang.SecurityException - if this action is not supported