com.cafesoft.core.service
Interface ServiceConfig

All Known Implementing Classes:

StandardServiceConfig

public interface ServiceConfig

Defines the interface to a Cafesoft Service configuration. This class encapsulates deployment environment specific information.

Since:

12/01/01

Method Summary

String	getId() Get the Service identifier.
String	getInitParameter(String name) Returns a String containing the value of the named initialization parameter.
String	getInitParameter(String name, String defaultValue) Returns a String containing the value of the named initialization parameter or the default value.
Iterator	getInitParameterNames() Returns the names of the Security Domains's initialization parameters as an Iterator of String objects, or an empty Iterator if the Security Domain has no initialization parameters.
ServiceContext	getServiceContext() Returns a reference to the ServiceContext in which the Service is executing.

Method Detail

getId

public String getId()

Get the Service identifier.

Returns:

the identifier for the Service.

getServiceContext

public ServiceContext getServiceContext()

Returns a reference to the ServiceContext in which the Service is executing.

Returns:

the ServiceContext

See Also:

ServiceContext

getInitParameter

public String getInitParameter(String name)

Returns a String containing the value of the named initialization parameter.

Parameters:

name - a String specifying the name of the initialization parameter.

Returns:

a String containing the value of the initialization parameter or null if the parameter does not exist.

getInitParameter

public String getInitParameter(String name,
                               String defaultValue)

Returns a String containing the value of the named initialization parameter or the default value.

Parameters:

name - a String specifying the name of the initialization parameter

defaultValue - the default value to be returned if the initialization parameter does not exist or it's value is null

Returns:

a String containing the value of the initialization parameter or null if the parameter does not exist

getInitParameterNames

public Iterator getInitParameterNames()

Returns the names of the Security Domains's initialization parameters as an Iterator of String objects, or an empty Iterator if the Security Domain has no initialization parameters.

Returns:

an Iterator of String objects containing the names of the Services's initialization parameters