com.adobe.idp.dsc.registry.infomodel
Interface ServiceConfiguration

All Superinterfaces:

java.io.Serializable

public interface ServiceConfiguration
extends java.io.Serializable

A ServiceConfiguration object provides access to metadata describing the document service.

Field Summary

static int	INACTIVE Inactive state.
static int	INSTANCE_PER_REQUEST Instance per request.
static int	POOLED_INSTANCE Pool instance
static java.lang.String	RUN_AS_INVOKER Run As Configuration setting, which means the service will be run with the invoking context.
static java.lang.String	RUN_AS_SYSTEM Run As Configuration setting, which means the service will be run with the System Context.
static int	RUNNING Running state.
static int	SINGLE_INSTANCE Single instance.
static int	STOPPED Stopped state.
static int	UNKNOWN Unknown state.

Method Summary

short	getAccessLevel() Retrieves the access level of the document service.
java.util.Map	getAttributes() Retrieves a map of attributes that are interpreted by and specific to the component from which this document service was deployed.
java.lang.String	getComponentId() Retrieves the identifier of the component with which this service is invoked.
java.lang.String	getComponentVersion() Retrieves the version of the component with which this service is interpreted.
ConfigParameter	getConfigParameter(java.lang.String aName) Retrieves the configuration parameter with the specified name.
ConfigParameter[]	getConfigParameters() Retrieves all of the configuration parameters defined for this document service.
java.util.Date	getCreateTime() Retrieves the time when this service configuration was created.
java.lang.String	getDescription() Retrieves the description of the document service.
java.lang.String	getDescriptor() Retrieves the descriptor from this service configuration, which is used to derive the signature of the service.
java.lang.String	getHint() Retrieves short text that describes the purpose of the document service and is displayed within related user interfaces.
byte[]	getLargeIcon() Retrieves the large icon representation of the document service.
java.lang.String	getLockedByUser() Retrieves the user who has locked this service configuration.
short	getMajorVersion() Retrieves the major version number of the document service.
short	getMinorVersion() Retrieves the minor version number of the document service.
Operation	getOperation(java.lang.String aName) Retrieves an Operation by name if it exists for this document service.
Operation[]	getOperations() Retrieves all of the operations defined for this document service.
boolean	getOrchestrateable() Determines whether a service or any of its operations can be used within an orchestration.
com.adobe.idp.dsc.registry.infomodel.ServicePoolConfiguration	getPoolConfiguration() Retrieves pool configuration for the service
int	getRequestProcessingStrategy() Retrieves the chosen request processing strategy used by the service.
java.lang.String	getRunAsConfiguration() Retrieves the run as configuration for the context which to set to run this service with.
java.lang.String	getServiceId() Retrieves the name of the document service, which must be unique within the Service Registry.
byte[]	getSmallIcon() Retrieves the small icon representation of the document service.
java.lang.String[]	getSpecificationIds() Retrieves the specification identifiers implemented by this service configuration.
boolean	getStartWithComponent() Determines whether this service should automatically start after its related component starts.
int	getState() Retrieves the current state of the document service.
java.lang.String[]	getSupportedConnectorIds() Retrieves an array of connector identifiers, specifying which connectors can be used to set up endpoints for a service.
java.lang.String	getTitle() Retrieves the title of the document service.
java.lang.String	getType() Retrieves the type of service configuration.
java.util.Date	getUpdateTime() Retrieves the time when this service configuration was last updated.
boolean	hasRunAsConfiguration() Determines whether this service has run as configuration set.
boolean	isActive() Determines whether this service configuration is active.
boolean	isAuditingEnabled() Determines whether execution auditing is enabled for this operations of this service configuration
boolean	isLocked() Determines whether this service configuration is locked.
boolean	isMonitoringEnabled() Determines whether Business Activity Montioring is requested for this service.
boolean	isOrchestration() Deprecated. This method is deprecated because the document service container is not and should not be knowledgeable of the workflow or how any service is implemented (other than knowing which document service container will execute it). Document service containers and clients wishing to track the type of configuration or implementation should set and query the "type" property of the service configuration with a value which is meant for client purposes only and is not used by the service container itself.
boolean	isRunning() Determines whether this service configuration is running.
boolean	isStopped() Determines whether this service configuration is stopped.

