com.ca.commons.datamodel
Class MetaDataDefs

java.lang.Object
  com.ca.commons.datamodel.MetaDataDefs

Direct Known Subclasses:

DataModelUtil

public class MetaDataDefs
extends Object

Defines all datamodel constants, property names and usage information.

Nested Class Summary

static class	MetaDataDefs.AssocType
static class	MetaDataDefs.EncryptAlgorithms Specifies supported encryption algorithms.
static class	MetaDataDefs.FlattenStyle Possible values for MD_FLATTEN_STYLE.
static class	MetaDataDefs.ForceCaseValue Allowed values for MD_FORCE_CASE.
static class	MetaDataDefs.ForceModModeValue Possible values for MD_FORCE_MOD_MODE.
static class	MetaDataDefs.GeneratedOverrideStatus Specifies what to do when client provides values for generated columns in an LDAP ADD request.
static class	MetaDataDefs.NormalizeConnValue Possible values for MD_NORMALIZE_CONN_VALUE.
static class	MetaDataDefs.NormalizeConnValueStyle Possible values for MD_NORMALIZE_CONN_VALUE_STYLE.
static class	MetaDataDefs.RegexStyle

Field Summary

static String	CUSTOM Attributes containing this string in their names are logged less noisily.
static String	MAP_TO_CONNECTOR_VALUE
static String	MD_ABBREVIATION
static String	MD_ACCOUNT_CLASS Deprecated.
static String	MD_ACCOUNT_TEMPLATE_CLASS Deprecated.
static String	MD_ASSOC_OBJ_KEY_ATTR
static String	MD_ASSOC_REF_KEY_ATTR
static String	MD_ASSOC_REF_OBJECT_CLASS Defines a relationship from an obj type to a referenced obj type, where direct association via an attribute and indirect association via a table external to both object types are supported.
static String	MD_ASSOC_REVERSE_ATTR
static String	MD_ASSOC_TABLE
static String	MD_ASSOC_TABLE_OBJ_COLUMN
static String	MD_ASSOC_TABLE_REF_COLUMN
static String	MD_ASSOC_TYPE
static String	MD_BEAN_PROPERTY_NAME
static String	MD_BOOL_VALUES
static String	MD_CHILD_TYPES
static String	MD_COLLECTIONCONTENTS
static String	MD_COMPOUND_FORMAT
static String	MD_CONN_GENERATED_OVERRIDE
static String	MD_CONN_GENERATOR
static String	MD_CONN_MAP_ALIAS Which name to map an class (including the connector itself) or attribute to in connector-speak, in circumstances where MD_CONN_MAP_TO needs to be mapped to a complicated expression and therefore doesn't act as a useful reference name in the connector's code (refer to LDA which has ambiguous mappings for many classes/properties or ORA and SQL JDBC-based connectors which set MD_CONN_MAP_TO=[some complicated SQL SELECT statement] and MD_CONN_MAP_ALIAS=account).
static String	MD_CONN_MAP_TO
static String	MD_CONN_MAP_TO_AMBIGUOUS For the (hopefully rare) cases where a single LDAP attribute ambiguously maps to more the one connector class / property.
static String	MD_CONN_MAP_TO_AMBIGUOUS_CHOICE_ATTR Attributes with ambiguous mappings can optionally name another LDAP attribute which will be used to pass in an explicit choice when new instances of the objectclass are add()ed.
static String	MD_CONN_MAP_TO_AUX Identifies all auxiliary classes by name to which mappings are present.
static String	MD_CONN_MAP_TO_DERIVED Identifies all structural classes by name to which mappings are present along with any classes that each of them derives from.
static String	MD_CONN_MAP_TO_LANG
static String	MD_CONN_MAP_TO_LAX This boolean can appear on any class which has MD_CONN_MAP_TO specified for it to signify that MD_CONN_MAP_TO mappings are "lax", which means any attributes on such classes which aren't explicitly mapped will keep their original names.
static String	MD_CONN_MAP_TO_MULTIPLE For use in cases where a single LDAP class or attribute needs to be split into and/or composed from the values of multiple connector-speak attributes, in which case this setting lists these multiple connector-speak classes / attributes.
static String	MD_CONN_MAP_TO_SAME This boolean can appear on an class which does not have MD_CONN_MAP_TO specified for it to signify that all properties defined for it will use their LDAP names literally as their connector-speak names.
static String	MD_CONN_MAP_TO_STRICT Value Type: boolValue Target Object(s): ANY naming property in datamodel Description: Causes framework to augment objectclass filters to include explicit check for existence of a particular connector-speak naming attribute.
static String	MD_CONN_SEARCH_CONTAINER
static String	MD_CONNECTOR_XML
static String	MD_CONVERT_REGEX Where the same regular expression is used in a number of places a better approach would be to define a FLEXI_STR:myType type and tie this type to a RegexAttributeConverter via your connector's conf/connector.xml file.
static String	MD_CONVERT_REGEX_FROM_CONN
static String	MD_CONVERT_REGEX_STYLE
static String	MD_CONVERTER_CLASS
static String	MD_DATE_FORMAT
static String	MD_DATE_STRIP_FRACTIONAL
static String	MD_DATE_STRIP_TZ
static String	MD_DEFAULT_POLICY_VALUE
static String	MD_DEFAULT_VALUE Deprecated.
static String	MD_DEREGISTER Reserved metadata property name used to deregister validator / converter plug-ins when a connector needs to remove a default plug-in registered in server_jcs.xml (refer to comment and usage in SDK connector's conf/connector.xml).
static String	MD_DISPLAY_EDITABLE
static String	MD_DISPLAY_NAME
static String	MD_DISPLAY_TYPE
static String	MD_DN_BASE_ATTRIBUTE
static String	MD_DN_LDAP_OBJECT_CLASS
static String	MD_DN_LDAP_OBJECT_CLASSES
static String	MD_DN_NAME_ONLY
static String	MD_DN_NAME_ONLY_LDAP_OBJECTCLASS Value Type:strValue Target Object(s): ANY property that has MD_DN_LDAP_OBJECT_CLASSES in datamodel Description: When multiple objectclass references can exist in an associative collection this setting can nominate which one of the objectclasses is to be treated as MD_DN_NAME_ONLY.
static String	MD_DN_TEST_EXISTS
static String	MD_DN_TYPE Occurs as "type" value for FlexiStr values used to represent Distinguished Names (DNs) - "FLEXI_STR:DN".
static String	MD_DONT_PREFIX_ALGORITHM
static String	MD_EDIT_VERSION Deprecated.
static String	MD_ENCRYPT_ALG
static String	MD_ENDPOINT_CLASS Deprecated.
static String	MD_ETA_DATE_TIME_TIMEZONE
static String	MD_FLATTEN_STYLE Refer to classes deriving from MultiValuePropertyFlattener).
static String	MD_FORCE_CASE Refer to MetaDataDefs.ForceCaseValue.
static String	MD_FORCE_MOD_MODE
static String	MD_FORCE_PAGED_RESULTS
static String	MD_GROUP_CLASS Deprecated.
static String	MD_GROUP_CONTENTS
static String	MD_GROUP_MAPPINGS
static String	MD_IMPL_VERSION "1" or not present: JCS 1.0 state "2": childTypes now name explicit classes rather than "Container", "NativeGroup" etc.
static String	MD_IMPLEMENTATION_BUNDLE Matches name of one of the ImplBundle beans created from the conf/connector.xml files read from all the jcs-connector-*.jar files matching each connector implementation on the classpath.
static String	MD_IS_CAPABILITY
static String	MD_IS_CASE_SENSITIVE
static String	MD_IS_COMPOUND_VALUE
static String	MD_IS_CONN_GENERATED
static String	MD_IS_CONNECTION_ATTR
static String	MD_IS_CONNECTOR_FILTERABLE Filters supplied to the connector will have references to this attribute removed.
static String	MD_IS_CONNECTOR_SIBLING
static String	MD_IS_CONTAINER
static String	MD_IS_COPYABLE
static String	MD_IS_CREATABLE
static String	MD_IS_DELETABLE
static String	MD_IS_DN_ABSOLUTE
static String	MD_IS_DYNAMIC
static String	MD_IS_ENCRYPTED
static String	MD_IS_ETA_DATE_TIME
static String	MD_IS_EXPENSIVE
static String	MD_IS_HIDDEN
static String	MD_IS_HIERARCHICAL
static String	MD_IS_IMPLEMENTED_AS_ASSOC
static String	MD_IS_INCLUSION_BASED
static String	MD_IS_INTERESTING_TO_COMPLIANCE
static String	MD_IS_JAVA_OBJECT
static String	MD_IS_JIAM_INTERNAL
static String	MD_IS_LAX
static String	MD_IS_LOGGING_ATTR
static String	MD_IS_MOVEABLE
static String	MD_IS_MULTI_VALUED
static String	MD_IS_NAMING Value Type: boolValue Target Object(s): ANY property in datamodel Default: false Description: Designates that the target property to which it is attached acts as the naming attribute for the objectclass which contains it.
static String	MD_IS_NATIVE_DN_TYPE
static String	MD_IS_NESTED
static String	MD_IS_NESTED_ALL
static String	MD_IS_NON_STD
static String	MD_IS_OBFUSCATED
static String	MD_IS_OPERATIONAL_ATTR
static String	MD_IS_POLICY_SYNC
static String	MD_IS_READ_ONLY
static String	MD_IS_READ_ONLY_NATIVE
static String	MD_IS_RENAMABLE
static String	MD_IS_RENAME_VIA_DELETE_ADD
static String	MD_IS_REQUIRED
static String	MD_IS_REQUIRED_AMBIGUOUS
static String	MD_IS_REQUIRED_NATIVE
static String	MD_IS_SEARCHABLE
static String	MD_IS_SESSION_REQUIRED
static String	MD_IS_SINGLE_NAMING_VALUE Handle cases like multiple cn= values for JNDI-based connectors which upset the Identity Manager Provisioning Server.
static String	MD_IS_STATIC
static String	MD_IS_STATIC_EXTENSIBLE
static String	MD_IS_STORE_CODE
static String	MD_IS_STORE_NAME
static String	MD_IS_STORE_NUMERIC
static String	MD_IS_STORE_SYMBOLIC
static String	MD_IS_STRING_ARRAY
static String	MD_IS_TRANSACTIONS_ENABLED
static String	MD_IS_TRIM_REQUIRED
static String	MD_IS_UNMANAGED
static String	MD_IS_VIRTUAL Note currently used for associations but may see wider use in future.
static String	MD_IS_WELL_KNOWN
static String	MD_IS_WINDOWS_FILE_TIME
static String	MD_IS_WRITE_ONLY
static String	MD_IS_XML_ENCODED_VALUE
static String	MD_JAVA_SRCCLASS
static String	MD_JIAM_OBJECT_TYPE
static String	MD_LINE_SEPARATOR
static String	MD_MAX_LENGTH
static String	MD_MAX_LENGTH_NATIVE
static String	MD_MAX_VALUE
static String	MD_MIN_LENGTH
static String	MD_MIN_VALUE
static String	MD_NESTED_BASE_ATTRIBUTE
static String	MD_NORMALIZE_CONN_VALUE Drives connector side value normalizations by allowing normalization to be enabled and normalization mode to be set, primarily applicable to associative/DN type properties whose values can be compared in associative processors.
static String	MD_NORMALIZE_CONN_VALUE_STYLE Drives connector side value normalizations by allowing normalization style to be defined
static String	MD_NUMBER_PROPERTY_COUNTRY
static String	MD_NUMBER_PROPERTY_MAX_FRACTION_DIGITS
static String	MD_NUMBER_PROPERTY_MAX_INTEGER_DIGITS
static String	MD_NUMBER_PROPERTY_MIN_FRACTION_DIGITS
static String	MD_NUMBER_PROPERTY_MIN_INTEGER_DIGITS
static String	MD_NUMBER_PROPERTY_USE_GROUPING
static String	MD_NUMERIC_FROM_BASE
static String	MD_NUMERIC_PREFIX
static String	MD_NUMERIC_TO_BASE
static String	MD_PAD_LENGTH Deprecated.
static String	MD_PAD_PREFIX
static String	MD_PAD_SUFFIX
static String	MD_POLICY_CLASS Deprecated.
static String	MD_PROJECT_NAME
static String	MD_QUOTE_STRING
static String	MD_REF_OBJECT_TYPE Deprecated. Use MD_ASSOC_REF_OBJECT_CLASS instead.
static String	MD_REGEX_DESCR
static String	MD_RELEASE
static String	MD_REQUIRES_LOOKUP_RETRIEVAL
static String	MD_SORT_ORDER_HINT
static String	MD_SUPER_CLASS Deprecated.
static String	MD_UI_SIZE
static String	MD_UNSET_VALUE
static String	MD_USE_LIST_RELATIONSHIPS_INSTEAD
static String	MD_USE_SPECIAL_NULL_VALUE
static String	MD_VALID_REGEX Where the same regular expression is used in a number of places a better approach would be to define a FLEXI_STR:myType type and tie this type to a RegexAttributeValidator via your connector's conf/connector.xml file.
static String	MD_VALID_REGEX_STYLE
static String	MD_VALIDATOR_CLASS
static String	MD_VALUE_MATCH_EXPR For instance to match members identified via nisNetgroupTriple this filter would be: "(|(nisNetGroupTriple=\28*,${name},*\29)(nisNetGroupTriple=\28*,,*\29))"
static String	MD_VALUE_TEMPLATE
static String	MD_VENDOR
static String	MD_VENDOR_FLAGS
static String	MD_VERSION
static String	MD_WRITABLE_BY Note setting to "ADD" is similar to MD_IS_READ_ONLY except that the latter throws an error whereas this setting simply throws away attempts to modify the property using the prohibited "ADD" or "MODIFY".
static String	MD_XML_CONTAINER_NAME
static String	MD_XML_NODE_NAME

