com.sun.jbi

Interface ComponentQuery

public interface ComponentQuery

This interface provides services for query of information about Binding Components, Service Engines, and Shared Libraries.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
List	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<String>	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.

Method Detail

getComponentIds

List getComponentIds(ComponentType type)

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

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

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

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

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, INSTALLED, 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

ComponentInfo getComponentInfo(String componentName)

Get the ComponentInfo for a particular Component.

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

ComponentInfo getSharedLibraryInfo(String sharedLibraryName)

Get the ComponentInfo for a particular Shared Library.

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

List<String> getDependentComponentIds(String sharedLibraryName)

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

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

ComponentState getStatus(String componentName)
                         throws JBIException

Get the current status of a component.

Parameters:

componentName - The unique component name.

Returns:

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

Throws:

JBIException - if the component name is not registered.