Field Detail

UNKNOWN

static final int UNKNOWN

Unknown state.

See Also:

Constant Field Values

INACTIVE

static final int INACTIVE

Inactive state.

See Also:

Constant Field Values

STOPPED

static final int STOPPED

Stopped state.

See Also:

Constant Field Values

RUNNING

static final int RUNNING

Running state.

See Also:

Constant Field Values

SINGLE_INSTANCE

static final int SINGLE_INSTANCE

Single instance.

See Also:

Constant Field Values

INSTANCE_PER_REQUEST

static final int INSTANCE_PER_REQUEST

Instance per request.

See Also:

Constant Field Values

POOLED_INSTANCE

static final int POOLED_INSTANCE

Pool instance

See Also:

Constant Field Values

RUN_AS_INVOKER

static final java.lang.String RUN_AS_INVOKER

Run As Configuration setting, which means the service will be run with the invoking context.

See Also:

Constant Field Values

RUN_AS_SYSTEM

static final java.lang.String RUN_AS_SYSTEM

Run As Configuration setting, which means the service will be run with the System Context.

See Also:

Constant Field Values

Method Detail

getServiceId

java.lang.String getServiceId()

Retrieves the name of the document service, which must be unique within the Service Registry.

Returns:

The name of the document service.

getMajorVersion

short getMajorVersion()

Retrieves the major version number of the document service.

Returns:

The major version number of the document service.

getMinorVersion

short getMinorVersion()

Retrieves the minor version number of the document service.

Returns:

The minor version number of the document service.

getAccessLevel

short getAccessLevel()

Retrieves the access level of the document service.

Returns:

The access level of the document service.

getDescription

java.lang.String getDescription()

Retrieves the description of the document service.

Returns:

The description of the document service.

getSmallIcon

byte[] getSmallIcon()

Retrieves the small icon representation of the document service.

Returns:

The small icon representation of the document service.

getLargeIcon

byte[] getLargeIcon()

Retrieves the large icon representation of the document service.

Returns:

The large icon representation of the document service.

getState

int getState()

Retrieves the current state of the document service.

Returns:

The current state of the document service (UNKNOWN, STOPPED, or RUNNING).

getComponentId

java.lang.String getComponentId()

Retrieves the identifier of the component with which this service is invoked.

Returns:

The identifier of the component with which this service is invoked.

getComponentVersion

java.lang.String getComponentVersion()

Retrieves the version of the component with which this service is interpreted.

Returns:

The version of the component with which this service is interpreted.

getStartWithComponent

boolean getStartWithComponent()

Determines whether this service should automatically start after its related component starts.

Returns:

true if this service should automatically start after its related component starts, false otherwise.

getAttributes

java.util.Map getAttributes()

Retrieves a map of attributes that are interpreted by and specific to the component from which this document service was deployed.

Returns:

A map of attributes that are interpreted by and specific to the component from which this document service was deployed.

getConfigParameter

ConfigParameter getConfigParameter(java.lang.String aName)
                                   throws ConfigParameterNotFoundException

Retrieves the configuration parameter with the specified name. If the configuration parameter does not exist, an exception is thrown.

Parameters:

aName - The name of the configuration parameter.

Returns:

The configuration parameter.

Throws:

{@link - com.adobe.idp.dsc.registry.ConfigParameterNotFoundException ConfigParameterNotFoundException} when a component does not exist.

ConfigParameterNotFoundException

getConfigParameters

ConfigParameter[] getConfigParameters()

Retrieves all of the configuration parameters defined for this document service.

Returns:

An array of all the configuration parameters.

getOperation

Operation getOperation(java.lang.String aName)
                       throws OperationNotFoundException

Retrieves an Operation by name if it exists for this document service. Otherwise an exception is thrown.

Parameters:

aName - The name of the operation.

Returns:

The operation with the specified name.

Throws:

{@link - com.adobe.idp.dsc.registry.OperationNotFoundException OperationNotFoundException} when an operation with the specified name does not exist for the related service.

OperationNotFoundException

getOperations

Operation[] getOperations()

Retrieves all of the operations defined for this document service.

Returns:

An array containing all the operations.