Constructor Summary

MetaDataDefs()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

MD_VERSION

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Specify the version for the endpoint type.",
               interestedModules=CORE)
public static final String MD_VERSION

See Also:

Constant Field Values

MD_VENDOR

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Specify the vendor for the endpoint type, where this can\'t be discovered accurately",
               interestedModules=CORE)
public static final String MD_VENDOR

See Also:

Constant Field Values

MD_VENDOR_FLAGS

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Specify any specialized settings for a vendor where required, suggested format key1=value1; key2=value2.",
               interestedModules=CORE)
public static final String MD_VENDOR_FLAGS

See Also:

Constant Field Values

MD_FORCE_PAGED_RESULTS

@MetaDataUsage(dataType=BOOL,
               target=ENDPOINT_TYPE,
               description="Specify whether paged search should be forced to be used for the (JNDI) endpoint type .",
               interestedModules=CORE)
public static final String MD_FORCE_PAGED_RESULTS

See Also:

Constant Field Values

MD_IMPL_VERSION

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Specifies metadata semantics, and can be used as a migration trigger.",
               interestedModules=CORE)
public static final String MD_IMPL_VERSION

"1" or not present: JCS 1.0 state "2": childTypes now name explicit classes rather than "Container", "NativeGroup" etc. Virtual container format changes (previously were defined in connector.xml rather than metadata for JDBC).

See Also:

Constant Field Values

MD_RELEASE

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Specify the release to which a file belongs, as a hint to help sustaining etc (not to be used as a migration trigger).",
               interestedModules=CORE)
public static final String MD_RELEASE

See Also:

Constant Field Values

MD_SUPER_CLASS

@Deprecated
@MetaDataUsage(dataType=STR,
               target=CLASS,
               description="Super class for a datamodel class (why doesn\'t \"extends\" work?)",
               interestedModules=CORE)
public static final String MD_SUPER_CLASS

Deprecated.

See Also:

Constant Field Values

MD_JAVA_SRCCLASS

@MetaDataUsage(dataType=STR,
               target=CLASS,
               description="Name of Java class bound to datamodel class ?lachlan?",
               interestedModules=JIAM,
               status=NOT_EDITABLE_BY_END_USER)
public static final String MD_JAVA_SRCCLASS

See Also:

Constant Field Values

MD_COLLECTIONCONTENTS

@MetaDataUsage(dataType=STR,
               target=CLASS,
               description="?lachlan? Could this be expressed using same syntax as used for dataType=...",
               interestedModules=JIAM,
               status=NOT_EDITABLE_BY_END_USER)
public static final String MD_COLLECTIONCONTENTS

See Also:

Constant Field Values

MD_IS_SESSION_REQUIRED

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="?lachlan? is this for JIAM or IM?",
               interestedModules=JIAM)
public static final String MD_IS_SESSION_REQUIRED

See Also:

Constant Field Values

MD_USE_LIST_RELATIONSHIPS_INSTEAD

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="?lachlan? is this for JIAM or IM?",
               interestedModules=JIAM)
public static final String MD_USE_LIST_RELATIONSHIPS_INSTEAD

See Also:

Constant Field Values

MD_IS_SEARCHABLE

@MetaDataUsage(dataType=BOOL,
               target={CLASS,PROPERTY},
               description="?lachlan? Does this apply to both targets, should JCS be looking at it (does IM) etc",
               interestedModules=JIAM)
public static final String MD_IS_SEARCHABLE

See Also:

Constant Field Values

MD_BEAN_PROPERTY_NAME

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies the name of the JavaBean property to be used for a property by JIAM",
               interestedModules={CONXP,JIAM})
public static final String MD_BEAN_PROPERTY_NAME

See Also:

Constant Field Values

MD_IS_REQUIRED_NATIVE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="When true flags that the native endpoint itself considers the ${MD_CONN_MAP_TO} value for the target property to be mandatory.",
               status=NOT_EDITABLE_BY_END_USER,
               interestedModules={CONXP,JCS})
public static final String MD_IS_REQUIRED_NATIVE

See Also:

Constant Field Values

MD_IS_NATIVE_DN_TYPE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="When true flags that the native endpoint itself considers the ${MD_CONN_MAP_TO} value for the target property to be a Distinguished Name.",
               status=NOT_EDITABLE_BY_END_USER,
               interestedModules={CONXP,JCS})
public static final String MD_IS_NATIVE_DN_TYPE

See Also:

Constant Field Values

MD_MAX_LENGTH_NATIVE

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="When provided specifies the maximum length imposed by native endpoint itself on the ${MD_CONN_MAP_TO} value for the target property.",
               status=NOT_EDITABLE_BY_END_USER,
               interestedModules={CONXP,JCS})
public static final String MD_MAX_LENGTH_NATIVE

See Also:

Constant Field Values

MD_CONNECTOR_XML

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Contains dynamic version of connector.xml configuration to be used for all connectors on this namespace.",
               interestedModules={JCS,CONXP})
public static final String MD_CONNECTOR_XML

See Also:

Constant Field Values

MD_ACCOUNT_CLASS

@Deprecated
public static final String MD_ACCOUNT_CLASS

Deprecated.

See Also:

Constant Field Values

MD_GROUP_CLASS

@Deprecated
public static final String MD_GROUP_CLASS

Deprecated.

See Also:

Constant Field Values

MD_POLICY_CLASS

@Deprecated
public static final String MD_POLICY_CLASS

Deprecated.

See Also:

Constant Field Values

MD_ENDPOINT_CLASS

@Deprecated
public static final String MD_ENDPOINT_CLASS

Deprecated.

See Also:

Constant Field Values

MD_ACCOUNT_TEMPLATE_CLASS

@Deprecated
public static final String MD_ACCOUNT_TEMPLATE_CLASS

Deprecated.

See Also:

Constant Field Values

MD_GROUP_MAPPINGS

public static final String MD_GROUP_MAPPINGS

See Also:

Constant Field Values

MD_GROUP_CONTENTS

public static final String MD_GROUP_CONTENTS

See Also:

Constant Field Values

MD_DEFAULT_POLICY_VALUE

public static final String MD_DEFAULT_POLICY_VALUE

