org.ow2.dragon.api.service.technology
Interface TechnologyManager

All Known Implementing Classes:

TechnologyManagerImpl

@Transactional
public interface TechnologyManager

This API allows to connect to Execution Environments (Petals ESB...) and retrieve information about these enviroments like hosted services and endpoints. Method arguments must be non null, unless the contrary is explicitly specified.

Author:

ofabre - eBM Websourcing

Method Summary

java.lang.String	addRuntimeManager(java.lang.String address) Add a new runtime manager to the registry.
java.util.List<EnvironmentFederationTO>	getAllEnvironmentFederations(RequestOptionsTO requestOptionsTO) Return the list of all environment federations in the registry
java.util.List<ExecutionEnvironmentManagerTO>	getAllExecutionEnvironmentManagers(RequestOptionsTO requestOptionsTO) Return the list of all runtime managers (aka Execution Environment Managers) in the registry
java.util.List<ExecutionEnvironmentTO>	getAllExecutionEnvironments(RequestOptionsTO requestOptionsTO) Return the list of all execution environments in the registry
java.util.List<ProcessorTO>	getAllProcessors(RequestOptionsTO requestOptionsTO) Return the list of all processors in the registry
EnvironmentFederationTO	getEnvironmentFederation(java.lang.String envFedId) Retrieve the environment federation matching the given ID
java.util.List<EndpointTO>	getEpsHostedOnExecEnv(java.lang.String execEnvId, RequestOptionsTO requestOptionsTO) Retrieve the list of endpoints that are hosted by the given execution environment
java.util.List<EndpointTO>	getEpsHostedOnProcessor(java.lang.String processorId, RequestOptionsTO requestOptionsTO) Retrieve the list of endpoints that are hosted by the given processor.
java.util.List<ExecutionEnvironmentTO>	getExecEnvsHostedOnProcessor(java.lang.String processorId, RequestOptionsTO requestOptionsTO) Retrieve the list of execution environments that are hosted by the given processor.
java.util.List<ExecutionEnvironmentTO>	getExecEnvsInFederation(java.lang.String envFedId, RequestOptionsTO requestOptionsTO) Retrieve the list of execution environments that are parts of the given environment federation
ExecutionEnvironmentTO	getExecutionEnvironment(java.lang.String execEnvId) Retrieve the execution environment matching the given ID
java.util.List<ExecutionEnvironmentTO>	getManagedExecEnv(java.lang.String runtimeManagerId, RequestOptionsTO requestOptionsTO) Retrieve the list of execution environments managed by the given runtime manager (aka execution environment manager)
ProcessorTO	getProcessor(java.lang.String processorId) Retrieve the processor matching the given ID
ExecutionEnvironmentManagerTO	getRuntimeManager(java.lang.String runtimeManagerId) Retrieve the runtime manager matching the given ID
void	removeEnvironmentFederation(java.lang.String envFedId) Remove the environment federation matching the given ID from the registry
void	removeExecutionEnvironment(java.lang.String execEnvId) Remove the execution environment matching the given ID from the registry
void	removeProcessor(java.lang.String processorId) Remove the processor matching the given ID from the registry
void	removeRuntimeManager(java.lang.String runtimeManagerId) Remove the runtime manager matching the given ID from the registry
java.util.List<EnvironmentFederationTO>	searchEnvironmentFederations(java.lang.String searchCriteria, java.util.List<FederationSearchProperties> searchedProperties, RequestOptionsTO requestOptionsTO) Retrieve the list of all environment federations matching the given criteria for the given properties
java.util.List<ExecutionEnvironmentManagerTO>	searchExecutionEnvironmentManagers(java.lang.String searchCriteria, java.util.List<ExecEnvManagerSearchProperties> searchedProperties, RequestOptionsTO requestOptionsTO) Retrieve the list of all runtime managers (aka execution environment managers) matching the given criteria for the given properties
java.util.List<ExecutionEnvironmentTO>	searchExecutionEnvironments(java.lang.String searchCriteria, java.util.List<ExecEnvSearchProperties> searchedProperties, RequestOptionsTO requestOptionsTO) Retrieve the list of all execution environments matching the given criteria for the given properties
java.util.List<ProcessorTO>	searchProcessors(java.lang.String searchCriteria, java.util.List<ProcessorSearchProperties> searchedProperties, RequestOptionsTO requestOptionsTO) Retrieve the list of all processors matching the given criteria for the given properties
void	synchronizeManagedExecEnv(java.lang.String runtimeManagerId) Synchronize all execution environments managed by this execution runtime manager.

Method Detail

addRuntimeManager

java.lang.String addRuntimeManager(java.lang.String address)
                                   throws TechnologyException

Add a new runtime manager to the registry. Uses the provided address to connect to the manager interface and retrieve manager properties

Parameters:

address - a manager service interface address like 'http://com.foo/ManagerService'. Must be a valid URL

