Package com.adobe.idp.dsc.registry.component.client
Classpublic class ComponentRegistryClient
InheritanceComponentRegistryClient Inheritance Object

The client implementation of the Component Registry. It provides clients the ability to query the metadata and state of a component, to install and uninstall components, and to toggle the state of a component from RUNNING to STOPPED.


Public Methods
 MethodDefined by
  
ComponentRegistryClient(ServiceClientFactory clientServiceFactory)
The constructor for creating a Component Registry client instance.
ComponentRegistryClient
  
void clearCache()
Clears any caching of components.
ComponentRegistryClient
  
void forceUninstall(Component aComponent)
Forces the uninstall of a component, calling its Bootstrap interface and removing it from the container.
ComponentRegistryClient
  
Component getComponent(String aComponentId, String aVersion)
Retrieves the specified version of a component or throws a com.adobe.idp.dsc.registry.ComponentNotFoundException if it does not exist.
ComponentRegistryClient
  
List getComponents()
Retrieves a list of all the components installed in the container.
ComponentRegistryClient
  
List getComponents(String aComponentId)
Retrieves all versions with the specified component identifier.
ComponentRegistryClient
  
Component install(Document componentArchiveDocument)
Installs a component, calling its Bootstrap interface and leaving the component in a STOPPED state.
ComponentRegistryClient
  
Component install(byte[] componentArchiveByteArray)
Installs a component, calling its Bootstrap interface and leaving the component in a STOPPED state.
ComponentRegistryClient
  
Component load(Component aComponent)
Loads a component, calling its Bootstrap interface and leaving the component in a STOPPED state.
ComponentRegistryClient
  
Component modify(ModifyComponentInfo aInfo)
Modifies a component with the specified component information.
ComponentRegistryClient
  
Component start(Component aComponent)
Starts a component, calling its LifeCycle interface and leaving the component in a RUNNING state.
ComponentRegistryClient
  
Component stop(Component aComponent)
Stops a component, calling its LifeCycle interface and leaving the component in a STOPPED state.
ComponentRegistryClient
  
void uninstall(Component aComponent)
Uninstalls a component, calling its Bootstrap interface and removing it from the container.
ComponentRegistryClient
Constructor Detail
ComponentRegistryClient()
public ComponentRegistryClient(ServiceClientFactory clientServiceFactory)

The constructor for creating a Component Registry client instance.

Parameters
clientServiceFactory — A ServiceClientFactory instance with valid credentials of the server where the service is deployed.
Method Detail
clearCache()
public void clearCache()

Clears any caching of components.

forceUninstall() 
public void forceUninstall(Component aComponent)

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

Parameters

aComponent — The component to uninstall.


Throws
RegistryException
getComponent() 
public Component getComponent(String aComponentId, String aVersion)

Retrieves the specified version of a component or throws a com.adobe.idp.dsc.registry.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
com.adobe.idp.dsc.registry.ComponentNotFoundException
getComponents() 
public 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() 
public List getComponents(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.
install() 
public Component install(Document componentArchiveDocument)

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

Parameters

componentArchiveDocument — A valid com.adobe.idp.Document representing the bits of the underlying component jar.

Returns
The component that was installed.

Throws
RegistryException
install() 
public Component install(byte[] componentArchiveByteArray)

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

Parameters

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

Returns
The component that was installed.

Throws
RegistryException
load() 
public Component load(Component aComponent)

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

Parameters

aComponent — The component to load.

Returns
The component that was loaded.

Throws
RegistryException
modify() 
public Component modify(ModifyComponentInfo aInfo)

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() 
public Component start(Component aComponent)

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
stop() 
public Component stop(Component aComponent)

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() 
public void uninstall(Component aComponent)

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

Parameters

aComponent — The component to uninstall.


Throws
RegistryException



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Sep 27 2007, 8:38 AM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/dsc/registry/component/client/ComponentRegistryClient.html