See Also:

Constant Field Values

MD_DEFAULT_VALUE

@Deprecated
@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Default value (prior to IM r12.1).",
               interestedModules=CONXP)
public static final String MD_DEFAULT_VALUE

Deprecated.

See Also:

Constant Field Values

MD_CONN_SEARCH_CONTAINER

@MetaDataUsage(dataType=STR,
               target=CLASS,
               description="Set to a connector level DN which constraints all objects of the target class to the defined search base container",
               defaultValue="",
               interestedModules=CORE)
public static final String MD_CONN_SEARCH_CONTAINER

See Also:

Constant Field Values

MD_IS_POLICY_SYNC

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               targetParent=ACCOUNT_CLASS,
               description="Whether this attribute should be updated when this account is synchronized with its templates.",
               interestedModules=IMPS)
public static final String MD_IS_POLICY_SYNC

See Also:

Constant Field Values

MD_IS_WELL_KNOWN

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               targetParent=ACCOUNT_CLASS,
               description="Whether this property is recognized as a member of the common set.",
               interestedModules={CONXP,GUI_CLIENT})
public static final String MD_IS_WELL_KNOWN

See Also:

Constant Field Values

MD_EDIT_VERSION

@Deprecated
public static final String MD_EDIT_VERSION

Deprecated.

See Also:

Constant Field Values

MD_UI_SIZE

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="The recommended visible character length of a text input field for this attribute\'s value.",
               interestedModules={CONXP,GUI_CLIENT})
public static final String MD_UI_SIZE

See Also:

Constant Field Values

MD_LINE_SEPARATOR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Defines a string spanning multiple lines, delimited by the set character sequence.",
               interestedModules={CONXP,GUI_CLIENT})
public static final String MD_LINE_SEPARATOR

See Also:

Constant Field Values

CUSTOM

public static final String CUSTOM

Attributes containing this string in their names are logged less noisily.

See Also:

Constant Field Values

MAP_TO_CONNECTOR_VALUE

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_CLASS,
               description="Connector class (aka Endpoint) itself has ${MD_CONN_MAP_TO}= this value, so it can be identified.",
               interestedModules=JCS)
public static final String MAP_TO_CONNECTOR_VALUE

See Also:

Constant Field Values

MD_IS_CONNECTION_ATTR

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               targetParent=ENDPOINT_CLASS,
               defaultValue="false",
               description="Distinguishes connection-related attributes on the Connector.",
               interestedModules={JCS,CONXP})
public static final String MD_IS_CONNECTION_ATTR

See Also:

Constant Field Values

MD_IS_LOGGING_ATTR

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               targetParent=ENDPOINT_CLASS,
               description="Distinguishes logging-related attributes on the Connector, to assist UI clients like DYN IMPM plug-in that need to be able to distinguish them.",
               interestedModules=JCS)
public static final String MD_IS_LOGGING_ATTR

See Also:

Constant Field Values

MD_IS_CONTAINER

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="Distinguishes containers from other objectclasses.",
               interestedModules=CORE,
               status=DEPRECATED)
public static final String MD_IS_CONTAINER

See Also:

Constant Field Values

MD_CHILD_TYPES

@MetaDataUsage(dataType=SET,
               target=CLASS,
               description="Specifies classes which can be children of target container class.",
               interestedModules=CORE)
public static final String MD_CHILD_TYPES

See Also:

Constant Field Values

MD_IS_CREATABLE

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="If present and false, then object can\'t be created (ie it is not user-manageable).",
               defaultValue="true",
               interestedModules=CORE)
public static final String MD_IS_CREATABLE

See Also:

Constant Field Values

MD_IS_DELETABLE

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="If present and false, then object can\'t be deleted (ie it is not user-manageable by the user).",
               defaultValue="true",
               interestedModules=CORE)
public static final String MD_IS_DELETABLE

See Also:

Constant Field Values

MD_IS_RENAMABLE

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="If present and false, then objects of this class can\'t be renamed.",
               defaultValue="true",
               interestedModules=CORE)
public static final String MD_IS_RENAMABLE

See Also:

Constant Field Values

MD_IS_RENAME_VIA_DELETE_ADD

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="If present and true, then forces connector to delete object and re-add it when renamed rather then letting the connector decide.",
               defaultValue="false",
               interestedModules=JCS)
public static final String MD_IS_RENAME_VIA_DELETE_ADD

See Also:

Constant Field Values

MD_IS_MOVEABLE

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               targetParent=HIERARCHICAL_ENDPOINT_TYPE,
               description="If present and true, then objects of this class can be moved (move only makes sense for hierarchical connector types).",
               defaultValue="false",
               interestedModules=CORE)
public static final String MD_IS_MOVEABLE

See Also:

Constant Field Values

MD_QUOTE_STRING

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Quote string (for connector) to be replaced around class names / attribute ids in native script.",
               defaultValue="null",
               interestedModules=JCS)
public static final String MD_QUOTE_STRING

See Also:

Constant Field Values

MD_DISPLAY_NAME

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="Human-friendly display name for entity.",
               interestedModules=CORE)
public static final String MD_DISPLAY_NAME

See Also:

Constant Field Values

MD_DISPLAY_TYPE

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="The type when displaying the property in a GUI.",
               interestedModules=CONXP)
public static final String MD_DISPLAY_TYPE

See Also:

Constant Field Values

MD_DISPLAY_EDITABLE

@MetaDataUsage(dataType=BOOL,
               target={CLASS,PROPERTY},
               description="Whether an attribute value can be changed in edit mode.",
               interestedModules=CONXP)
public static final String MD_DISPLAY_EDITABLE

See Also:

Constant Field Values

MD_IS_HIDDEN

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="Identifies that the value for property shouldn\'t be displayed in GUIs.",
               interestedModules={CONXP,GUI_CLIENT})
public static final String MD_IS_HIDDEN

See Also:

Constant Field Values

MD_SORT_ORDER_HINT

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="Specifies sort precedence for property within parent class, not always respected",
               interestedModules=JCS)
public static final String MD_SORT_ORDER_HINT

See Also:

Constant Field Values

MD_IMPLEMENTATION_BUNDLE

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Name of connector implementation targeted by connector type.",
               interestedModules={CONXP,JCS})
public static final String MD_IMPLEMENTATION_BUNDLE

Matches name of one of the ImplBundle beans created from the conf/connector.xml files read from all the jcs-connector-*.jar files matching each connector implementation on the classpath. Critical when the same LDAP schema is shared between multiple connector implementations (eg eTDYNNamespace can be used for JDBC/JNDI and SDK).

See Also:

Constant Field Values

MD_IS_HIERARCHICAL

@MetaDataUsage(dataType=BOOL,
               target=ENDPOINT_TYPE,
               description="True if connector supports arbitrary levels of nesting objects within containers, as opposed to being \"flat\".",
               defaultValue="true",
               interestedModules=CORE)
public static final String MD_IS_HIERARCHICAL

See Also:

Constant Field Values

MD_IS_STATIC

@MetaDataUsage(dataType=BOOL,
               target=ENDPOINT_TYPE,
               description="True if metadata for the connector is developer-maintained, rather than dynamic and managed by the customer.",
               defaultValue="false",
               interestedModules=CORE)
public static final String MD_IS_STATIC

See Also:

Constant Field Values

MD_IS_STATIC_EXTENSIBLE

@MetaDataUsage(dataType=BOOL,
               target=ENDPOINT_TYPE,
               description="True if metadata is static (mainly developer-maintained) but may still be modified by the Connector Xpress user.",
               defaultValue="false",
               targetPrequesiteMetaData="MD_IS_STATIC",
               interestedModules={CORE,CONXP})
public static final String MD_IS_STATIC_EXTENSIBLE

See Also:

Constant Field Values

MD_ABBREVIATION

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Short abbreviated name of the endpoint type, DYN for all dynamic connectors",
               interestedModules=JIAM)
public static final String MD_ABBREVIATION

See Also:

Constant Field Values

MD_PROJECT_NAME

@MetaDataUsage(dataType=STR,
               target=ENDPOINT_TYPE,
               description="Optional property suggesting a friendly project name for this namespace.",
               interestedModules=CONXP)
public static final String MD_PROJECT_NAME

See Also:

Constant Field Values

MD_CONN_MAP_TO

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="Connector-speak mapping to be used, for instance a JDBC based connector would probably map class to the name of a database table, and selected properties within the class to the names of columns within that table.",
               interestedModules={CONXP,JCS})
public static final String MD_CONN_MAP_TO

See Also:

Constant Field Values

MD_IS_TRANSACTIONS_ENABLED

@MetaDataUsage(dataType=BOOL,
               target={CLASS,PROPERTY},
               description="Configures whether transactions should be used for SQL operations.",
               defaultValue="true",
               interestedModules={CONXP,JCS})
public static final String MD_IS_TRANSACTIONS_ENABLED

See Also:

Constant Field Values

MD_CONN_MAP_ALIAS

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="Succinct alias for ${MD_CONN_MAP_TO} value where it is a complicated or obscure expression.",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_CONN_MAP_ALIAS

Which name to map an class (including the connector itself) or attribute to in connector-speak, in circumstances where MD_CONN_MAP_TO needs to be mapped to a complicated expression and therefore doesn't act as a useful reference name in the connector's code (refer to LDA which has ambiguous mappings for many classes/properties or ORA and SQL JDBC-based connectors which set MD_CONN_MAP_TO=[some complicated SQL SELECT statement] and MD_CONN_MAP_ALIAS=account).

See Also:

Constant Field Values

MD_CONN_MAP_TO_LANG

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="Where ${MD_CONN_MAP_TO} value is a script, this field specifies its language (e.g. \"javascript\").",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData="MD_CONN_MAP_TO",
               status=NOT_IMPLEMENTED)
public static final String MD_CONN_MAP_TO_LANG

See Also:

Constant Field Values

MD_CONN_MAP_TO_SAME

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               defaultValue="false",
               description="Specifies all contained properties will use their LDAP names literally as their connector-speak names.",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_CONN_MAP_TO_SAME

