com.webct.platform.coreservice.deployablecomponents.lib
Interface DCConstants

public interface DCConstants

Common attributes to all deployable components. Each deployable component is required to specify a version, id, type, classname, author, description and settings group name in its deployment descriptor file DeployableComponentConfig.xml. Once the component is loaded, most of these values are displayed in the SMS setting screen under the settings group created for the component. Some information is also added to the Deployable Component Service SMS group which acts as a registry for deployable components.

Field Summary

static java.lang.String	AUTHOR The author of the component.
static java.lang.String	CLASSNAME The fully qualified classname of the class that extends either indirectly or directly the BaseDeployableComponent class.
static java.lang.String	DC_TYPE_AUTHENTICATION_MODULE The Authentication Module type of deployable component
static java.lang.String	DC_TYPE_SSO The Translation Adapter type of deployable component
static java.lang.String	DC_TYPE_TRANSLATION_ADAPTER The Translation Adapter type of deployable component
static java.lang.String	DEFAULT_VERSION_OF_BASE_DEPLOYABLE_COMPONENT The dedault version of the BaseDeployableComponent class in case of can not find powerlinks-version element from DC descriptor
static java.lang.String	DESCRIPTION A description of the component.
static java.lang.String	ENABLED An 'Enabled' toggle will be added to each deployable component.
static java.lang.String	ID The id of the component.
static java.lang.String	JARFILENAME The JAR file name of the component.
static java.lang.String	SETTINGSGROUPNAME The name of the settings group to which many of these settings will be added.
static java.lang.String	TYPE The type of the deployable component.
static java.lang.String	VERSION The version of the component.
static java.lang.String	VERSION_OF_POWERLINKS The version of the BaseDeployableComponent class.

Field Detail

VERSION

static final java.lang.String VERSION

Description copied from interface: DCConstants

The version of the component. This should be incremented each time a new version is released.

See Also:

Constant Field Values

VERSION_OF_POWERLINKS

static final java.lang.String VERSION_OF_POWERLINKS

Description copied from interface: DCConstants

The version of the BaseDeployableComponent class. This should be the class extended by custom deployable component.

See Also:

Constant Field Values

ID

static final java.lang.String ID

Description copied from interface: DCConstants

The id of the component. This value must be unique amongst all deployable components.

See Also:

Constant Field Values

TYPE

static final java.lang.String TYPE

Description copied from interface: DCConstants

The type of the deployable component. For example "sso" or "siapi".

See Also:

Constant Field Values

CLASSNAME

static final java.lang.String CLASSNAME

Description copied from interface: DCConstants

The fully qualified classname of the class that extends either indirectly or directly the BaseDeployableComponent class. Used by the classloader to load the component.

See Also:

Constant Field Values

AUTHOR

static final java.lang.String AUTHOR

Description copied from interface: DCConstants

The author of the component.

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

Description copied from interface: DCConstants

A description of the component. This is displayed in the about.jsp page as well as in the SMS screen

See Also:

Constant Field Values

JARFILENAME

static final java.lang.String JARFILENAME

Description copied from interface: DCConstants

The JAR file name of the component. This is derived from the actual file name.

See Also:

Constant Field Values

SETTINGSGROUPNAME

static final java.lang.String SETTINGSGROUPNAME

Description copied from interface: DCConstants

The name of the settings group to which many of these settings will be added.

See Also:

Constant Field Values

ENABLED

static final java.lang.String ENABLED

Description copied from interface: DCConstants

An 'Enabled' toggle will be added to each deployable component. It will be initially set to false and will be locked at the server administrator level.

See Also:

Constant Field Values

DEFAULT_VERSION_OF_BASE_DEPLOYABLE_COMPONENT

static final java.lang.String DEFAULT_VERSION_OF_BASE_DEPLOYABLE_COMPONENT

Description copied from interface: DCConstants

The dedault version of the BaseDeployableComponent class in case of can not find powerlinks-version element from DC descriptor

See Also:

Constant Field Values

DC_TYPE_TRANSLATION_ADAPTER

static final java.lang.String DC_TYPE_TRANSLATION_ADAPTER

Description copied from interface: DCConstants

The Translation Adapter type of deployable component

See Also:

Constant Field Values

DC_TYPE_AUTHENTICATION_MODULE

static final java.lang.String DC_TYPE_AUTHENTICATION_MODULE

Description copied from interface: DCConstants

The Authentication Module type of deployable component

See Also:

Constant Field Values

DC_TYPE_SSO

static final java.lang.String DC_TYPE_SSO

Description copied from interface: DCConstants

The Translation Adapter type of deployable component

See Also:

Constant Field Values