com.adobe.idp.dsc.registry.service
Interface ServiceRegistry

All Known Implementing Classes:

ServiceRegistryClient

public interface ServiceRegistry

A ServiceRegistry implementation provides clients with the ability to query the metadata and state of a service, to deploy and undeploy services, and to toggle the state of a service from RUNNING to STOPPED.

Field Summary

static java.lang.String	DEFAULT_CATEGORY_ID
static java.lang.String	SERVICE_ID

Method Summary

void	clearCache() Clears any caching of services.
ServiceConfiguration	createAndDeploy(Component aComponent, java.lang.String aServiceId, int aMajorVersion, int aMinorVersion, java.lang.String aDescriptor, java.util.Map aConfigValuesAsStrings) Creates and deploys a new service, leaving it in a STOPPED state.
ServiceConfiguration	createAndDeploy(Component aComponent, java.lang.String aCategoryId, java.lang.String aServiceId, int aMajorVersion, int aMinorVersion, java.lang.String aType, java.lang.String aDescriptor, java.util.Map aConfigValuesAsStrings) Creates and deploys a new service configuration, leaving it in a STOPPED state.
ServiceConfiguration	createAndDeploy(CreateServiceConfigurationInfo aInfo, java.util.Map aConfigValuesAsStrings) Creates and deploys a new service configuration, leaving it in a STOPPED state.
ServiceConfiguration	createAndDeploy(CreateServiceConfigurationInfo aInfo, java.util.Map aConfigValuesAsStrings, boolean aOverrideEndpointCreation) Creates and deploys a new service configuration, leaving it in a STOPPED state.
ServiceCategory	createCategory(CreateServiceCategoryInfo aInfo) Creates a service category with the specified category information.
ServiceConfiguration	createConfiguration(CreateServiceConfigurationInfo aInfo) Creates a service configuration with the specified configuration information values.
Service	createService(CreateServiceInfo aInfo) Creates a new Service object with the values specified in the CreateServiceInfo object.
ServiceConfiguration	deploy(ServiceConfiguration aConfig) Transitions an Inactive service configuration into an Active, but STOPPED state.
void	forceRemovalOfConfiguration(ServiceConfiguration aConfig) Forces the removal of the specified service configuration.
ServiceConfiguration	forceUndeploy(ServiceConfiguration aServiceConfig) Forces the undeploy of a service (ignoring exceptions for callback methods), transitioning it to an Inactive state.
java.util.Map	getClientLibAsMap(java.lang.String aServiceId, int aMajorVersion, int aMinorVersion) This method returns a java.util.Map of classes and resources needed by clients to interact with this service.
ServiceConfiguration	getCompatibleServiceConfiguration(java.lang.String aServiceName, int aMajorVersion, int aMinorVersion) Retrieves a service with the specified service identifier that is compatible with the specified version.
ServiceConfiguration	getHeadActiveConfiguration(java.lang.String aServiceName) Retrieves a service with the specified service identifier.
ServiceConfiguration	getHeadServiceConfiguration(java.lang.String aServiceName) Deprecated. see getHeadActiveConfiguration
Service	getService(java.lang.String aServiceId) Retrieves the specified service.
java.util.List	getServiceCategories() Retrieves all of the service categories in the container.
java.util.List	getServiceCategories(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves all the service configurations within the container with the specified paging criteria.
ServiceCategory	getServiceCategory(java.lang.String aId) Retrieves the specified service category.
ServiceConfiguration	getServiceConfiguration(java.lang.String aServiceName, int aMajorVersion, int aMinorVersion) Retrieves a single service configuration with the specified service identifier and version information.
java.util.List	getServiceConfigurations() Retrieves a list of all the services within the container.
java.util.List	getServiceConfigurations(Component aComponent) Retrieves a list of all the service configurations within the container that are deployed against the specified component.
com.adobe.idp.dsc.filter.FilterResult	getServiceConfigurations(com.adobe.idp.dsc.filter.PagingFilter aFilter) Retrieves a list of all the service configurations, within the container, having the specified paging criteria.
java.util.List	getServiceConfigurations(Service aService) Retrieves a list of all the service configurations within the container that are created for the specified service.
java.util.List	getServiceConfigurationsForSpecificationId(java.lang.String aSpecificationId) Retrieves a list of all the service configurations within the container that implement the specification identifier.
java.util.List	getServices() Retrieves all the services.
java.util.List	getServices(ServiceCategory aCategory) Retrieves the services belonging to the specified category.
ServiceConfiguration	lock(ServiceConfiguration aConfig) Locks a service configuration so that it can only be modified by the "LockedByUser".
ServiceCategory	modifyCategory(ModifyServiceCategoryInfo aInfo) Modifies a service category by applying the specified properties.
ServiceConfiguration	modifyConfiguration(ModifyServiceConfigurationInfo aInfo) Modifies the specified service configuration with the properties that have been set in the ModifyServiceConfigurationInfo object.
Service	modifyService(ModifyServiceInfo aInfo) Modifies the specified Service object with the values specified in the ModifyServiceInfo object.
void	removeCategory(ServiceCategory aCat) Removes the specified service category.
void	removeConfiguration(ServiceConfiguration aConfig) Removes the specified service configuration.
void	removeService(Service aService) Removes the specified service.
ServiceConfiguration	start(ServiceConfiguration aService) Starts the specified document service, transitioning the state of the service from STOPPED to RUNNING.
ServiceConfiguration	stop(ServiceConfiguration aService) Stops the specified document service, tansitioning the state of the service from RUNNING to STOPPED.
ServiceConfiguration	undeploy(ServiceConfiguration aServiceConfig) Undeploys a service, transitioning it to an Inactive state.
ServiceConfiguration	unlock(ServiceConfiguration aConfig) Releases the lock held by the "LockedByUser".

Field Detail

SERVICE_ID

static final java.lang.String SERVICE_ID

See Also:

Constant Field Values

DEFAULT_CATEGORY_ID

static final java.lang.String DEFAULT_CATEGORY_ID

See Also:

Constant Field Values

Method Detail

createService

Service createService(CreateServiceInfo aInfo)
                      throws RegistryException

Creates a new Service object with the values specified in the CreateServiceInfo object.

Parameters:

aInfo - Values to be applied to the new Service object.

Returns:

A new Service object containing the specified information.

Throws:

RegistryException

getService

Service getService(java.lang.String aServiceId)
                   throws RegistryException

Retrieves the specified service.

Parameters:

aServiceId - The service identifier.

Returns:

The service.

Throws:

RegistryException

modifyService

Service modifyService(ModifyServiceInfo aInfo)
                      throws RegistryException

Modifies the specified Service object with the values specified in the ModifyServiceInfo object.

Parameters:

aInfo - Property values to be applied to the specified Service object.

Returns:

A copy of the modified service.

Throws:

RegistryException

removeService

void removeService(Service aService)
                   throws RegistryException

Removes the specified service.

Parameters:

aService - The service to remove.

Throws:

RegistryException

getServices

java.util.List getServices(ServiceCategory aCategory)

Retrieves the services belonging to the specified category.

Parameters:

aCategory - The service category.

Returns:

The services belonging to the specified category.

getServices

java.util.List getServices()

Retrieves all the services.

Returns:

All the services.

createCategory

ServiceCategory createCategory(CreateServiceCategoryInfo aInfo)
                               throws RegistryException

Creates a service category with the specified category information.

Parameters:

aInfo - The category information.

Returns:

The new service category.

Throws:

RegistryException

modifyCategory

ServiceCategory modifyCategory(ModifyServiceCategoryInfo aInfo)
                               throws RegistryException

Modifies a service category by applying the specified properties.

Parameters:

aInfo - Values to be applied to the service category.

Returns:

The modified service category.

Throws:

RegistryException

removeCategory

void removeCategory(ServiceCategory aCat)
                    throws RegistryException

Removes the specified service category.

Parameters:

aCat - The service category to be removed.

Throws:

RegistryException

getServiceCategory

ServiceCategory getServiceCategory(java.lang.String aId)
                                   throws RegistryException

Retrieves the specified service category.

Parameters:

aId - The category identifier.

Returns:

The service category.

Throws:

RegistryException

getServiceCategories

java.util.List getServiceCategories()

Retrieves all of the service categories in the container.

Returns:

All of the service categories in the container.

getServiceCategories

java.util.List getServiceCategories(com.adobe.idp.dsc.filter.PagingFilter aFilter)

Retrieves all the service configurations within the container with the specified paging criteria.

Parameters:

aFilter - The paging criteria.

Returns:

All the service configurations within the container with the specified paging criteria.

createConfiguration

ServiceConfiguration createConfiguration(CreateServiceConfigurationInfo aInfo)
                                         throws RegistryException

Creates a service configuration with the specified configuration information values.

Parameters:

aInfo - The configuration information values.

Returns:

The service configuration with the specified configuration information values.

Throws:

RegistryException

removeConfiguration

void removeConfiguration(ServiceConfiguration aConfig)
                         throws RegistryException

Removes the specified service configuration.

Parameters:

aConfig - The service configuration to be removed.

Throws:

RegistryException

forceRemovalOfConfiguration

void forceRemovalOfConfiguration(ServiceConfiguration aConfig)
                                 throws RegistryException

Forces the removal of the specified service configuration.

Parameters:

aConfig - The service configuration to be removed.

Throws:

RegistryException

getServiceConfigurations

java.util.List getServiceConfigurations()

Retrieves a list of all the services within the container.

Returns:

A list of all the services within the container.

getServiceConfigurations

com.adobe.idp.dsc.filter.FilterResult getServiceConfigurations(com.adobe.idp.dsc.filter.PagingFilter aFilter)

Retrieves a list of all the service configurations, within the container, having the specified paging criteria.

Parameters:

aFilter - The paging criteria.

Returns:

A list of all the service configurations, within the container, having the specified paging criteria.

getServiceConfigurations

java.util.List getServiceConfigurations(Component aComponent)

Retrieves a list of all the service configurations within the container that are deployed against the specified component.

Parameters:

aComponent - The component for which to list its related services.

Returns:

A list of all the service configurations within the container that are deployed against the specified component.

getServiceConfigurations

java.util.List getServiceConfigurations(Service aService)

Retrieves a list of all the service configurations within the container that are created for the specified service.

Parameters:

aService - The component for which to list its related services.

Returns:

A list of service configurations within the container that are created for the specified service.

getServiceConfigurationsForSpecificationId

java.util.List getServiceConfigurationsForSpecificationId(java.lang.String aSpecificationId)

Retrieves a list of all the service configurations within the container that implement the specification identifier.

Parameters:

aSpecificationId - The specification identifier.

Returns:

A list of all the service configurations within the container that implement the specification identifier.

getHeadServiceConfiguration

ServiceConfiguration getHeadServiceConfiguration(java.lang.String aServiceName)
                                                 throws RegistryException

Deprecated. see getHeadActiveConfiguration

Retrieves a service with the specified service identifier. If multiple versions exist, the latest or head version is returned.

Parameters:

aServiceName - The name of the service.

Returns:

The service.

Throws:

RegistryException

getHeadActiveConfiguration

ServiceConfiguration getHeadActiveConfiguration(java.lang.String aServiceName)
                                                throws RegistryException

Retrieves a service with the specified service identifier. If multiple versions exist, the latest or head version is returned.

Parameters:

aServiceName - The name of the service to be returned.

Returns:

The service.

Throws:

RegistryException

getCompatibleServiceConfiguration

ServiceConfiguration getCompatibleServiceConfiguration(java.lang.String aServiceName,
                                                       int aMajorVersion,
                                                       int aMinorVersion)
                                                       throws RegistryException

Retrieves a service with the specified service identifier that is compatible with the specified version.

Parameters:

aServiceName - The name of the service.

aMajorVersion - The major version.

aMinorVersion - The minor version.

Returns:

The service.

Throws:

ServiceNotFoundException

RegistryException

getServiceConfiguration

ServiceConfiguration getServiceConfiguration(java.lang.String aServiceName,
                                             int aMajorVersion,
                                             int aMinorVersion)
                                             throws RegistryException

Retrieves a single service configuration with the specified service identifier and version information.

Parameters:

aServiceName - The name of the service.

aMajorVersion - The major version.

aMinorVersion - The minor version.

Returns:

The service configuration.

Throws:

ServiceConfigurationNotFoundException

RegistryException

start

ServiceConfiguration start(ServiceConfiguration aService)
                           throws RegistryException

Starts the specified document service, transitioning the state of the service from STOPPED to RUNNING.

Parameters:

aService - The service to be started.

Returns:

The service.

Throws:

RegistryException

stop

ServiceConfiguration stop(ServiceConfiguration aService)
                          throws RegistryException

Stops the specified document service, tansitioning the state of the service from RUNNING to STOPPED.

Parameters:

aService - The service to be stopped.

Returns:

The service.

Throws:

RegistryException

createAndDeploy

ServiceConfiguration createAndDeploy(Component aComponent,
                                     java.lang.String aServiceId,
                                     int aMajorVersion,
                                     int aMinorVersion,
                                     java.lang.String aDescriptor,
                                     java.util.Map aConfigValuesAsStrings)
                                     throws RegistryException

Creates and deploys a new service, leaving it in a STOPPED state.

Parameters:

aComponent - The component against which the service is being deployed.

aServiceId - The identifier of the service that clients will use to look up and invoke.

aMajorVersion - The major version number of the service.

aMinorVersion - The minor version number of the service.

aDescriptor - The physical descriptor to be processed by the component. In the case of a POJO this is expected to be the service element; however, in the case of an orchestrated service this would be the process template.

aConfigValuesAsStrings - Configuration parameters, gathered through the deployment tool, that will be stored in the service registry. These values are expected to be the serialized output of a Property Editor.

Returns:

The new service.

Throws:

RegistryException

createAndDeploy

ServiceConfiguration createAndDeploy(Component aComponent,
                                     java.lang.String aCategoryId,
                                     java.lang.String aServiceId,
                                     int aMajorVersion,
                                     int aMinorVersion,
                                     java.lang.String aType,
                                     java.lang.String aDescriptor,
                                     java.util.Map aConfigValuesAsStrings)
                                     throws RegistryException

Creates and deploys a new service configuration, leaving it in a STOPPED state.

Parameters:

aComponent - The component against which the service is being deployed.

aCategoryId - The identifier of the category under which the service will be deployed.

aServiceId - The identifier of the service that clients will use to look up and invoke.

aMajorVersion - The major version number of the service.

aMinorVersion - The minor version number of the service.

aType - The type of the service configuration.

aDescriptor - The physical descriptor to be processed by the Component. In the case of a POJO this is expected to be the service element; however, in the case of an orchestrated service this would be the process template.

aConfigValuesAsStrings - Configuration parameters, gathered through the deployment tool, that will be stored in the service registry. These values are expected to be the serialized output of a Property Editor.

Returns:

The new service.

Throws:

RegistryException

createAndDeploy

ServiceConfiguration createAndDeploy(CreateServiceConfigurationInfo aInfo,
                                     java.util.Map aConfigValuesAsStrings)
                                     throws RegistryException

Creates and deploys a new service configuration, leaving it in a STOPPED state.

Parameters:

aInfo - An object containing the values used to create and deploy a service configuration.

aConfigValuesAsStrings - Configuration parameters, gathered through the deployment tool, which will be stored in the Service Registry. These values are expected to be the serialized output of a Property Editor.

Returns:

The new service configuration.

Throws:

RegistryException

createAndDeploy

ServiceConfiguration createAndDeploy(CreateServiceConfigurationInfo aInfo,
                                     java.util.Map aConfigValuesAsStrings,
                                     boolean aOverrideEndpointCreation)
                                     throws RegistryException

Creates and deploys a new service configuration, leaving it in a STOPPED state.

Parameters:

aInfo - An object containing the values used to create and deploy a service configuration.

aConfigValuesAsStrings - Configuration parameters, gathered through the deployment tool, which will be stored in the Service Registry. These values are expected to be the serialized output of a Property Editor.

aOverrideEndpointCreation - specify whether to override the creation of default endpoints, by default endpoints are always created, passing true will override this creation

Returns:

The new service configuration.

Throws:

RegistryException

modifyConfiguration

ServiceConfiguration modifyConfiguration(ModifyServiceConfigurationInfo aInfo)
                                         throws RegistryException

Modifies the specified service configuration with the properties that have been set in the ModifyServiceConfigurationInfo object.

Parameters:

aInfo - Contains property values to be set in the specified service configuration.

Returns:

A service configuration.

Throws:

RegistryException

undeploy

ServiceConfiguration undeploy(ServiceConfiguration aServiceConfig)
                              throws RegistryException

Undeploys a service, transitioning it to an Inactive state.

Parameters:

aServiceConfig - The service to be undeployed.

Throws:

RegistryException

forceUndeploy

ServiceConfiguration forceUndeploy(ServiceConfiguration aServiceConfig)
                                   throws RegistryException

Forces the undeploy of a service (ignoring exceptions for callback methods), transitioning it to an Inactive state.

Parameters:

aServiceConfig - The service to be undeployed.

Throws:

RegistryException

clearCache

void clearCache()

Clears any caching of services.

getClientLibAsMap

java.util.Map getClientLibAsMap(java.lang.String aServiceId,
                                int aMajorVersion,
                                int aMinorVersion)
                                throws RegistryException

This method returns a java.util.Map of classes and resources needed by clients to interact with this service. The classes and resources returned are determined by the export specifications in the related component's component.xml.

Parameters:

aServiceId - The service identifier.

aMajorVersion - The major version.

aMinorVersion - The minor version.

Returns:

A java.util.Map of classes and resources needed by clients to interact with this service.

Throws:

RegistryException

lock

ServiceConfiguration lock(ServiceConfiguration aConfig)
                          throws RegistryException

Locks a service configuration so that it can only be modified by the "LockedByUser".

Parameters:

aConfig - The service configuration to be locked.

Returns:

The locked service configuration.

Throws:

RegistryException

unlock

ServiceConfiguration unlock(ServiceConfiguration aConfig)
                            throws RegistryException

Releases the lock held by the "LockedByUser".

Parameters:

aConfig - The service configuration to be unlocked.

Returns:

The unlocked service configuration.

Throws:

RegistryException

deploy

ServiceConfiguration deploy(ServiceConfiguration aConfig)
                            throws RegistryException

Transitions an Inactive service configuration into an Active, but STOPPED state.

Parameters:

aConfig - The service configuration to be transitioned.

Returns:

The Active service configuration.

Throws:

RegistryException