This boolean can appear on an class which does not have MD_CONN_MAP_TO specified for it to signify that all properties defined for it will use their LDAP names literally as their connector-speak names. Classes without either MD_CONN_MAP_TO or this attribute are simply skipped over (MD_CONN_MAP_TO_SAME is implied for compound classes).

See Also:

Constant Field Values

MD_CONN_MAP_TO_LAX

@MetaDataUsage(dataType=BOOL,
               target={ENDPOINT_CLASS,CLASS},
               defaultValue="false",
               description="Specifies that class (often endpoint class itself) will use the literal LDAP name as ${MD_CONN_MAP_TO} value for any properties which don\'t explicitly define one.",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_CONN_MAP_TO_LAX

This boolean can appear on any class which has MD_CONN_MAP_TO specified for it to signify that MD_CONN_MAP_TO mappings are "lax", which means any attributes on such classes which aren't explicitly mapped will keep their original names. When this value is false unmapped attributes passed in by clients belonging to mapped classes are simply thrown away, but when it is true they are passed through with their original names. Saves having to exhaustively map every property, which is particularly useful for the connector class itself if there a number of non-persisted logging configuration settings.

See Also:

Constant Field Values

MD_CONN_MAP_TO_AMBIGUOUS

@MetaDataUsage(dataType=SEQ,
               target={CLASS,PROPERTY},
               description="Specify a sequence of alternative ${MD_CONN_MAP_TO} mappings for target.",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData={"MD_CONN_MAP_TO","MD_CONN_MAP_TO_AMBIGUOUS_CHOICE_ATTR"})
public static final String MD_CONN_MAP_TO_AMBIGUOUS

For the (hopefully rare) cases where a single LDAP attribute ambiguously maps to more the one connector class / property. The order of the choices is important as the first one will be defaulted to when no explicit choice is made and a new object is created. For instance a JNDI based connector can have a number of such ambiguities:

1. eTDYNAccount is mapped to any one of the objectclasses person, residentialPerson, organizationalPerson, inetOrgPerson.
2. eTDYNContainer is mapped to any one of the objectclasses organizationalUnit or organization, which each have different naming attributes. Consequently eTDYNContainerName makes use of a special syntax which ties its ambiguous choice to the type of the parent object:

             <metadata name="connectorMapToAmbiguous">
                 <value>
                     <sequenceValue>
                         <val><strValue>organizationalUnit:ou</strValue></val>
                         <val><strValue>organization:o</strValue></val>
                     </sequenceValue>
                 </value>
              </metadata>
    

   See Also:

   Constant Field Values

MD_CONN_MAP_TO_MULTIPLE

@MetaDataUsage(dataType=SEQ,
               target={CLASS,PROPERTY},
               description="Specify a sequence of ${MD_CONN_MAP_TO} mappings for target.",
               interestedModules={CONXP,JCS})
public static final String MD_CONN_MAP_TO_MULTIPLE

For use in cases where a single LDAP class or attribute needs to be split into and/or composed from the values of multiple connector-speak attributes, in which case this setting lists these multiple connector-speak classes / attributes.

When used for a class, the first value in the sequence is important as it is considered to be the primary base connector-speak class which the other classes add additional attributes to. In this case, the attributes for all of the multiple classes need to have connectorMapTo values of the form ":" so that it is clear to the framework which connector-speak attributes belong to which classes. In such as usecase, any attributes of these classes that, in turn, have connectorMapToMultiple set on them containing values of the form ":" represent information about how the multiple connector-speak classes should be joined together (ie how their primary keys relate to each).

See Also:

Constant Field Values

MD_CONN_MAP_TO_AUX

@MetaDataUsage(dataType=SEQ,
               target={CLASS,PROPERTY},
               description="Identifies all auxiliary classes by name to which mappings are present.",
               interestedModules={CONXP,JCS},
               targetPrequesiteMetaData={"MD_CONN_MAP_TO_AMBIGUOUS","MD_CONN_MAP_TO"},
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_CONN_MAP_TO_AUX

Identifies all auxiliary classes by name to which mappings are present. When present it is expected that MD_CONN_MAP_TO,MD_CONN_MAP_TO_AMBIGUOUS will be used to identify all other (structural) classes to which mappings are made.

 <metadata name="connectorMapToAuxiliary"> <value>
 <sequenceValue>
 <val><strValue>posixAccount:gidNumber</strValue></
 val> </sequenceValue> </value> </metadata>

 

See Also:

Constant Field Values

MD_CONN_MAP_TO_DERIVED

@MetaDataUsage(dataType=MAP,
               target=CLASS,
               description="Identifies all structural classes by name to which mappings are present along with any classes that each of them derives from.",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData={"MD_CONN_MAP_TO","MD_CONN_MAP_TO_AMBIGUOUS"})
public static final String MD_CONN_MAP_TO_DERIVED

Identifies all structural classes by name to which mappings are present along with any classes that each of them derives from.

 <metadata name="connectorMapToDerived"> <value>
 <mapValue> <keyType><strValue/></keyType>
 <valueType><strValue/></valueType> <mapEntry>
 <key><strValue>class</strValue></key>
 <values> <sequenceValue>
 <val><strValue>derivedFromClass</strValue></val>
 <val><strValue>derivedFromClass2</strValue></val>
 </sequenceValue> </values> </mapEntry>
 </mapValue> </value> </metadata>

 

See Also:

Constant Field Values

MD_CONN_GENERATED_OVERRIDE

@MetaDataUsage(dataType=ENUM,
               target=ENDPOINT_TYPE,
               enumName="GeneratedOverrideStatus",
               defaultValue="Override",
               description="Specifies how to handle attempts to override generated attribute values in LDAP ADD requests.",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData={"MD_IS_CONN_GENERATED","MD_CONN_GENERATOR"})
public static final String MD_CONN_GENERATED_OVERRIDE

See Also:

Constant Field Values

MD_CONN_GENERATOR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Generator name (or literal expression passed to the endpoint if surrounded in \"s) which specifies the value to be assigned to the property (e.g. \'my_sequence\' or \'\"NEXT VALUE FOR my_sequence\"\' for JDBC).",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData={"MD_IS_CONN_GENERATED","MD_CONN_GENERATED_OVERRIDE"})
public static final String MD_CONN_GENERATOR

See Also:

Constant Field Values

MD_IS_CONN_GENERATED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="Identifies that the value for property is generated implicitly by the endpoint (e.g. true for IDENTITY column in JDBC).",
               interestedModules={CONXP,JCS},
               seeAlsoMetaData={"MD_CONN_GENERATOR","MD_CONN_GENERATED_OVERRIDE"})
public static final String MD_IS_CONN_GENERATED

See Also:

Constant Field Values

MD_CONN_MAP_TO_AMBIGUOUS_CHOICE_ATTR

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="Used to specify an explicit choice when ambiguous mappings are defined - otherwise first ambiguous mapping will always be used in ADD requests.",
               interestedModules={CONXP,JCS},
               targetPrequesiteMetaData="MD_CONN_MAP_TO_AMBIGUOUS",
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_CONN_MAP_TO_AMBIGUOUS_CHOICE_ATTR

Attributes with ambiguous mappings can optionally name another LDAP attribute which will be used to pass in an explicit choice when new instances of the objectclass are add()ed. For instance in the LDA connector eTLDAAccountName can be either cn= or uid=, so in its metadata it specifies

 <metadata name="connectorMapToAmbiguousChoiceAttr"> <value>
 <strValue>eTLDANamingAttribute</strValue> </value>
 </metadata>

 

meaning that an account creation would specify eTLDANamingAttribute=uid to explicitly state the desired choice of connector-speak naming attribute.

See Also:

Constant Field Values

MD_IS_NAMING

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used when have an ambiguous naming attribute but want to match only one choice.",
               defaultValue="false",
               interestedModules={CONXP,JCS},
               targetPrequesiteMetaData={"MD_CONN_MAP_TO_AMBIGUOUS","MD_IS_NAMING"},
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_IS_NAMING

Value Type: boolValue
Target Object(s): ANY property in datamodel
Default: false
Description: Designates that the target property to which it is attached acts as the naming attribute for the objectclass which contains it.

See Also:

Constant Field Values

MD_CONN_MAP_TO_STRICT

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used when have an ambiguous naming attribute but want to match only one choice.",
               defaultValue="false",
               interestedModules={CONXP,JCS},
               targetPrequesiteMetaData={"MD_CONN_MAP_TO_AMBIGUOUS","MD_IS_NAMING"},
               seeAlsoMetaData="MD_CONN_MAP_TO")
public static final String MD_CONN_MAP_TO_STRICT

Value Type: boolValue
Target Object(s): ANY naming property in datamodel
Description: Causes framework to augment objectclass filters to include explicit check for existence of a particular connector-speak naming attribute. Used in cases where naming attribute is potentially ambiguous but have chosen to map only one choice.

For instance in JNDI case map account to "person" and map account naming attribute to "uid". If this metadata setting is "true" on the naming attribute then the LDAP filter (objectclass=eTDYNAccount) will become (&(objectclass=person)(uid=*)). Without this metadata setting the filter will be simply (objectclass=person) and the framework will deduce the eTDYNAccountNames of pre-existing native accounts that only define cn= and have no value for uid=.

See Also:

Constant Field Values

MD_IS_MULTI_VALUED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Use of SET[] or SEQ[] values is the best way to declare a property as multi-valued - but this setting is then implicity defined for easy triggering of plug-ins.",
               defaultValue="false",
               interestedModules=CORE)
public static final String MD_IS_MULTI_VALUED

See Also:

Constant Field Values

MD_IS_CASE_SENSITIVE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Whether value comparisons for the property should include the letter case.",
               defaultValue="false",
               interestedModules=CORE,
               status=NOT_IMPLEMENTED)
public static final String MD_IS_CASE_SENSITIVE

See Also:

Constant Field Values

MD_IS_DYNAMIC

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="When true designates target property is intended to be mapped dynamically by the customer after deployment (implicitly true for all DYN attributes).",
               defaultValue="false",
               interestedModules=CORE)
