com.endeca.itl.component.manager
Interface ComponentInstanceManager

public interface ComponentInstanceManager

Manages components inside the Endeca CAS Service.

Method Summary

void	createComponentInstance(ComponentTypeId componentTypeId, ComponentInstanceId componentInstanceId) Creates a component instance of the given type with the given id.
void	deleteComponentInstance(ComponentInstanceId componentInstanceId) Deletes the given component instance.
ComponentInstanceDescriptor	getComponentInstanceDescriptor(ComponentInstanceId componentInstanceId)
boolean	hasComponentInstance(ComponentInstanceId componentInstanceId)
List<ComponentInstanceDescriptor>	listComponentInstances() Lists all component instances defined in the system.
List<ComponentTypeDescriptor>	listComponentTypes() Lists all component types defined in the system.

Method Detail

listComponentTypes

@ResponseWrapper(className="com.endeca.itl.component.manager.ListComponentTypesResponse")
List<ComponentTypeDescriptor> listComponentTypes()
                                                 throws ComponentManagerException

Lists all component types defined in the system.

Throws:

ComponentManagerException

listComponentInstances

@ResponseWrapper(className="com.endeca.itl.component.manager.ListComponentInstancesResponse")
List<ComponentInstanceDescriptor> listComponentInstances()
                                                         throws ComponentManagerException

Lists all component instances defined in the system.

Throws:

ComponentManagerException

getComponentInstanceDescriptor

ComponentInstanceDescriptor getComponentInstanceDescriptor(ComponentInstanceId componentInstanceId)
                                                           throws ComponentInstanceNotFoundException

Returns:

ComponentInstanceDescriptor for the componentInstanceId provided

Throws:

ComponentInstanceNotFoundException - if the componentInstanceId is not found

hasComponentInstance

boolean hasComponentInstance(ComponentInstanceId componentInstanceId)
                             throws ComponentManagerException

Returns:

true if the given component instance exists

Throws:

ComponentManagerException

createComponentInstance

void createComponentInstance(ComponentTypeId componentTypeId,
                             ComponentInstanceId componentInstanceId)
                             throws ComponentManagerException,
                                    InvalidComponentInstanceException,
                                    ComponentTypeNotFoundException

Creates a component instance of the given type with the given id. After this call returns, clients will be able to talk directly to the component instance. The component instance will be automatically started whenever the ComponentInstanceManager is started.

Throws:

InvalidComponentInstanceException - if the instance id is already in use or has invalid characters

ComponentTypeNotFoundException - if the component type is not registered with the system

ComponentManagerException - if there was an error starting the component instance

deleteComponentInstance

void deleteComponentInstance(ComponentInstanceId componentInstanceId)
                             throws ComponentManagerException,
                                    ComponentInstanceNotFoundException

Deletes the given component instance. After this call returns, clients will no longer be able to talk to the component instance.

Throws:

ComponentInstanceNotFoundException - if the ComponentInstanceManager does not contain the component instance

ComponentManagerException - if there was an error stopping the component instance