com.adobe.idp.dsc.registry.service
Class CreateServiceConfigurationInfo

java.lang.Object
  com.adobe.idp.dsc.registry.service.CreateServiceConfigurationInfo

All Implemented Interfaces:

Serializable

public class CreateServiceConfigurationInfo
extends Object
implements Serializable

This class allows you to retrieve and set the information related to a service configuration.

See Also:

Serialized Form

Constructor Summary

CreateServiceConfigurationInfo()
Default constructor.

Method Summary

String	getCategoryId() Retrieves the category identifier to that will be used to create a service object, if one is needed.
String	getComponentId() Retrieves the identifier of the component that will be used to invoke the related service configuration.
String	getComponentVersion() Retrieves the version of the component that will be used to invoke the related service configuration.
String	getDescriptor() Retrieves the descriptor that defines the service configuration.
int	getMajorVersion() Retrieves the major version for the service configuration created from this object.
int	getMinorVersion() Retrieves the minor version for the service configuration created from this object.
String	getRunAsConfiguration() Retrieves the run as configuration for the context which to set to run this service with.
String	getServiceId() Retrieves the service identifier of the service configuration that references an existing service object.
ServicePoolConfigurationInfo	getServicePoolConfiguration()
boolean	getStartWithComponent() Determines whether this service configuration should start when the component with which it is associated is started.
String	getType() Retrieves the type string that will be updated for the service configuration.
void	setCategoryId(String aId) Sets the category identifier to that will be used to create a service object, if one is needed.
void	setComponentId(String aId) Sets the identifier of the component that will be used to invoke the related service configuration.
void	setComponentVersion(String aVersion) Sets the version of the component that will be used to invoke the related service configuration.
void	setDescriptor(String aDescriptor) Sets the descriptor that defines the service configuration.
void	setMajorVersion(int aVersion) Sets the major version for the service configuration created from this object.
void	setMinorVersion(int aVersion) Sets the minor version for the service configuration created from this object.
void	setRunAsConfiguration(String aRunAsConfiguration) Set the run as configuration for the context which to set to run this service with.
void	setServiceId(String aId) Sets the service identifier of the service configuration to be created.
void	setServicePoolConfigurationInfo(ServicePoolConfigurationInfo poolConfigInfo)
void	setStartWithComponent(boolean aStartWithComponent) Sets whether this service configuration should start when the component with which it is associated is started.
void	setType(String aType) Sets the type string that will be updated for the service configuration.
String	toString() Creates a string containing the service configuration information.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateServiceConfigurationInfo

public CreateServiceConfigurationInfo()

Default constructor.

Method Detail

setServiceId

public void setServiceId(String aId)

Sets the service identifier of the service configuration to be created.

Parameters:

aId - A service identifier referencing an existing service object.

getServiceId

public String getServiceId()

Retrieves the service identifier of the service configuration that references an existing service object.

Returns:

The service identifier of the service configuration that references an existing service object.

setMajorVersion

public void setMajorVersion(int aVersion)

Sets the major version for the service configuration created from this object.

Parameters:

aVersion - The major version for the service configuration created from this object.

getMajorVersion

public int getMajorVersion()

Retrieves the major version for the service configuration created from this object.

Returns:

The major version for the service configuration created from this object.

setMinorVersion

public void setMinorVersion(int aVersion)

Sets the minor version for the service configuration created from this object.

Parameters:

aVersion - The minor version for the service configuration created from this object.

getMinorVersion

public int getMinorVersion()

Retrieves the minor version for the service configuration created from this object.

Returns:

The major minor for the service configuration created from this object.

setComponentId

public void setComponentId(String aId)

Sets the identifier of the component that will be used to invoke the related service configuration.

Parameters:

aId - The identifier of the component that will be used to invoke the related service configuration.

getComponentId

public String getComponentId()

Retrieves the identifier of the component that will be used to invoke the related service configuration.

Returns:

The identifier of the component that will be used to invoke the related service configuration.

setComponentVersion

public void setComponentVersion(String aVersion)

Sets the version of the component that will be used to invoke the related service configuration.

Parameters:

aVersion - The version of the component that will be used to invoke the related service configuration.

getComponentVersion

public String getComponentVersion()

Retrieves the version of the component that will be used to invoke the related service configuration.

Returns:

The version of the component that will be used to invoke the related service configuration.

setCategoryId

public void setCategoryId(String aId)

Sets the category identifier to that will be used to create a service object, if one is needed.

Parameters:

aId - The service category identifier.

getCategoryId

public String getCategoryId()

Retrieves the category identifier to that will be used to create a service object, if one is needed.

Returns:

The service category identifier.

setDescriptor

public void setDescriptor(String aDescriptor)

Sets the descriptor that defines the service configuration.

Parameters:

aDescriptor - Text that defines the underlying service and operations to be invoked.

getDescriptor

public String getDescriptor()

Retrieves the descriptor that defines the service configuration.

Returns:

Text that defines the underlying service and operations to be invoked.

getStartWithComponent

public boolean getStartWithComponent()

Determines whether this service configuration should start when the component with which it is associated is started.

Returns:

true if this service configuration should start when the component with which it is associated is started, false otherwise.

setStartWithComponent

public void setStartWithComponent(boolean aStartWithComponent)

Sets whether this service configuration should start when the component with which it is associated is started.

Parameters:

aStartWithComponent - true if this service configuration should start when the component with which it is associated is started, false otherwise.

getType

public String getType()

Retrieves the type string that will be updated for the service configuration.

Returns:

The type string that will be updated for the service configuration.

setType

public void setType(String aType)

Sets the type string that will be updated for the service configuration.

Parameters:

aType - The type string that will be updated for the service configuration. This value can be null.

getServicePoolConfiguration

public ServicePoolConfigurationInfo getServicePoolConfiguration()

setServicePoolConfigurationInfo

public void setServicePoolConfigurationInfo(ServicePoolConfigurationInfo poolConfigInfo)

getRunAsConfiguration

public 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.

setRunAsConfiguration

public void setRunAsConfiguration(String aRunAsConfiguration)

Set 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.

Parameters:

aRunAsConfiguration - The run as configuration

toString

public String toString()

Creates a string containing the service configuration information.

Overrides:

toString in class Object

Returns:

A string containing the service configuration information.