public static final String MD_IS_DYNAMIC

See Also:

Constant Field Values

MD_IS_CAPABILITY

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="When true designates target property is flagged as a capability attribute in the Parser Table (this impacts propagation and merging of account templates).",
               defaultValue="false",
               interestedModules=CORE)
public static final String MD_IS_CAPABILITY

See Also:

Constant Field Values

MD_IS_UNMANAGED

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="When true designates target class exists to act in associations, and is not itself managed.",
               defaultValue="false",
               interestedModules=CORE,
               seeAlsoMetaData={"MD_IS_READ_ONLY","MD_IS_CREATABLE","MD_IS_DELETABLE","MD_IS_RENAMABLE","MD_IS_MOVEABLE"})
public static final String MD_IS_UNMANAGED

See Also:

Constant Field Values

MD_IS_OPERATIONAL_ATTR

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="When true designates target property is operational (ie calculated by the native endpoint rather then persisted), which can impact specifying of return attributes for lookups / searches.",
               defaultValue="false",
               interestedModules={JCS,CONXP})
public static final String MD_IS_OPERATIONAL_ATTR

See Also:

Constant Field Values

MD_IS_READ_ONLY

@MetaDataUsage(dataType=BOOL,
               target={CLASS,PROPERTY},
               description="If true then target can appear in ADD requests, but not MODIFY requests.",
               defaultValue="false",
               interestedModules=CORE,
               targetIncompatibleMetaData="MD_IS_WRITE_ONLY",
               seeAlsoMetaData="MD_WRITABLE_BY")
public static final String MD_IS_READ_ONLY

See Also:

Constant Field Values

MD_IS_READ_ONLY_NATIVE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Whether the property is read-only on the endpoint system.",
               defaultValue="false",
               interestedModules=CONXP,
               targetIncompatibleMetaData="MD_IS_WRITE_ONLY",
               seeAlsoMetaData="MD_IS_READ_ONLY")
public static final String MD_IS_READ_ONLY_NATIVE

See Also:

Constant Field Values

MD_IS_WRITE_ONLY

@MetaDataUsage(dataType=BOOL,
               target={CLASS,PROPERTY},
               description="If true then target property can only be modified but not read, which may be useful for passwords.",
               defaultValue="false",
               interestedModules=CORE,
               targetIncompatibleMetaData="MD_IS_READ_ONLY",
               seeAlsoMetaData={"MD_IS_READ_ONLY","MD_WRITABLE_BY"})
public static final String MD_IS_WRITE_ONLY

See Also:

Constant Field Values

MD_WRITABLE_BY

@MetaDataUsage(dataType=STR,
               target={CLASS,PROPERTY},
               description="Set to \"\" (not writable), \"ADD\" or \"MODIFY\" to restrict which LDAP requests can set target\'s values.",
               interestedModules=CORE,
               seeAlsoMetaData={"MD_IS_READ_ONLY","MD_IS_WRITE_ONLY"})
public static final String MD_WRITABLE_BY

Note setting to "ADD" is similar to MD_IS_READ_ONLY except that the latter throws an error whereas this setting simply throws away attempts to modify the property using the prohibited "ADD" or "MODIFY". When applied to a class has same effect as if it was explicitly included for every property in the class.

See Also:

Constant Field Values

MD_IS_REQUIRED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Designates that the target property to which it is attached is required, meaning that a value must be provided for it when objects are created and that it must have a least one value at all times.",
               defaultValue="false",
               interestedModules=CORE)
public static final String MD_IS_REQUIRED

See Also:

Constant Field Values

MD_IS_REQUIRED_AMBIGUOUS

@MetaDataUsage(dataType=SEQ,
               target=PROPERTY,
               description="Designates which of the multiple native classes treat an attribute shared by those classes as required.",
               interestedModules={CORE,CONXP},
               seeAlsoMetaData="MD_IS_REQUIRED")
public static final String MD_IS_REQUIRED_AMBIGUOUS

See Also:

Constant Field Values

MD_IS_EXPENSIVE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="When true property is expensive to retrieve (eg a photograph) and must be explicitly requested in return attributes for SEARCH requests.",
               defaultValue="false",
               interestedModules=JCS)
public static final String MD_IS_EXPENSIVE

See Also:

Constant Field Values

MD_FORCE_MOD_MODE

@MetaDataUsage(dataType=ENUM,
               target={CLASS,PROPERTY},
               description="Ensures only one mode of modification item for the target (usually multi-valued) property, regardless of the modification mode originally passed in by the client. Property level setting overrides any at the class level.",
               enumName="ForceModModeValue",
               defaultValue="",
               interestedModules={JCS,CONXP})
public static final String MD_FORCE_MOD_MODE

See Also:

Constant Field Values

MD_IS_STORE_NUMERIC

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used for properties with boolean or enum values, to specify symbolic text is expected in LDAP but that equivalent numeric values should be stored in connector-speak. Note that ${MD_IS_STORE_SYMBOLIC} does the opposite.",
               targetAttributeType={"BOOL","ENUM"},
               defaultValue="false",
               interestedModules=JCS,
               targetIncompatibleMetaData="MD_IS_STORE_SYMBOLIC")
public static final String MD_IS_STORE_NUMERIC

See Also:

Constant Field Values

MD_IS_STORE_SYMBOLIC

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used for properties with boolean or enum values, to specify numeric text is expected in LDAP but that equivalent symbolic values should be stored in connector-speak. Note that ${MD_IS_STORE_NUMERIC} does the opposite.",
               targetAttributeType={"BOOL","ENUM"},
               defaultValue="false",
               interestedModules=JCS,
               targetIncompatibleMetaData="MD_IS_STORE_NUMERIC")
public static final String MD_IS_STORE_SYMBOLIC

See Also:

Constant Field Values

MD_IS_LAX

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Lax format - which for enum values means that LDAP accepts both symbolic and numeric syntax for the target property.",
               targetAttributeType="ENUM",
               defaultValue="false",
               interestedModules=JCS)
public static final String MD_IS_LAX

See Also:

Constant Field Values

MD_BOOL_VALUES

@MetaDataUsage(dataType=SEQ,
               target=PROPERTY,
               description="Specifies alternate symbolic values representing false (0) / true (1) to be stored in connector-speak, in that order.",
               targetAttributeType="BOOL",
               defaultValue="null",
               interestedModules=JCS)
public static final String MD_BOOL_VALUES

See Also:

Constant Field Values

MD_IS_STRING_ARRAY

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Triggers converter from multi-valued LDAP attribute to String[]. Also refer to ${MD_IS_JAVA_OBJECT} which does a more general job.",
               defaultValue="false",
               interestedModules=JCS,
               targetPrequesiteMetaData="MD_IS_MULTI_VALUED",
               seeAlsoMetaData="MD_IS_JAVA_OBJECT")
public static final String MD_IS_STRING_ARRAY

See Also:

Constant Field Values

MD_IS_JAVA_OBJECT

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Triggers Java object converter which converts string values for LDAP attributes to Java objects (or strings) based on datamodel type.",
               defaultValue="false",
               interestedModules=JCS,
               seeAlsoMetaData="MD_IS_STRING_ARRAY")
public static final String MD_IS_JAVA_OBJECT

See Also:

Constant Field Values

MD_IS_NON_STD

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used to signal to IMPS that the value(s) for account / account template attributes don\'t adhere to the standard format and shouldn\'t be adjusted.",
               defaultValue="false",
               interestedModules={IMPS,JCS})
public static final String MD_IS_NON_STD

See Also:

Constant Field Values

MD_IS_OBFUSCATED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Triggers encryption converter using algorithm specified using ${MD_ENCRYPT_ALG}, meaning that values are persisted in obfuscated form on the managed system. Note that encrypting fields means that they can only be read via the connector and can no longer be accessed by direct access to the managed system.",
               defaultValue="false",
               interestedModules=JCS,
               seeAlsoMetaData="MD_ENCRYPT_ALG")
public static final String MD_IS_OBFUSCATED

See Also:

Constant Field Values

MD_IS_STORE_CODE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used for properties with enum values, to specify a long name is expected in LDAP but that equivalent short code values should be stored in connector-speak. Note that ${MD_IS_STORE_NAME} does the opposite.",
               targetAttributeType="ENUM",
               defaultValue="false",
               interestedModules=JCS,
               targetIncompatibleMetaData="MD_IS_STORE_NAME")
public static final String MD_IS_STORE_CODE

See Also:

Constant Field Values

MD_IS_STORE_NAME

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Used for properties with enum values, to specify short code is expected in LDAP but that equivalent long name values should be stored in connector-speak. Note that ${MD_IS_STORE_CODE} does the opposite.",
               targetAttributeType="ENUM",
               defaultValue="false",
               interestedModules=JCS,
               targetIncompatibleMetaData="MD_IS_STORE_CODE")
public static final String MD_IS_STORE_NAME

See Also:

Constant Field Values

MD_ENCRYPT_ALG

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               description="Specifies algorithm to be used for encrypting values of obfuscated target property.",
               enumName="EncryptAlgorithms",
               defaultValue="null",
               interestedModules=JCS,
               targetPrequesiteMetaData="MD_IS_OBFUSCATED",
               seeAlsoMetaData="MD_IS_ENCRYPTED")
public static final String MD_ENCRYPT_ALG

See Also:

Constant Field Values

MD_DONT_PREFIX_ALGORITHM

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Hints to CryptoService it should not prefix encrypted value with the algorithm name.",
               defaultValue="false",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_IS_OBFUSCATED","MD_ENCRYPT_ALG"})
public static final String MD_DONT_PREFIX_ALGORITHM

See Also:

Constant Field Values

MD_IS_ENCRYPTED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Designates that target property is sensitive so that GUI clients echo characters as \'*\'s.",
               defaultValue="false",
               interestedModules={CONXP,GUI_CLIENT},
               seeAlsoMetaData="MD_IS_OBFUSCATED")
public static final String MD_IS_ENCRYPTED

