com.businessobjects.sdk.plugin.desktop.common
Interface IConfiguredService

public interface IConfiguredService

This interface provides access to the configuration information of a service that is running on a server.

Note that this information can be retrieved from the repository by querying for either the server or the service. A server query must include the SI_HOSTED_SERVICES property. A service query must include the SI_SERVICE_HOSTS property.

See Also:

IService, IServer

Method Summary

IActualConfigProperties	getActualConfigProps() Returns the configuration properties that are currently being used by the server for this service.
java.lang.Integer	getConfigError() Returns the ID of the error that resulted in the "stopped" or "starting error" state of the service status.
IConfigProperties	getConfigProps() Returns the configuration properties that will be applied to the server for this service.
java.lang.String	getCUID() Returns the CUID of the Service object.
IServiceDeploymentConfig	getDeploymentConfig() For internal use only.
IIntegerProps	getEnabledAuditEvents() Returns the IDs of the enabled audit events.
IExecProps	getExecProps() Returns the command line information that is passed to the service when the server is started.
IStringProps	getLocalFiles() Returns the names of the filesystem files that are used by the service.
java.lang.String	getLSTConfigFile() Returns the LST configuration file
IMessageInfo	getMessageInfo() Returns the message info for this configured service
java.lang.String	getPBDConfigFile() Returns the PBD configuration file
int	getServiceClass() Returns the service class.
java.lang.Integer	getServiceStatus() Deprecated. Use IConfiguredService.getServiceStatusEnum() instead
ServiceState	getServiceStatusEnum() Returns the status of the service.
int	getServiceVersion() Returns the version of the service.
java.lang.String	getType() Returns the type of the service.
boolean	isUsingServiceConfigProps() Returns whether this configured service is using the configuration property values of the associated service.
void	resetToFactoryConfigProps() Resets the configuration properties to the factory default values of the associated service.
void	resetToServiceConfigProps() Resets the configuration properties to the current values of the associated service.
void	setConfigError(int errorState) Set the ID of the error that is preventing the service from running.
void	setConfigPropsAsDefaults() Copies the configuration properties to the associated service.
void	setCUID(java.lang.String cuid) Set CUID to identify the service object associated with this IConfiguredService.
void	setServiceStatus(int status) Deprecated. Use IConfiguredService.setServiceStatusEnum(com.businessobjects.sdk.plugin.desktop.common.ServiceState) instead
void	setServiceStatusEnum(ServiceState status) Sets the status of the service.
void	setServiceVersion(int version) Sets the version of the service.
void	setType(java.lang.String type) Sets the type of the service.
void	useCustomConfigProps() Sets this configured service to use custom configuration properties instead of the configuration properties defined on the associated service.
void	useServiceConfigProps() Sets this configured service to use the configuration property values of the associated service.

Method Detail

getConfigProps

IConfigProperties getConfigProps()

Returns the configuration properties that will be applied to the server for this service. These configuration properties can be modified.

Note that some changes may not be applied immediately. As such, these values may not reflect the values that are currently being used by the server. To retrieve the current configuration property values, use IConfiguredService.getActualConfigProps().

Returns:

Configuration properties to be used by the server for the service.

getActualConfigProps

IActualConfigProperties getActualConfigProps()

Returns the configuration properties that are currently being used by the server for this service. These configuration properties cannot be modified directly. To change the configuration properties of a configured service, use IConfiguredService.getConfigProps().

Returns:

Configuration properties being used by the server for the service.

getExecProps

IExecProps getExecProps()

Returns the command line information that is passed to the service when the server is started.

Returns:

Properties specifying the command line information.

getLocalFiles

IStringProps getLocalFiles()

Returns the names of the filesystem files that are used by the service.

Returns:

The names of the files used by the service.

getDeploymentConfig

IServiceDeploymentConfig getDeploymentConfig()

For internal use only.

getServiceStatus

java.lang.Integer getServiceStatus()

Deprecated. Use IConfiguredService.getServiceStatusEnum() instead

