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

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

All Implemented Interfaces:

java.io.Serializable

public class ModifyServiceConfigurationInfo
extends java.lang.Object
implements java.io.Serializable

This class allows you to retrieve and set modifiable service configuration information.

See Also:

Serialized Form

Constructor Summary

ModifyServiceConfigurationInfo()
Default constuctor.

Method Summary

java.util.Map	getConfigParameters() Retrieves the configuration parameters for a service configuration.
java.lang.String	getDescriptor() Retrieves the type descriptor that will be updated for 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.
int	getRequestProcessingStrategy()
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 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.
java.lang.String	getType() Retrieves the type string that will be updated for the service configuration.
boolean	isAuditingEnabled() retrieves the auditing flag for this object.
boolean	isAuditingEnabledSet() Determines whether the auditing flag will be updated.
boolean	isConfigParametersSet() Determines whether the configuration parameters have been set for this object.
boolean	isDescriptorSet() Determines whether the type descriptor that will be updated for the service configuration has been set for this object.
boolean	isRequestProcessingStrategySet()
boolean	isRunAsConfigurationSet() Determines whether the property that determines whether this service configuration should use a run-as context when the service is invoked.
boolean	isStartWithComponentSet() Determines whether the property that determines whether this service configuration should start when the component with which it is associated is started has been set for this object.
boolean	isTypeSet() Determines whether the type string for a service configuration has been set for this object.
void	setAuditingEnabled(boolean aAuditingEnabled) set the new audit flag for the serviceconfiguration associated with this object.
void	setConfigParameterAsText(java.lang.String aName, java.lang.String aValue) Sets a configuration parameter for this object.
void	setDescriptor(java.lang.String aDescriptor) Sets the type descriptor that will be updated for 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	setRequestProcessingStrategy(int requestProcessingStrategy)
void	setRunAsConfiguration(java.lang.String aRunAsConfiguration) Set the run as configuration for the context which to set to run this service with.
void	setServiceId(java.lang.String aId) Sets the service identifier.
void	setServicePoolConfiguration(ServicePoolConfigurationInfo poolConfig)
void	setStartWithComponent(boolean aStartWithComponent) Sets whether this service configuration should start when the component with which it is associated is started.
void	setType(java.lang.String aType) Sets the type string that will be updated for the service configuration.
java.lang.String	toString() Creates a string containing the modifiable service configuration information.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyServiceConfigurationInfo

public ModifyServiceConfigurationInfo()

Default constuctor.

Method Detail

setServiceId

public void setServiceId(java.lang.String aId)

Sets the service identifier.

Parameters:

aId - The service identifier.

getServiceId

public java.lang.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 minor version for the service configuration created from this object.

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.

isStartWithComponentSet

public boolean isStartWithComponentSet()

Determines whether the property that determines whether this service configuration should start when the component with which it is associated is started has been set for this object. The Service Registry will use this value to determine whether to include this value in an update.

Returns:

true if the property has been set for this object, false otherwise.

getType

public java.lang.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(java.lang.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.

isTypeSet

public boolean isTypeSet()

Determines whether the type string for a service configuration has been set for this object.

Returns:

true if the type string for a service configuration has been set for this object, false otherwise.

getConfigParameters

public java.util.Map getConfigParameters()

Retrieves the configuration parameters for a service configuration.

Returns:

The configuration parameters for a service configuration.

isConfigParametersSet

public boolean isConfigParametersSet()

Determines whether the configuration parameters have been set for this object.

Returns:

true if the configuration parameters have been set for this object, false otherwise.

setConfigParameterAsText

public void setConfigParameterAsText(java.lang.String aName,
                                     java.lang.String aValue)

Sets a configuration parameter for this object.

Parameters:

aName - The name of the configuration parameter.

aValue - The value of the configuration parameter.

getDescriptor

public java.lang.String getDescriptor()

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

Returns:

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

setDescriptor

public void setDescriptor(java.lang.String aDescriptor)

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

Parameters:

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

isDescriptorSet

public boolean isDescriptorSet()

Determines whether the type descriptor that will be updated for the service configuration has been set for this object.

Returns:

true if the type descriptor has been set for this object, false otherwise.

isAuditingEnabled

public boolean isAuditingEnabled()

retrieves the auditing flag for this object. note that this value only has meaning if isAuditingEnabledSet() returns true

Returns:

true to enable auditing on this object, false otherwise.

setAuditingEnabled

public void setAuditingEnabled(boolean aAuditingEnabled)

set the new audit flag for the serviceconfiguration associated with this object.

Parameters:

aAuditingEnabled - true to enable auditing on this service configuration, false to disable auditing.

isAuditingEnabledSet

public boolean isAuditingEnabledSet()

Determines whether the auditing flag will be updated.

Returns:

true if the audit flag has been set for this object, false otherwise.

toString

public java.lang.String toString()

Creates a string containing the modifiable service configuration information.

Overrides:

toString in class java.lang.Object

Returns:

A string containing the modifiable service configuration information.

getServicePoolConfiguration

public ServicePoolConfigurationInfo getServicePoolConfiguration()

setServicePoolConfiguration

public void setServicePoolConfiguration(ServicePoolConfigurationInfo poolConfig)

getRequestProcessingStrategy

public int getRequestProcessingStrategy()

setRequestProcessingStrategy

public void setRequestProcessingStrategy(int requestProcessingStrategy)

isRequestProcessingStrategySet

public boolean isRequestProcessingStrategySet()

getRunAsConfiguration

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

setRunAsConfiguration

public void setRunAsConfiguration(java.lang.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

isRunAsConfigurationSet

public boolean isRunAsConfigurationSet()

Determines whether the property that determines whether this service configuration should use a run-as context when the service is invoked. The Service Registry will use this value to determine whether to include this value in an update.

Returns:

true if the property has been set for this object, false otherwise.