See Also:

Constant Field Values

MD_VALID_REGEX

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies regular expression (of style specified by ${MD_VALID_REGEX_STYLE}) to be used to validate values stored in the target property.",
               interestedModules=JCS,
               seeAlsoMetaData="MD_VALID_REGEX_STYLE")
public static final String MD_VALID_REGEX

Where the same regular expression is used in a number of places a better approach would be to define a FLEXI_STR:myType type and tie this type to a RegexAttributeValidator via your connector's conf/connector.xml file.

See Also:

Constant Field Values

MD_VALID_REGEX_STYLE

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               description="Specifies style of regular expression to be used to validate the target property.",
               enumName="RegexStyle",
               defaultValue="perl5",
               interestedModules=JCS,
               targetPrequesiteMetaData="MD_VALID_REGEX")
public static final String MD_VALID_REGEX_STYLE

See Also:

Constant Field Values

MD_CONVERT_REGEX

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies regular expression (of style specified by ${MD_CONVERT_REGEX_STYLE} to be used to convert values to connector-speak for the target property.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_CONVERT_REGEX_STYLE","MD_CONVERT_REGEX_FROM_CONN"})
public static final String MD_CONVERT_REGEX

Where the same regular expression is used in a number of places a better approach would be to define a FLEXI_STR:myType type and tie this type to a RegexAttributeConverter via your connector's conf/connector.xml file.

See Also:

Constant Field Values

MD_CONVERT_REGEX_STYLE

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               description="Specifies style of regular expression to be used to convert the target property.",
               enumName="RegexStyle",
               defaultValue="perl5",
               interestedModules=JCS,
               targetPrequesiteMetaData="MD_CONVERT_REGEX")
public static final String MD_CONVERT_REGEX_STYLE

See Also:

Constant Field Values

MD_CONVERT_REGEX_FROM_CONN

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies regular expression (of style specified by ${MD_CONVERT_REGEX_STYLE} to be used to convert values from connector-speak for the target property.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_CONVERT_REGEX","MD_CONVERT_REGEX_STYLE"})
public static final String MD_CONVERT_REGEX_FROM_CONN

See Also:

Constant Field Values

MD_REGEX_DESCR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Description of regular expression used to validate the target property, which appears in validation failure messages.",
               interestedModules=JCS,
               targetPrequesiteMetaData="MD_VALID_REGEX")
public static final String MD_REGEX_DESCR

See Also:

Constant Field Values

MD_VALIDATOR_CLASS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Can be used to explicitly attach a validator (of any variety) to explicit target properties, rather then using value / metadata property triggers.",
               interestedModules=JCS,
               seeAlsoMetaData="MD_CONVERTER_CLASS")
public static final String MD_VALIDATOR_CLASS

See Also:

Constant Field Values

MD_CONVERTER_CLASS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Can be used to explicitly attach a converter (of any variety) to explicit target properties, rather then using value / metadata property triggers.",
               interestedModules=JCS,
               seeAlsoMetaData="MD_VALIDATOR_CLASS")
public static final String MD_CONVERTER_CLASS

See Also:

Constant Field Values

MD_MIN_LENGTH

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="Specifies minimum length for value(s) of target property.",
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_MAX_LENGTH")
public static final String MD_MIN_LENGTH

See Also:

Constant Field Values

MD_MAX_LENGTH

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="Specifies maximum length for value(s) of target property.",
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData={"MD_MIN_LENGTH","MD_UI_SIZE"})
public static final String MD_MAX_LENGTH

See Also:

Constant Field Values

MD_MIN_VALUE

@MetaDataUsage(dataType={INT,LONG,FLOAT,DBL},
               target=PROPERTY,
               description="Specifies minimum bound on value(s) of target property.",
               targetAttributeType={"INT","LONG","FLOAT","DBL"},
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_MAX_VALUE")
public static final String MD_MIN_VALUE

See Also:

Constant Field Values

MD_MAX_VALUE

@MetaDataUsage(dataType={INT,LONG,FLOAT,DBL},
               target=PROPERTY,
               description="Specifies maximum bound on value(s) of target property.",
               targetAttributeType={"INT","LONG","FLOAT","DBL"},
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_MIN_VALUE")
public static final String MD_MAX_VALUE

See Also:

Constant Field Values

MD_FLATTEN_STYLE

@MetaDataUsage(dataType=ENUM,
               target={CLASS,PROPERTY},
               enumName="FlattenStyle",
               description="Specifies that the values for the multi-valued target property should be flattened into a single string literal using the named \"style\".",
               interestedModules=JCS)
public static final String MD_FLATTEN_STYLE

Refer to classes deriving from MultiValuePropertyFlattener).

See Also:

Constant Field Values

MD_NUMERIC_FROM_BASE

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="Triggers {@link com.ca.jcs.converter.meta.NumericBasePropertyFlattener} if present, the value given in this metadata determines the numeric base from which attribute values are converted.",
               interestedModules=JCS)
public static final String MD_NUMERIC_FROM_BASE

See Also:

Constant Field Values

MD_NUMERIC_TO_BASE

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="Triggers {@link com.ca.jcs.converter.meta.NumericBasePropertyFlattener} if present, the value given in this metadata determines the numeric base to which attribute values are converted.",
               interestedModules=JCS)
public static final String MD_NUMERIC_TO_BASE

See Also:

Constant Field Values

MD_NUMERIC_PREFIX

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Tells {@link com.ca.jcs.converter.meta.NumericBasePropertyFlattener} if present, to prefix converted values with any set value.",
               interestedModules=JCS)
public static final String MD_NUMERIC_PREFIX

See Also:

Constant Field Values

MD_PAD_PREFIX

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Complements MD_NUMERIC_TO_BASE by specifying that padding with the set characters is needed, the padding is a prefix to the attribute value.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_NUMERIC_TO_BASE","MD_FLATTEN_STYLE","MD_PAD_LENGTH"})
public static final String MD_PAD_PREFIX

See Also:

Constant Field Values

MD_PAD_SUFFIX

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Complements MD_NUMERIC_TO_BASE by specifying that padding with the set characters is needed, the padding is a suffix to the attribute value.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_NUMERIC_TO_BASE","MD_FLATTEN_STYLE","MD_PAD_LENGTH"})
public static final String MD_PAD_SUFFIX

See Also:

Constant Field Values

MD_PAD_LENGTH

@MetaDataUsage(dataType=INT,
               target=PROPERTY,
               description="Complements MD_NUMERIC_TO_BASE by specifying that padding with this many MD_PAD_LENGTH characters is needed.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_NUMERIC_TO_BASE","MD_FLATTEN_STYLE","MD_PAD_LENGTH"})
@Deprecated
public static final String MD_PAD_LENGTH

Deprecated.

See Also:

Constant Field Values

MD_DN_LDAP_OBJECT_CLASS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               description="Specifies name of objectclass referenced by the distinguished name value(s) for target association property.",
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_DN_LDAP_OBJECT_CLASSES")
public static final String MD_DN_LDAP_OBJECT_CLASS

See Also:

Constant Field Values

MD_DN_LDAP_OBJECT_CLASSES

@MetaDataUsage(dataType=SET,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               description="Where a variety of objectclass references can exist in an associative collection this setting should be used instead of ${MD_DN_LDAP_OBJECT_CLASS}.",
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_DN_LDAP_OBJECT_CLASS")
public static final String MD_DN_LDAP_OBJECT_CLASSES

See Also:

Constant Field Values

MD_DN_NAME_ONLY_LDAP_OBJECTCLASS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               description="When multiple objectclass references can exist in an associative collection this setting can nominate which one of the objectclasses is to be treated as ${MD_DN_NAME_ONLY}",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_DN_LDAP_OBJECT_CLASSES","MD_DN_NAME_ONLY"})
public static final String MD_DN_NAME_ONLY_LDAP_OBJECTCLASS

Value Type:strValue
Target Object(s): ANY property that has MD_DN_LDAP_OBJECT_CLASSES in datamodel
Description: When multiple objectclass references can exist in an associative collection this setting can nominate which one of the objectclasses is to be treated as MD_DN_NAME_ONLY.

See Also:

Constant Field Values

MD_IS_DN_ABSOLUTE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               defaultValue="false",
               description="Specifies that the distinguished name value(s) for target property are absolute (defaults to false, ie \"relative\" DNs).",
               interestedModules=JCS,
               targetIncompatibleMetaData="MD_DN_NAME_ONLY",
               seeAlsoMetaData="MD_DN_LDAP_OBJECT_CLASSES")
public static final String MD_IS_DN_ABSOLUTE

See Also:

Constant Field Values

MD_DN_NAME_ONLY

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               defaultValue="false",
               description="If true then the connector wants the DNs converted to plain connector-speak name for storage, for instance eTDYNGroupName=grp1 will be converted to just grp1.",
               interestedModules=JCS,
               targetIncompatibleMetaData="MD_IS_DN_ABSOLUTE",
               seeAlsoMetaData={"MD_DN_LDAP_OBJECT_CLASS","MD_DN_LDAP_OBJECT_CLASSES"})
public static final String MD_DN_NAME_ONLY

See Also:

Constant Field Values

MD_DN_BASE_ATTRIBUTE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               description="Nominates a readable attribute (on endpoint class) which contains the native base DN managed by the connector",
               interestedModules=JCS,
               targetIncompatibleMetaData="",
               seeAlsoMetaData={"MD_DN_LDAP_OBJECT_CLASS","MD_DN_LDAP_OBJECT_CLASSES"})
public static final String MD_DN_BASE_ATTRIBUTE

See Also:

Constant Field Values

MD_DN_TEST_EXISTS

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               targetAttributeType="FLEXI_STR:DN",
               defaultValue="false",
               description="If true then each DN contained by associative target property should be tested for existence by doing a doLookup() on each of them requesting empty array of attributes.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_DN_LDAP_OBJECT_CLASS","MD_DN_LDAP_OBJECT_CLASSES"})
public static final String MD_DN_TEST_EXISTS

See Also:

Constant Field Values

