com.adobe.idp.dsc.registry.component
Interface ComponentRegistry

All Known Implementing Classes:

ComponentRegistryClient

public interface ComponentRegistry

A ComponentRegistry implementation provides clients with the ability to to query the metadata and state of a component, install and or uninstall components, and toggle the state of a component from RUNNING to STOPPED

Field Summary

static java.lang.String

SERVICE_ID

Method Summary

void	clearCache() Clears any caching of components.
void	forceUninstall(Component aComponent) Forces the uninstall of a component, calling its Bootstrap interface and removing it from the container.
Component	getComponent(java.lang.String aComponentId, java.lang.String aVersion) Retrieves the specified version of a component or throws a ComponentNotFoundException if it does not exist.
java.util.List	getComponents() Retrieves a list of all the components installed in the container.
java.util.List	getComponents(java.lang.String aComponentId) Retrieves all versions with the specified component identifier.
Component	install(byte[] componentArchiveByteArray) Deprecated. see ComponentRegistry.install(com.adobe.idp.Document aDoc)
Component	install(Document componentArchiveDocument) Installs a component, calling its Bootstrap interface and leaving the component in a STOPPED state.
Component	modify(ModifyComponentInfo aInfo) Modifies a component with the specified component information.
Component	start(Component aComponent) Starts a component, calling its LifeCycle interface and leaving the component in a RUNNING state.
Component	start(Component aComponent, boolean aOverrideEndpointCreation) Starts a component, calling its LifeCycle interface and leaving the component in a RUNNING state.
Component	stop(Component aComponent) Stops a component, calling its LifeCycle interface and leaving the component in a STOPPED state.
void	uninstall(Component aComponent) Uninstalls a component, calling its Bootstrap interface and removing it from the container.

Field Detail

SERVICE_ID

static final java.lang.String SERVICE_ID

See Also:

Constant Field Values

Method Detail

getComponents

java.util.List getComponents()

Retrieves a list of all the components installed in the container.

Returns:

A list of all the components installed in the container.

getComponents

java.util.List getComponents(java.lang.String aComponentId)

Retrieves all versions with the specified component identifier.

Parameters:

aComponentId - The component identifier.

Returns:

A list of all the components matching the specified component identifier.

getComponent

Component getComponent(java.lang.String aComponentId,
                       java.lang.String aVersion)
                       throws ComponentNotFoundException

Retrieves the specified version of a component or throws a ComponentNotFoundException if it does not exist.

Parameters:

aComponentId - The identifier of the component to return.

aVersion - The version number of the component to return.

Returns:

The specified component.

Throws:

ComponentNotFoundException

install

Component install(Document componentArchiveDocument)
                  throws RegistryException

Installs a component, calling its Bootstrap interface and leaving the component in a STOPPED state.

Parameters:

componentArchiveDocument - A valid Document representing the bits of the underlying component jar.

Returns:

The component that was installed.

Throws:

RegistryException

install

Component install(byte[] componentArchiveByteArray)
                  throws RegistryException

Deprecated. see ComponentRegistry.install(com.adobe.idp.Document aDoc)

Installs a component using a byte array, calling its Bootstrap interface and leaving the component in a STOPPED state. The byte array is expected to by a LC Component JAR file. In most circumstances calling the overloaded version of this method that takes a com.adobe.idp.Document object is the preferred method since the Document object is a more efficient mechansim of transporting large document objects.

Parameters:

componentArchiveByteArray - A byte array representing the bits of the underlying component jar.

Returns:

The component that was installed.

Throws:

RegistryException

modify

Component modify(ModifyComponentInfo aInfo)
                 throws RegistryException

Modifies a component with the specified component information.

Parameters:

aInfo - The component information with which to modify the component.

Returns:

The modified component.

Throws:

RegistryException

start

Component start(Component aComponent)
                throws RegistryException

Starts a component, calling its LifeCycle interface and leaving the component in a RUNNING state.

Parameters:

aComponent - The component to start.

Returns:

component The started component.

Throws:

RegistryException

start

Component start(Component aComponent,
                boolean aOverrideEndpointCreation)
                throws RegistryException

Starts a component, calling its LifeCycle interface and leaving the component in a RUNNING state.

Parameters:

aComponent - The component to start.

aOverrideEndpointCreation - specify whether to override the creation of default endpoints for services that are started and deployed as a result of starting the component by default endpoints are always created, passing true will override this creation

Returns:

component The started component.

Throws:

RegistryException

stop

Component stop(Component aComponent)
               throws RegistryException

Stops a component, calling its LifeCycle interface and leaving the component in a STOPPED state.

Parameters:

aComponent - The component to stop.

Returns:

The stopped component.

Throws:

RegistryException

uninstall

void uninstall(Component aComponent)
               throws RegistryException

Uninstalls a component, calling its Bootstrap interface and removing it from the container.

Parameters:

aComponent - The component to uninstall.

Throws:

RegistryException

forceUninstall

void forceUninstall(Component aComponent)
                    throws RegistryException

Forces the uninstall of a component, calling its Bootstrap interface and removing it from the container.

Parameters:

aComponent - The component to uninstall.

Throws:

RegistryException

clearCache

void clearCache()

Clears any caching of components.