net.openwings.management
Interface RemoteManager

All Known Subinterfaces:

Manager

public interface RemoteManager

This interface describes a service which can be used to control the management of a component. An implementation of Openwings Management Services should use Component Services to provide a service implementing this interface. This interface provides access to the MBeans installed in a component and the ability to register ManagerListeners for notification of the addition or removal of MBeans. This interface contains a subset of the methods in the Manager interface.

Method Summary

void	addManagerListener(ManagerListener listener) This method registers an ManagerListener which will be notified when MBeans are added or removed from this Manager.
java.net.URL[]	getAdapterURLList() This method is used to obtain a set of URLs which can be used to access adapted MBeans (i.e.
MBean[]	getAllMBeans() This method returns all MBeans registered with the Manager.
java.net.InetAddress	getInetAddress() This method returns the host on which the Manager is running.
MBean[]	getMBean(java.lang.Class componentType) This method will return all MBeans of the requested type that are registered with the Manager.
UserInterfaceFactory[]	getUserInterfaceFactories(MBean bean) This method is used to obtain user interface factories available that can build a user interface for a particular service interface.
UserInterfaceFactory[]	getUserInterfaceFactories(MBean bean, java.lang.Class[] desiredUserInterfaceClasses) This method is used to obtain user interface factories available that can build a user interface for a particular service interface.
void	removeManagerListener(ManagerListener listener) This method unregisters a previously registered ManagerListener.

Method Detail

getInetAddress

public java.net.InetAddress getInetAddress()
                                    throws java.rmi.RemoteException

This method returns the host on which the Manager is running.

Returns:

host

Throws:

java.rmi.RemoteException - For any communication-related exception.

getAdapterURLList

public java.net.URL[] getAdapterURLList()
                                 throws java.rmi.RemoteException

This method is used to obtain a set of URLs which can be used to access adapted MBeans (i.e. from a web browser).

Returns:

array of URLs

Throws:

java.rmi.RemoteException - For any communication-related exception.

getMBean

public MBean[] getMBean(java.lang.Class componentType)
                 throws java.rmi.RemoteException

This method will return all MBeans of the requested type that are registered with the Manager.

Returns:

an array of MBean instances.

Throws:

java.rmi.RemoteException - For any communication-related exception.

getAllMBeans

public MBean[] getAllMBeans()
                     throws java.rmi.RemoteException

This method returns all MBeans registered with the Manager.

Returns:

an array of MBean instances.

Throws:

java.rmi.RemoteException - For any communication-related exception.

addManagerListener

public void addManagerListener(ManagerListener listener)
                        throws java.rmi.RemoteException

This method registers an ManagerListener which will be notified when MBeans are added or removed from this Manager.

Parameters:

listener - The listener to be added.

Throws:

java.rmi.RemoteException - For any communication-related exception.

removeManagerListener

public void removeManagerListener(ManagerListener listener)
                           throws java.rmi.RemoteException

This method unregisters a previously registered ManagerListener.

Parameters:

listener - The listener to be removed.

Throws:

java.rmi.RemoteException - For any communication-related exception.

getUserInterfaceFactories

public UserInterfaceFactory[] getUserInterfaceFactories(MBean bean)
                                                 throws java.rmi.RemoteException

This method is used to obtain user interface factories available that can build a user interface for a particular service interface. After these UserInterfaceFactory objects are returned, they can be used to generate the actual user interface.

Parameters:

bean - the MBean for which a user interface is needed.

Returns:

array of factories, or null if no factories were installed with this RemoteManager.

Throws:

java.rmi.RemoteException - For any communication-related exception.

See Also:

UserInterfaceBuilder

getUserInterfaceFactories

public UserInterfaceFactory[] getUserInterfaceFactories(MBean bean,
                                                        java.lang.Class[] desiredUserInterfaceClasses)
                                                 throws java.rmi.RemoteException

This method is used to obtain user interface factories available that can build a user interface for a particular service interface. The factory must be able to produce a user interface that is an instance of one of the specified Java types. After these UserInterfaceFactory objects are returned, they can be used to generate the actual user interface.

Parameters:

bean - the MBean for which a user interface is needed.

desiredUserInterfaceClasses - array of Java types of user interfaces which are acceptable

Returns:

array of factories, or null if no factories were installed with this RemoteManager.

Throws:

java.rmi.RemoteException

See Also:

UserInterfaceBuilder