MD_ASSOC_REF_OBJECT_CLASS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies object class target association property stores references to.",
               interestedModules={CONXP,CORE},
               seeAlsoMetaData={"MD_DN_LDAP_OBJECT_CLASS","MD_DN_LDAP_OBJECT_CLASSES"})
public static final String MD_ASSOC_REF_OBJECT_CLASS

Defines a relationship from an obj type to a referenced obj type, where direct association via an attribute and indirect association via a table external to both object types are supported.

For direct association an attribute in the 'referencing' objectclass (say 'Account.groups') defines its association with another 'referenced' objectclass (say 'Group') by specifying the multi-valued attribute in the referenced objectclass that is used to store the names of contained items (say 'Group.accounts'). A concrete connector then needs to perform the logical reverse lookup required to populate the virtual associative attribute (in this example the virtual 'Account.groups' attribute is populated by looking for Groups which contain an account's name in its 'Group.accounts' attribute). Two metadata settings are required: MD_ASSOC_REF_OBJECT_CLASS (='Group' in the example above) and MD_ASSOC_REVERSE_ATTR (='accounts' in the example above). Note that MD_DN_LDAP_OBJECT_CLASS (or MD_DN_LDAP_OBJECT_CLASSES) also need to be provided if the references which make up the values of the associative attribute are represented as Distinguished Names (which is strongly recommended. In this case the MD_ASSOC_REF_OBJECT_CLASS setting is still required and can be given the same value as that for the MD_DN_LDAP_OBJECT_CLASS setting (or any of values mentioned in MD_DN_LDAP_OBJECT_CLASSES).

For the indirect case the following need to be specified:

1. the referenced objectclass must be specified (via MD_ASSOC_REF_OBJECT_CLASS), as for the direct case
2. an association table (specified by MD_ASSOC_TABLE) with two columns: the column named in MD_ASSOC_TABLE_OBJ_COLUMN references the key for the containing objectclass and the column named by MD_ASSOC_TABLE_REF_COLUMN) references the key for the referenced objectclass.
3. an optional MD_ASSOC_OBJ_KEY_ATTR can be used to flag that an alternative key for the containing objectclass is to be stored in the MD_ASSOC_TABLE_OBJ_COLUMN column (if it is not specified then the containing object's naming attribute is assumed).
4. an optional MD_ASSOC_REF_KEY_ATTR can be used to flag that an alternative key for the referenced objectclass is to be stored in the MD_ASSOC_TABLE_REF_COLUMN column (if it is not specified then the containing object's naming attribute is assumed).

Except for the last two, all of these metadata settings are mandatory to specify an indirect association.

See Also:

Constant Field Values

MD_REF_OBJECT_TYPE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Deprecated, use assocRefObjectClass instead.")
@Deprecated
public static final String MD_REF_OBJECT_TYPE

Deprecated. Use MD_ASSOC_REF_OBJECT_CLASS instead.

See Also:

Constant Field Values

MD_JIAM_OBJECT_TYPE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies object class for searching endpoint capabilities.",
               interestedModules=CONXP)
public static final String MD_JIAM_OBJECT_TYPE

See Also:

Constant Field Values

MD_ASSOC_REVERSE_ATTR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Targets any direct association property, names attribute in referenced class (ie not parent of target property) which contains association information in the reverse direction.",
               interestedModules={CONXP,CORE},
               associationRestriction=DIRECT,
               seeAlsoMetaData="MD_ASSOC_REF_OBJECT_CLASS")
public static final String MD_ASSOC_REVERSE_ATTR

See Also:

Constant Field Values

MD_ASSOC_TABLE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Targets any indirect association property, names table which stores association links.",
               interestedModules={CONXP,CORE},
               associationRestriction=INDIRECT,
               seeAlsoMetaData="MD_ASSOC_REF_OBJECT_CLASS")
public static final String MD_ASSOC_TABLE

See Also:

Constant Field Values

MD_ASSOC_TABLE_OBJ_COLUMN

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Targets any indirect association property, specifies column in table named in ${MD_ASSOC_TABLE} which contains references to class which is parent of target property.",
               interestedModules={CONXP,CORE},
               associationRestriction=INDIRECT,
               targetPrequesiteMetaData="MD_ASSOC_TABLE",
               seeAlsoMetaData={"MD_ASSOC_REF_OBJECT_CLASS","MD_ASSOC_TABLE_REF_COLUMN"})
public static final String MD_ASSOC_TABLE_OBJ_COLUMN

See Also:

Constant Field Values

MD_ASSOC_TABLE_REF_COLUMN

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Targets any indirect association property, specifies column in table named in ${MD_ASSOC_TABLE} which contains references to referenced class (ie not parent class of target property).",
               interestedModules={CONXP,CORE},
               associationRestriction=INDIRECT,
               targetPrequesiteMetaData="MD_ASSOC_TABLE",
               seeAlsoMetaData={"MD_ASSOC_REF_OBJECT_CLASS","MD_ASSOC_TABLE_OBJ_COLUMN"})
public static final String MD_ASSOC_TABLE_REF_COLUMN

See Also:

Constant Field Values

MD_ASSOC_REF_KEY_ATTR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies alternate key to be used to name referenced class (ie not parent of target property).",
               interestedModules={CONXP,CORE},
               associationRestriction=DIRECT_AND_INDIRECT,
               seeAlsoMetaData="MD_ASSOC_REF_OBJECT_CLASS")
public static final String MD_ASSOC_REF_KEY_ATTR

See Also:

Constant Field Values

MD_ASSOC_OBJ_KEY_ATTR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Targets any indirect association property, alternate key to be used to name parent class of target property (ie not referenced class).",
               interestedModules={CONXP,CORE},
               associationRestriction=INDIRECT,
               seeAlsoMetaData="MD_ASSOC_REF_OBJECT_CLASS")
public static final String MD_ASSOC_OBJ_KEY_ATTR

See Also:

Constant Field Values

MD_IS_IMPLEMENTED_AS_ASSOC

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Flags an attribute as an \"opaque\" association where it\'s associative without being expressed using core association semantics. JCS will modify such attributes in a locked context",
               defaultValue="false",
               interestedModules={CONXP,CORE})
public static final String MD_IS_IMPLEMENTED_AS_ASSOC

See Also:

Constant Field Values

MD_ASSOC_TYPE

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               description="When true specifies that target attribute specifies association between a parent object and its compound value child objects.",
               enumName="AssocType",
               defaultValue="NORMAL",
               interestedModules={CONXP,CORE},
               associationRestriction=DIRECT_AND_INDIRECT)
public static final String MD_ASSOC_TYPE

See Also:

Constant Field Values

MD_IS_COMPOUND_VALUE

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               description="When true designates target class exists to define the format of values accepted by a compound / structured attribute.",
               defaultValue="false",
               interestedModules={CORE,CONXP},
               targetIncompatibleMetaData="MD_CONN_MAP_TO_AMBIGUOUS",
               seeAlsoMetaData={"MD_IS_READ_ONLY","MD_IS_CREATABLE","MD_IS_DELETABLE","MD_IS_RENAMABLE","MD_IS_MOVEABLE"})
public static final String MD_IS_COMPOUND_VALUE

See Also:

Constant Field Values

MD_FORCE_CASE

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               description="When set and has value \'upper\' all connector speak values of a string property are forcibly uppercased, similiarly if set to \'lower\' then lowercase conversions are enforced.",
               enumName="ForceCaseValue",
               interestedModules={JCS,CONXP})
public static final String MD_FORCE_CASE

Refer to MetaDataDefs.ForceCaseValue.

See Also:

Constant Field Values

MD_IS_VIRTUAL

@MetaDataUsage(dataType=BOOL,
               target={CLASS,PROPERTY},
               defaultValue="false",
               description="flags its target property as \"computed\" rather then \"persisted\".",
               interestedModules={CONXP,CORE},
               associationRestriction=DIRECT,
               seeAlsoMetaData="MD_ASSOC_REF_OBJECT_CLASS")
public static final String MD_IS_VIRTUAL

Note currently used for associations but may see wider use in future.

See Also:

Constant Field Values

MD_IS_TRIM_REQUIRED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="When true flags that values of target property should have both leading and trailing whitespace trimmed.",
               interestedModules=JCS)
public static final String MD_IS_TRIM_REQUIRED

See Also:

Constant Field Values

MD_IS_WINDOWS_FILE_TIME

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="Use WindowsFileTimeConverter instead of than SimpleDateTimeConverter",
               interestedModules=JIAM)
public static final String MD_IS_WINDOWS_FILE_TIME

See Also:

Constant Field Values

MD_DATE_FORMAT

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Use specified simple date format during conversion of property value",
               interestedModules=JIAM)
public static final String MD_DATE_FORMAT

See Also:

Constant Field Values

MD_DATE_STRIP_FRACTIONAL

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Denotes that a date time value should have fractional seconds stripped off when converting to normalized format",
               interestedModules=JIAM)
public static final String MD_DATE_STRIP_FRACTIONAL

See Also:

Constant Field Values

MD_DATE_STRIP_TZ

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="Denotes that a date time value should have time zone component stripped off when converting to normalized format",
               interestedModules=JIAM)
public static final String MD_DATE_STRIP_TZ

See Also:

Constant Field Values

MD_UNSET_VALUE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies placeholder value when property\'s value is unset.",
               interestedModules=JIAM)
public static final String MD_UNSET_VALUE

See Also:

Constant Field Values

MD_IS_ETA_DATE_TIME

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="Use ETADateTimeConverter instead of than SimpleDateTimeConverter",
               interestedModules=JIAM)
public static final String MD_IS_ETA_DATE_TIME

See Also:

Constant Field Values

MD_ETA_DATE_TIME_TIMEZONE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Timezone for EtaDateTimeConverter.",
               interestedModules=JIAM)
public static final String MD_ETA_DATE_TIME_TIMEZONE

See Also:

Constant Field Values

MD_NUMBER_PROPERTY_COUNTRY

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Number Property Converter use locale of this country when formatting number.",
               interestedModules=JIAM)