Returns the status of the service.

Returns:

The service status.

Since:

4.0

getServiceStatusEnum

ServiceState getServiceStatusEnum()

Returns the status of the service.

Returns:

The service status.

Since:

4.0

setServiceStatus

void setServiceStatus(int status)

Deprecated. Use IConfiguredService.setServiceStatusEnum(com.businessobjects.sdk.plugin.desktop.common.ServiceState) instead

Sets the status of the service.

Parameters:

status - The service status.

Since:

4.0

setServiceStatusEnum

void setServiceStatusEnum(ServiceState status)

Sets the status of the service.

Parameters:

status - The service status.

Since:

4.0

getConfigError

java.lang.Integer getConfigError()

Returns the ID of the error that resulted in the "stopped" or "starting error" state of the service status.

Returns:

ID of the error preventing the service from running.

setConfigError

void setConfigError(int errorState)

Set the ID of the error that is preventing the service from running.

Parameters:

errorState - The ID of the error.

getServiceVersion

int getServiceVersion()

Returns the version of the service.

Returns:

The service version.

setServiceVersion

void setServiceVersion(int version)

Sets the version of the service.

Parameters:

version - The service version.

getType

java.lang.String getType()

Returns the type of the service.

Returns:

The service type.

setType

void setType(java.lang.String type)

Sets the type of the service.

Parameters:

type - The service type.

getCUID

java.lang.String getCUID()

Returns the CUID of the Service object.

Returns:

CUID of the service.

setCUID

void setCUID(java.lang.String cuid)

Set CUID to identify the service object associated with this IConfiguredService.

Parameters:

cuid - The CUID of the service object.

getEnabledAuditEvents

IIntegerProps getEnabledAuditEvents()

Returns the IDs of the enabled audit events.

Returns:

a collection containing the IDs of the enabled audit events.

isUsingServiceConfigProps

boolean isUsingServiceConfigProps()

Returns whether this configured service is using the configuration property values of the associated service.

Returns:

true if using the configuration property values of the associated service, false otherwise.

See Also:

IConfiguredService.useServiceConfigProps()

useCustomConfigProps

void useCustomConfigProps()

Sets this configured service to use custom configuration properties instead of the configuration properties defined on the associated service.

useServiceConfigProps

void useServiceConfigProps()
                           throws SDKException

Sets this configured service to use the configuration property values of the associated service. If the configuration properties of the service are modified, those changes are automatically propagated to this configured service.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IConfiguredService.isUsingServiceConfigProps()

resetToServiceConfigProps

void resetToServiceConfigProps()
                               throws SDKException

Resets the configuration properties to the current values of the associated service.

This method has no effect if IConfiguredService.isUsingServiceConfigProps() is true.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IConfiguredService.resetToFactoryConfigProps()

resetToFactoryConfigProps

void resetToFactoryConfigProps()
                               throws SDKException

Resets the configuration properties to the factory default values of the associated service.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IConfiguredService.resetToServiceConfigProps()

setConfigPropsAsDefaults

void setConfigPropsAsDefaults()
                              throws SDKException

Copies the configuration properties to the associated service. Any other configured services that are using the configuration properties of that service will have their configuration properties set to the values of these configuration properties. This method can only be used if this configured service was retrieved from an IConfiguredServices collection that was returned by IServerBase.getHostedServices().

Throws:

SDKException - if this configured service was not did not originate from the server's hosted services. .

getMessageInfo

IMessageInfo getMessageInfo()

Returns the message info for this configured service

Returns:

the message info for this configured service, null if there is no message info

Since:

4.0

getLSTConfigFile

java.lang.String getLSTConfigFile()

Returns the LST configuration file

Returns:

getPBDConfigFile

java.lang.String getPBDConfigFile()

Returns the PBD configuration file

Returns:

getServiceClass

int getServiceClass()

Returns the service class. The possible values that can be returned are defined in the IServiceBase.ServiceClass interface.

Returns:

The service class.