Class VirtualAttributeCfgDefn


  • public final class VirtualAttributeCfgDefn
    extends ManagedObjectDefinition<VirtualAttributeCfgClient,​VirtualAttributeCfg>
    An interface for querying the Virtual Attribute managed object definition meta information.

    Virtual Attributes are responsible for dynamically generating attribute values that appear in entries but are not persistently stored in the backend.

    • Method Detail

      • getInstance

        public static VirtualAttributeCfgDefn getInstance()
        Get the Virtual Attribute configuration definition singleton.
        Returns:
        Returns the Virtual Attribute configuration definition singleton.
      • getAttributeTypePropertyDefinition

        public AttributeTypePropertyDefinition getAttributeTypePropertyDefinition()
        Get the "attribute-type" property definition.

        Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.

        Returns:
        Returns the "attribute-type" property definition.
      • getBaseDnPropertyDefinition

        public DnPropertyDefinition getBaseDnPropertyDefinition()
        Get the "base-dn" property definition.

        Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

        If no values are given, then the server generates virtual attributes anywhere in the server.

        Returns:
        Returns the "base-dn" property definition.
      • getConflictBehaviorPropertyDefinition

        public EnumPropertyDefinition<VirtualAttributeCfgDefn.ConflictBehavior> getConflictBehaviorPropertyDefinition()
        Get the "conflict-behavior" property definition.

        Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.

        Returns:
        Returns the "conflict-behavior" property definition.
      • getEnabledPropertyDefinition

        public BooleanPropertyDefinition getEnabledPropertyDefinition()
        Get the "enabled" property definition.

        Indicates whether the Virtual Attribute is enabled for use.

        Returns:
        Returns the "enabled" property definition.
      • getFilterPropertyDefinition

        public StringPropertyDefinition getFilterPropertyDefinition()
        Get the "filter" property definition.

        Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

        If no values are given, then any entry is eligible to have the value generated. If one or more filters are specified, then only entries that match at least one of those filters are allowed to have the virtual attribute.

        Returns:
        Returns the "filter" property definition.
      • getGroupDnPropertyDefinition

        public DnPropertyDefinition getGroupDnPropertyDefinition()
        Get the "group-dn" property definition.

        Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

        If no values are given, then group membership is not taken into account when generating the virtual attribute. If one or more group DNs are specified, then only members of those groups are allowed to have the virtual attribute.

        Returns:
        Returns the "group-dn" property definition.
      • getJavaClassPropertyDefinition

        public ClassPropertyDefinition getJavaClassPropertyDefinition()
        Get the "java-class" property definition.

        Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.

        Returns:
        Returns the "java-class" property definition.
      • getScopePropertyDefinition

        public EnumPropertyDefinition<VirtualAttributeCfgDefn.Scope> getScopePropertyDefinition()
        Get the "scope" property definition.

        Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.

        Returns:
        Returns the "scope" property definition.