Returns:

the added manager ID

Throws:

TechnologyException - if an error occurs during runtime manager creation or if the given URL isn't a valid URL

getRuntimeManager

@Transactional(readOnly=true)
ExecutionEnvironmentManagerTO getRuntimeManager(java.lang.String runtimeManagerId)
                                                throws TechnologyException

Retrieve the runtime manager matching the given ID

Parameters:

runtimeManagerId - a runtime manager ID

Returns:

the ExecutionEnvironmentTO (aka runtime manager) matching the given ID

Throws:

TechnologyException - if no runtime manager found matching the given id

getEnvironmentFederation

@Transactional(readOnly=true)
EnvironmentFederationTO getEnvironmentFederation(java.lang.String envFedId)
                                                 throws TechnologyException

Retrieve the environment federation matching the given ID

Parameters:

envFedId - an environment federation ID

Returns:

the EnvironmentFederationTO matching the given ID

Throws:

TechnologyException - if no EnvironmentFederation found for the given id

getManagedExecEnv

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentTO> getManagedExecEnv(java.lang.String runtimeManagerId,
                                                                       RequestOptionsTO requestOptionsTO)

Retrieve the list of execution environments managed by the given runtime manager (aka execution environment manager)

Parameters:

runtimeManagerId - a runtime manager ID

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of ExecutionEnvironmentTOs managed by the given runtime manager (aka ExecutionEnvironmentManagerTO). Can't be null, could be empty

getExecEnvsInFederation

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentTO> getExecEnvsInFederation(java.lang.String envFedId,
                                                                             RequestOptionsTO requestOptionsTO)

Retrieve the list of execution environments that are parts of the given environment federation

Parameters:

envFedId - an environment federation ID

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of ExecutionEnvironmentTOs that are parts of the given EnvironmentFederationTO. Can't be null, could be empty

removeRuntimeManager

void removeRuntimeManager(java.lang.String runtimeManagerId)
                          throws TechnologyException

Remove the runtime manager matching the given ID from the registry

Parameters:

runtimeManagerId - a runtime manager ID

Throws:

TechnologyException - if no ExecutionEnvironmentManager can be found for the given id

removeEnvironmentFederation

void removeEnvironmentFederation(java.lang.String envFedId)
                                 throws TechnologyException

Remove the environment federation matching the given ID from the registry

Parameters:

envFedId - an environment federation ID

Throws:

TechnologyException - if no EnvironmentFederation found matching the given id

synchronizeManagedExecEnv

void synchronizeManagedExecEnv(java.lang.String runtimeManagerId)
                               throws TechnologyException

Synchronize all execution environments managed by this execution runtime manager. All linked endpoints, environment federations and processors will also be synchronized. Synchronization consist in adding elements to the registry

Parameters:

runtimeManagerId - a runtime manager ID

Throws:

TechnologyException - if no runtime manager found for the given id or if a database incoherence is detected

getExecutionEnvironment

@Transactional(readOnly=true)
ExecutionEnvironmentTO getExecutionEnvironment(java.lang.String execEnvId)
                                               throws TechnologyException

Retrieve the execution environment matching the given ID

Parameters:

execEnvId - an execution environment ID

Returns:

the ExecutionEnvironmentTO matching the given ID

Throws:

TechnologyException - if no ExecutionEnvironment found matching the given id

getProcessor

@Transactional(readOnly=true)
ProcessorTO getProcessor(java.lang.String processorId)
                         throws TechnologyException

Retrieve the processor matching the given ID

Parameters:

processorId - a processor ID

Returns:

the ProcessorTO matching the given ID

Throws:

TechnologyException - if no processor found matching the given id

removeExecutionEnvironment

void removeExecutionEnvironment(java.lang.String execEnvId)
                                throws TechnologyException

Remove the execution environment matching the given ID from the registry

Parameters:

execEnvId - an execution environment ID

Throws:

TechnologyException - if no ExecutionEnvironment found matching the given id

removeProcessor

void removeProcessor(java.lang.String processorId)
                     throws TechnologyException

Remove the processor matching the given ID from the registry

Parameters:

processorId - a processor ID

Throws:

TechnologyException - if no Processor found matching the given id

getEpsHostedOnExecEnv

@Transactional(readOnly=true)
java.util.List<EndpointTO> getEpsHostedOnExecEnv(java.lang.String execEnvId,
                                                               RequestOptionsTO requestOptionsTO)

Retrieve the list of endpoints that are hosted by the given execution environment

Parameters:

execEnvId - an execution environment ID

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of EndpointTOs that are hosted by the given ExecutionEnvironmentTO. Can't be null, could be empty

getEpsHostedOnProcessor

@Transactional(readOnly=true)
java.util.List<EndpointTO> getEpsHostedOnProcessor(java.lang.String processorId,
                                                                 RequestOptionsTO requestOptionsTO)