public static final String MD_NUMBER_PROPERTY_COUNTRY

See Also:

Constant Field Values

MD_NUMBER_PROPERTY_USE_GROUPING

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Number Property Converter use grouping when formatting number.",
               interestedModules=JIAM)
public static final String MD_NUMBER_PROPERTY_USE_GROUPING

See Also:

Constant Field Values

MD_NUMBER_PROPERTY_MIN_INTEGER_DIGITS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Number Property Converter use min digits when formatting number.",
               interestedModules=JIAM)
public static final String MD_NUMBER_PROPERTY_MIN_INTEGER_DIGITS

See Also:

Constant Field Values

MD_NUMBER_PROPERTY_MAX_INTEGER_DIGITS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Number Property Converter use max digits when formatting number.",
               interestedModules=JIAM)
public static final String MD_NUMBER_PROPERTY_MAX_INTEGER_DIGITS

See Also:

Constant Field Values

MD_NUMBER_PROPERTY_MIN_FRACTION_DIGITS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Number Property Converter use min fraction digits when formatting number.",
               interestedModules=JIAM)
public static final String MD_NUMBER_PROPERTY_MIN_FRACTION_DIGITS

See Also:

Constant Field Values

MD_NUMBER_PROPERTY_MAX_FRACTION_DIGITS

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Number Property Converter use max fraction digits when formatting number.",
               interestedModules=JIAM)
public static final String MD_NUMBER_PROPERTY_MAX_FRACTION_DIGITS

See Also:

Constant Field Values

MD_IS_SINGLE_NAMING_VALUE

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               defaultValue="false",
               targetPrequesiteMetaData="MD_IS_NAMING",
               description="When true flags that only value present in RDN should be kept for multi-valued naming attribute.",
               interestedModules=JCS)
public static final String MD_IS_SINGLE_NAMING_VALUE

Handle cases like multiple cn= values for JNDI-based connectors which upset the Identity Manager Provisioning Server.

See Also:

Constant Field Values

MD_IS_CONNECTOR_SIBLING

@MetaDataUsage(dataType=BOOL,
               target=CLASS,
               defaultValue="false",
               targetPrequesiteMetaData="MD_IS_NAMING",
               description="When true flags that the target class is the sibling of the connector object (rather then nested under it) so that JCS framework knows to route requests to it via its parent Connector Type.",
               interestedModules=JCS)
public static final String MD_IS_CONNECTOR_SIBLING

See Also:

Constant Field Values

MD_IS_NESTED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               targetPrequesiteMetaData="MD_IS_NAMING",
               description="When true flags target associative property stores references back to target\'s parent class.",
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_IS_NESTED_ALL")
public static final String MD_IS_NESTED

See Also:

Constant Field Values

MD_IS_NESTED_ALL

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               targetPrequesiteMetaData={"MD_IS_NAMING","MD_IS_VIRTUAL"},
               description="When true flags target associative property stores references back to target\'s parent class, at all recursive levels of nesting.",
               interestedModules={GUI_CLIENT,JCS})
public static final String MD_IS_NESTED_ALL

See Also:

Constant Field Values

MD_NESTED_BASE_ATTRIBUTE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               targetPrequesiteMetaData="MD_VALUE_MATCH_EXPR",
               description="Identifies an attribute (property) by name which contains the valueMatchExpression to find the initial set of matching objects on which the nesting is calculated.",
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData={"MD_VALUE_MATCH_EXPR","MD_IS_NESTED_ALL"})
public static final String MD_NESTED_BASE_ATTRIBUTE

See Also:

Constant Field Values

MD_VALUE_TEMPLATE

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies target associative property stores values resulting from substituting values into this template, eg for nisNetgroupTriple the template metadata would be \"(,\\${name},)\".",
               associationRestriction=DIRECT,
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_VALUE_MATCH_EXPR")
public static final String MD_VALUE_TEMPLATE

See Also:

Constant Field Values

MD_VALUE_MATCH_EXPR

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Specifies that values for target associative property are calculated by testing against this filter expression.",
               associationRestriction=DIRECT,
               interestedModules={GUI_CLIENT,JCS},
               seeAlsoMetaData="MD_VALUE_TEMPLATE")
public static final String MD_VALUE_MATCH_EXPR

For instance to match members identified via nisNetgroupTriple this filter would be: "(|(nisNetGroupTriple=\28*,${name},*\29)(nisNetGroupTriple=\28*,,*\29))"

See Also:

Constant Field Values

MD_IS_CONNECTOR_FILTERABLE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="true",
               targetIncompatibleMetaData="MD_IS_NAMING",
               description="When true flags that the connector is unable to filter this attribute.",
               interestedModules=JCS)
public static final String MD_IS_CONNECTOR_FILTERABLE

Filters supplied to the connector will have references to this attribute removed. The results of searches filtering this attribute will have the complete filter applied to connector returned results by the JCS at an additional runtime cost.

See Also:

Constant Field Values

MD_DN_TYPE

public static final String MD_DN_TYPE

Occurs as "type" value for FlexiStr values used to represent Distinguished Names (DNs) - "FLEXI_STR:DN".

See Also:

Constant Field Values

MD_DEREGISTER

public static final String MD_DEREGISTER

Reserved metadata property name used to deregister validator / converter plug-ins when a connector needs to remove a default plug-in registered in server_jcs.xml (refer to comment and usage in SDK connector's conf/connector.xml).

See Also:

Constant Field Values

MD_USE_SPECIAL_NULL_VALUE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               description="When true on target property, configured \"nullValue\" (a single space character by default) will be used for it when no explicit value is provided (useful for JDBC).",
               interestedModules=JCS)
public static final String MD_USE_SPECIAL_NULL_VALUE

See Also:

Constant Field Values

MD_NORMALIZE_CONN_VALUE

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               enumName="NormalizeConnValue",
               description="Flags that connector speak values corresponding to the attribute to which it is applied require normalization using this setting before\nbeing compared against other connector speak values, normalized values will be also be\nsent to the endpoint as part of the attribute values.\nThis is required where connector-speak DNs in particular require normalizations, for example\non ADAM where lookup/searches return DNs that can differ by case.\n\nWhen used on an association which has a virtual side, should be added to the virtual\nattribute and will be automatically applied to the non virtual one, if added to non virtual\nside, ensure assocReverseAttr value correctly points at the right attribute.",
               interestedModules=JCS,
               seeAlsoMetaData={"MD_NORMALIZE_CONN_VALUE_STYLE","MD_FORCE_CASE"})
public static final String MD_NORMALIZE_CONN_VALUE

Drives connector side value normalizations by allowing normalization to be enabled and normalization mode to be set, primarily applicable to associative/DN type properties whose values can be compared in associative processors.

See Also:

Constant Field Values

MD_NORMALIZE_CONN_VALUE_STYLE

@MetaDataUsage(dataType=ENUM,
               target=PROPERTY,
               enumName="NormalizeConnValueStyle",
               description="Used in conjunction with MD_NORMALIZE_CONN_VALUE, defines the normalization style to apply.",
               interestedModules=JCS,
               seeAlsoMetaData="MD_NORMALIZE_CONN_VALUE")
public static final String MD_NORMALIZE_CONN_VALUE_STYLE

Drives connector side value normalizations by allowing normalization style to be defined

See Also:

Constant Field Values

MD_IS_INTERESTING_TO_COMPLIANCE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="When true on a class/property, indicates that it should be used in\nconstruction of a permission-based view, currently used by RCM.",
               interestedModules={JIAM,CONXP})
public static final String MD_IS_INTERESTING_TO_COMPLIANCE

See Also:

Constant Field Values

MD_IS_INCLUSION_BASED

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="When true on a property, indicates that the inclusion converter \nshould be called for this property",
               interestedModules=JIAM)
public static final String MD_IS_INCLUSION_BASED

See Also:

Constant Field Values

MD_IS_JIAM_INTERNAL

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="When true on a property, indicates that this property is specific to \nJIAM API, and doesn\'t directly correspond to an LDAP attribute in Provisioning",
               interestedModules=JIAM)
public static final String MD_IS_JIAM_INTERNAL

See Also:

Constant Field Values

MD_COMPOUND_FORMAT

@MetaDataUsage(dataType=STR,
               target=CLASS,
               description="Set on a compound class and contains a format string representing compound property names and any regular expressions that match those properties and forms flattened unnormalized representation of compound attribute values.\nFormat string can contain literal sequences or a number of ${attr=regex} expressions that can appear in the string, each such expression consists of a property name and the regex.",
               interestedModules=JIAM)
public static final String MD_COMPOUND_FORMAT

See Also:

Constant Field Values

MD_IS_XML_ENCODED_VALUE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="Use XMLCompoundConverter",
               interestedModules=JIAM)
public static final String MD_IS_XML_ENCODED_VALUE

See Also:

Constant Field Values

MD_XML_NODE_NAME

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Used to specify XML node name when it differs from the property name.",
               interestedModules=JIAM)
public static final String MD_XML_NODE_NAME

See Also:

Constant Field Values

MD_XML_CONTAINER_NAME

@MetaDataUsage(dataType=STR,
               target=PROPERTY,
               description="Used to specify XML node name of collection property container.",
               interestedModules=JIAM)
public static final String MD_XML_CONTAINER_NAME

See Also:

Constant Field Values

MD_REQUIRES_LOOKUP_RETRIEVAL

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="false",
               description="Designates properties whose values cannot be retrieved via searches with scopes other than \'base object\' i.e. lookups",
               interestedModules=JIAM)
public static final String MD_REQUIRES_LOOKUP_RETRIEVAL

See Also:

Constant Field Values

MD_IS_COPYABLE

@MetaDataUsage(dataType=BOOL,
               target=PROPERTY,
               defaultValue="true",
               description="Flags whether an association is copyable when the parent object is copied",
               interestedModules={CONXP,GUI_CLIENT})
public static final String MD_IS_COPYABLE

See Also:

Constant Field Values

Constructor Detail

MetaDataDefs

public MetaDataDefs()