org.apache.avalon.phoenix.interfaces
Interface SystemManager

All Known Implementing Classes:
AbstractSystemManager

public interface SystemManager

This component is responsible for managing the system. This includes managing the embeddor, deployer and kernel.

Author:
Leo Simons, Peter Donald

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 SystemManager getSubContext(java.lang.String name, java.lang.String type)
          Returns the subcontext of the specified name.
 void register(java.lang.String name, java.lang.Object object)
          Register an object for management.
 void register(java.lang.String name, java.lang.Object object, java.lang.Class[] interfaces)
          Register an object for management.
 void unregister(java.lang.String name)
          Unregister named object.
 

Field Detail

ROLE

public static final java.lang.String ROLE
Method Detail

register

public void register(java.lang.String name,
                     java.lang.Object object,
                     java.lang.Class[] interfaces)
              throws ManagerException,
                     java.lang.IllegalArgumentException
Register an object for management. The object is exported through some management scheme (typically JMX) and the management is restricted to the interfaces passed in as a parameter to method.

Parameters:
name - the name to register object under
object - the object
interfaces - the interfaces to register the component under
Throws:
ManagerException - if an error occurs. An error could occur if the object doesn't implement the interfaces, the interfaces parameter contain non-instance classes, the name is already registered etc.
java.lang.IllegalArgumentException - if object or interfaces is null

register

public void register(java.lang.String name,
                     java.lang.Object object)
              throws ManagerException,
                     java.lang.IllegalArgumentException
Register an object for management. The object is exported through some management scheme (typically JMX). Note that the particular management scheme will most likely use reflection to extract manageable information.

Parameters:
name - the name to register object under
object - the object
Throws:
ManagerException - if an error occurs such as name already registered.
java.lang.IllegalArgumentException - if object is null

unregister

public void unregister(java.lang.String name)
                throws ManagerException
Unregister named object.

Parameters:
name - the name of object to unregister
Throws:
ManagerException - if an error occurs such as when no such object registered.

getSubContext

public SystemManager getSubContext(java.lang.String name,
                                   java.lang.String type)
                            throws ManagerException
Returns the subcontext of the specified name. If it does not exist it is created.

Parameters:
name - name of the object in the parent context that will own this one
type - of objects that will be managed in this context
Returns:
the subcontext with the specified name
Throws:
ManagerException - if context cannot be created or retrieved


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.