Retrieve the list of endpoints that are hosted by the given processor. It means all endpoints hosted by execution environment hosted on the given processor

Parameters:

processorId - a processor ID

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of EndpointTOs that are hosted by the given ProcessorTO

getExecEnvsHostedOnProcessor

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentTO> getExecEnvsHostedOnProcessor(java.lang.String processorId,
                                                                                  RequestOptionsTO requestOptionsTO)

Retrieve the list of execution environments that are hosted by the given processor.

Parameters:

processorId - a processor ID

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of ExecutionEnvironmentTOs that are hosted by the given ProcessorTO. Can't be null, could be empty

getAllExecutionEnvironmentManagers

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentManagerTO> getAllExecutionEnvironmentManagers(RequestOptionsTO requestOptionsTO)

Return the list of all runtime managers (aka Execution Environment Managers) in the registry

Parameters:

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

List of all runtime managers (aka ExecutionEnvironmentManagerTO) in the registry. Can't be null, could be empty

getAllEnvironmentFederations

@Transactional(readOnly=true)
java.util.List<EnvironmentFederationTO> getAllEnvironmentFederations(RequestOptionsTO requestOptionsTO)

Return the list of all environment federations in the registry

Parameters:

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all EnvironmentFederationTOs in the registry. Can't be null, could be empty

searchExecutionEnvironmentManagers

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentManagerTO> searchExecutionEnvironmentManagers(java.lang.String searchCriteria,
                                                                                               java.util.List<ExecEnvManagerSearchProperties> searchedProperties,
                                                                                               RequestOptionsTO requestOptionsTO)
                                                                                 throws TechnologyException

Retrieve the list of all runtime managers (aka execution environment managers) matching the given criteria for the given properties

Parameters:

searchCriteria - the search criteria (a String containing criteria separated with whitespaces), musn't be empty

searchedProperties - the searched properties, musn't be empty

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all runtime managers (aka ExecutionEnvironmentManagerTOs) matching the given criteria for the given properties. Can't be null, could be empty

Throws:

TechnologyException - if you try to search without specifying criteria

searchEnvironmentFederations

@Transactional(readOnly=true)
java.util.List<EnvironmentFederationTO> searchEnvironmentFederations(java.lang.String searchCriteria,
                                                                                   java.util.List<FederationSearchProperties> searchedProperties,
                                                                                   RequestOptionsTO requestOptionsTO)
                                                                     throws TechnologyException

Retrieve the list of all environment federations matching the given criteria for the given properties

Parameters:

searchCriteria - the search criteria (a String containing criteria separated with whitespaces), mustn't be empty

searchedProperties - the searched properties, mustn't be empty

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all EnvironmentFederationTOs matching the given criteria for the given properties. Can't be null, could be empty

Throws:

TechnologyException - if you try to search without specifying criteria

getAllExecutionEnvironments

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentTO> getAllExecutionEnvironments(RequestOptionsTO requestOptionsTO)

Return the list of all execution environments in the registry

Parameters:

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all ExecutionEnvironmentTOs in the registry. Can't be null, could be empty

searchExecutionEnvironments

@Transactional(readOnly=true)
java.util.List<ExecutionEnvironmentTO> searchExecutionEnvironments(java.lang.String searchCriteria,
                                                                                 java.util.List<ExecEnvSearchProperties> searchedProperties,
                                                                                 RequestOptionsTO requestOptionsTO)
                                                                   throws TechnologyException

Retrieve the list of all execution environments matching the given criteria for the given properties

Parameters:

searchCriteria - the search criteria (a String containing criteria separated with whitespaces), musn't be empty

searchedProperties - the searched properties, musn't be empty

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all ExecutionEnvironmentTOs matching the given criteria for the given properties. Can't be null, could be empty

Throws:

TechnologyException - if you try to search without specifying criteria

getAllProcessors

@Transactional(readOnly=true)
java.util.List<ProcessorTO> getAllProcessors(RequestOptionsTO requestOptionsTO)

Return the list of all processors in the registry

Parameters:

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all ProcessorTOs in the registry. Can't be null, could be empty

searchProcessors

@Transactional(readOnly=true)
java.util.List<ProcessorTO> searchProcessors(java.lang.String searchCriteria,
                                                           java.util.List<ProcessorSearchProperties> searchedProperties,
                                                           RequestOptionsTO requestOptionsTO)
                                             throws TechnologyException

Retrieve the list of all processors matching the given criteria for the given properties

Parameters:

searchCriteria - the search criteria (a String containing criteria separated with whitespaces), musn't be empty

searchedProperties - the searched properties, musn't be empty

requestOptionsTO - sort, pagination and case sensitive parameters. Could be null

Returns:

the List of all ProcessorTOs matching the given criteria for the given properties. Can't be null, could be empty

Throws:

TechnologyException - if you try to search without specifying criteria