com.ibm.di.fc.idml
Class IdMLConstants

java.lang.Object
  com.ibm.di.fc.idml.IdMLConstants

public class IdMLConstants
extends Object

This class contains various constants used by the IdML Components (e.g. attribute names, configuration constants, etc.).

Nested Class Summary

static class

IdMLConstants.Operations This enumeration contains the operations supported by the IDML schema.

Field Summary

static String	ARTIFACT_CI One of the artifact types supported by the IdML Components.
static String	ARTIFACT_RELATIONSHIP One of the artifact types supported by the IdML Components.
static String	ARTIFACT_SOURCE_TOKEN_ATTR This attribute contains the sourceToken attribute.
static String	BOOK_ATTR This attribute is returned by the Close IdML FC and contains either the full path to the generated IdML file or its contents (if the in-memory option is used).
static String	BOOK_NAME_ATTR This attribute is used to override the default book name set in the Components configuration panel.
static String	CDM_NAMESPACE The CDM namespace used in IdML files.
static String	ID_ATTR This attribute contains the id used when adding a CI to the IdML.
static String	IDML_NAMESPACE The IdML namespace used in IdML files.
static String	IT_REGISTRY_PREFIX A prefix used by the properties in IT_REGISTRY_PROPERTIES_FILE.
static String	IT_REGISTRY_PROPERTIES_FILE This properties file provides default values for the parameters needed to connect to an IT registry.
static String	PASSWORD_MASK A mask displayed instead of the actual password for the IT registry database.
static String	RELATIONSHIP_SOURCE_ATTR One of the mandatory attributes required when creating an IdML Relationship.
static String	RELATIONSHIP_TARGET_ATTR One of the mandatory attributes required when creating an IdML Relationship.
static String	SOURCE_CONTACT_INFO_ATTR This attribute contains the CI's source contact info.
static String	SUPERIOR_ID_ATTR This attribute contains the CI's superior ID.

Constructor Summary

IdMLConstants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_ATTR

public static final String ID_ATTR

This attribute contains the id used when adding a CI to the IdML. The 'id' is a unique (at a given IdML file) identifier given to each created CI. It is used for creating the IdML Relationships.

See Also:

Constant Field Values

SUPERIOR_ID_ATTR

public static final String SUPERIOR_ID_ATTR

This attribute contains the CI's superior ID.

See Also:

Constant Field Values

SOURCE_CONTACT_INFO_ATTR

public static final String SOURCE_CONTACT_INFO_ATTR

This attribute contains the CI's source contact info.

See Also:

Constant Field Values

ARTIFACT_SOURCE_TOKEN_ATTR

public static final String ARTIFACT_SOURCE_TOKEN_ATTR

This attribute contains the sourceToken attribute. The 'sourceToken' attribute is an unique identifier in the whole environment of the author of the IdML file (not only in the file itself). It can optionally be passed when creating a CI.

See Also:

Constant Field Values

ARTIFACT_CI

public static final String ARTIFACT_CI

One of the artifact types supported by the IdML Components. It denotes an IdML Configuration Item.

See Also:

Constant Field Values

ARTIFACT_RELATIONSHIP

public static final String ARTIFACT_RELATIONSHIP

One of the artifact types supported by the IdML Components. It denotes an IdML Relationship.

See Also:

Constant Field Values

BOOK_ATTR

public static final String BOOK_ATTR

This attribute is returned by the Close IdML FC and contains either the full path to the generated IdML file or its contents (if the in-memory option is used).

See Also:

Constant Field Values

IT_REGISTRY_PROPERTIES_FILE

public static final String IT_REGISTRY_PROPERTIES_FILE

This properties file provides default values for the parameters needed to connect to an IT registry.

See Also:

Constant Field Values

IT_REGISTRY_PREFIX

public static final String IT_REGISTRY_PREFIX

A prefix used by the properties in IT_REGISTRY_PROPERTIES_FILE.

See Also:

Constant Field Values

BOOK_NAME_ATTR

public static final String BOOK_NAME_ATTR

This attribute is used to override the default book name set in the Components configuration panel.

See Also:

Constant Field Values

RELATIONSHIP_SOURCE_ATTR

public static final String RELATIONSHIP_SOURCE_ATTR

One of the mandatory attributes required when creating an IdML Relationship. It denotes the 'source' of the relationship.

See Also:

Constant Field Values

RELATIONSHIP_TARGET_ATTR

public static final String RELATIONSHIP_TARGET_ATTR

One of the mandatory attributes required when creating an IdML Relationship. It denotes the 'target' of the relationship.

See Also:

Constant Field Values

CDM_NAMESPACE

public static final String CDM_NAMESPACE

The CDM namespace used in IdML files.

See Also:

Constant Field Values

IDML_NAMESPACE

public static final String IDML_NAMESPACE

The IdML namespace used in IdML files.

See Also:

Constant Field Values

PASSWORD_MASK

public static final String PASSWORD_MASK

A mask displayed instead of the actual password for the IT registry database.

See Also:

Constant Field Values

Constructor Detail

IdMLConstants

public IdMLConstants()