com.sun.jbi.management.registry.xml

Class ComponentQueryImpl

java.lang.Object

com.sun.jbi.management.registry.xml.ComponentQueryImpl

All Implemented Interfaces:

ComponentQuery

public class ComponentQueryImpl
extends Object
implements ComponentQuery

This class encapsulates queries which are common to all targets ( domain / server / cluster ).

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
ComponentQueryImpl(Jbi jbi, ManagementContext mgtCtx, boolean validate, String targetName, RegistryImpl registry)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getComponentIds(ComponentType type) Get a list of component IDs for all registered components of a specified type.
List<String>	getComponentIds(ComponentType type, ComponentState status) Get a list of component IDs for all components of a specified type with a specified status.
ComponentInfo	getComponentInfo(String componentName) Get the ComponentInfo for a particular Component.
List	getDependentComponentIds(String sharedLibraryName) Get a list of component IDs that depend upon a specified Shared Library.
ComponentInfo	getSharedLibraryInfo(String sharedLibraryName) Get the ComponentInfo for a particular Shared Library.
ComponentState	getStatus(String componentName) Get the current status of a component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentQueryImpl

public ComponentQueryImpl(Jbi jbi,
                  ManagementContext mgtCtx,
                  boolean validate,
                  String targetName,
                  RegistryImpl registry)
                   throws RegistryException

Throws:

RegistryException

Method Detail

getComponentIds

public List<String> getComponentIds(ComponentType type)

Get a list of component IDs for all registered components of a specified type.

Specified by:

getComponentIds in interface ComponentQuery

Parameters:

type - The ComponentType: { BINDING, ENGINE, SHARED_LIBRARY, BINDINGS_AND_ENGINES, ALL }. ALL includes allcomponents regardless of their types. ComponentInfo.BINDINGS_AND_ENGINES includes both bindings and engines.

Returns:

A List of component IDs ( String ) of all registered components of the requested type. Returns an empty list of no components were found.

getComponentIds

public List<String> getComponentIds(ComponentType type,
                           ComponentState status)

Get a list of component IDs for all components of a specified type with a specified status.

Specified by:

getComponentIds in interface ComponentQuery

Parameters:

type - The ComponentType: { BINDING, ENGINE, SHARED_LIBRARY, BINDINGS_AND_ENGINES, ALL }. ALL includes allcomponents regardless of their types. ComponentInfo.BINDINGS_AND_ENGINES includes both bindings and engines.

status - The Component status: ComponentState{LOADED, SHUTDOWN, STARTED, STOPPED}

Returns:

A List of component IDs ( String ) of all registered components of the requested type with the requested status. Returns an empty list if no components were found.

getComponentInfo

public ComponentInfo getComponentInfo(String componentName)

Get the ComponentInfo for a particular Component.

Specified by:

getComponentInfo in interface ComponentQuery

Parameters:

componentName - The unique name of the component being retrieved.

Returns:

The ComponentInfo for the requested component or null if the component is not registered.

getSharedLibraryInfo

public ComponentInfo getSharedLibraryInfo(String sharedLibraryName)

Get the ComponentInfo for a particular Shared Library.

Specified by:

getSharedLibraryInfo in interface ComponentQuery

Parameters:

sharedLibraryName - The unique name of the Shared Library being retrieved.

Returns:

The ComponentInfo for the requested Shared Library or null if the Shared Library is not registered.

getDependentComponentIds

public List getDependentComponentIds(String sharedLibraryName)

Get a list of component IDs that depend upon a specified Shared Library.

Specified by:

getDependentComponentIds in interface ComponentQuery

Parameters:

sharedLibraryName - The unique name of the Shared Library.

Returns:

A list of the component IDs of all components that depend upon the Shared Library. If none are found, the list is empty.

getStatus

public ComponentState getStatus(String componentName)
                         throws JBIException

Get the current status of a component.

Specified by:

getStatus in interface ComponentQuery

Parameters:

componentName - The unique component name.

Returns:

The current status of the component: {SHUTDOWN, LOADED, STARTED, STOPPED}

Throws:

JBIException - if the component name is not registered.