getTitle

java.lang.String getTitle()

Retrieves the title of the document service. This value is used when displaying a service.

Returns:

The title of the service.

getHint

java.lang.String getHint()

Retrieves short text that describes the purpose of the document service and is displayed within related user interfaces.

Returns:

Short text that describes the purpose of the document service.

getOrchestrateable

boolean getOrchestrateable()

Determines whether a service or any of its operations can be used within an orchestration.

Returns:

true if a service or any of its operations can be used within an orchestration, false otherwise.

getSupportedConnectorIds

java.lang.String[] getSupportedConnectorIds()

Retrieves an array of connector identifiers, specifying which connectors can be used to set up endpoints for a service.

Returns:

an array of connector identifiers (null if all are supported, an empty array if none are supported).

getDescriptor

java.lang.String getDescriptor()

Retrieves the descriptor from this service configuration, which is used to derive the signature of the service.

Returns:

The descriptor for this service.

getType

java.lang.String getType()

Retrieves the type of service configuration. This string is specified by the creator of the service configuration. null is a valid value.

Returns:

The type of service configuration.

getLockedByUser

java.lang.String getLockedByUser()

Retrieves the user who has locked this service configuration.

Returns:

The user who has locked this service configuration.

hasRunAsConfiguration

boolean hasRunAsConfiguration()

Determines whether this service has run as configuration set.

Returns:

true if this service configuration has run as, false otherwise.

getRunAsConfiguration

java.lang.String getRunAsConfiguration()

Retrieves the run as configuration for the context which to set to run this service with. If the configuration is set the valid values are:

• RUN_AS_INVOKER : The service will be run with the invoking context.
• RUN_AS_SYSTEM : The service will be run with the System Context.
• "USER OID" : The principle id(named user) to run this service with.

Returns:

The run as configuration to set the context to run the service as.

getUpdateTime

java.util.Date getUpdateTime()

Retrieves the time when this service configuration was last updated.

Returns:

The time when this service configuration was last updated.

getCreateTime

java.util.Date getCreateTime()

Retrieves the time when this service configuration was created.

Returns:

The time when this service configuration was created.

isOrchestration

boolean isOrchestration()

Deprecated. This method is deprecated because the document service container is not and should not be knowledgeable of the workflow or how any service is implemented (other than knowing which document service container will execute it). Document service containers and clients wishing to track the type of configuration or implementation should set and query the "type" property of the service configuration with a value which is meant for client purposes only and is not used by the service container itself.

Determines whether this service configuration is an orchestration.

Returns:

true if this service configuration is an orchestration, false otherwise.

isActive

boolean isActive()

Determines whether this service configuration is active.

Returns:

true if this service configuration is active, false otherwise.

isRunning

boolean isRunning()

Determines whether this service configuration is running.

Returns:

true if this service configuration is running, false otherwise.

isStopped

boolean isStopped()

Determines whether this service configuration is stopped.

Returns:

true if this service configuration is stopped, false otherwise.

isLocked

boolean isLocked()

Determines whether this service configuration is locked.

Returns:

true if this service configuration is locked, false otherwise.

getSpecificationIds

java.lang.String[] getSpecificationIds()

Retrieves the specification identifiers implemented by this service configuration.

Returns:

The specification identifiers implemented by this service configuration.

isMonitoringEnabled

boolean isMonitoringEnabled()

Determines whether Business Activity Montioring is requested for this service. This method only applies to long-lived orchestrations.

Returns:

true if Business Activity Montioring is requested for this service, false otherwise.

getRequestProcessingStrategy

int getRequestProcessingStrategy()

Retrieves the chosen request processing strategy used by the service.

Returns:

The possible values are:

• SINGLE_INSTANCE : A single instance will be used to process all service requests or invocations.
• INSTANCE_PER_REQUEST (default value): A new instance will be used to process each service request or invocation.

getPoolConfiguration

com.adobe.idp.dsc.registry.infomodel.ServicePoolConfiguration getPoolConfiguration()

Retrieves pool configuration for the service

Returns:

isAuditingEnabled

boolean isAuditingEnabled()

Determines whether execution auditing is enabled for this operations of this service configuration

Returns:

true if auditing is enabled, false otherwise