Package org.forgerock.opendj.server.config.meta

Class MemberVirtualAttributeCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<MemberVirtualAttributeCfgClient,MemberVirtualAttributeCfg>
org.forgerock.opendj.server.config.meta.MemberVirtualAttributeCfgDefn
public final class MemberVirtualAttributeCfgDefn extends ManagedObjectDefinition<MemberVirtualAttributeCfgClient,MemberVirtualAttributeCfg>
An interface for querying the Member Virtual Attribute managed object definition meta information.

The Member Virtual Attribute generates a member or uniqueMember attribute whose values are the DNs of the members of a specified virtual static group.

  • Method Details

    • getInstance

      public static MemberVirtualAttributeCfgDefn getInstance()
      Get the Member Virtual Attribute configuration definition singleton.
      Returns:
      Returns the Member Virtual Attribute configuration definition singleton.

    • createClientConfiguration

      public MemberVirtualAttributeCfgClient createClientConfiguration(ManagedObject<? extends MemberVirtualAttributeCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<MemberVirtualAttributeCfgClient,MemberVirtualAttributeCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public MemberVirtualAttributeCfg createServerConfiguration(ServerManagedObject<? extends MemberVirtualAttributeCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<MemberVirtualAttributeCfgClient,MemberVirtualAttributeCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<MemberVirtualAttributeCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<MemberVirtualAttributeCfgClient,MemberVirtualAttributeCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getAllowRetrievingMembershipPropertyDefinition

      public BooleanPropertyDefinition getAllowRetrievingMembershipPropertyDefinition()
      Get the "allow-retrieving-membership" property definition.

      Indicates whether to handle requests that request all values for the virtual attribute.

      This operation can be very expensive in some cases and is not consistent with the primary function of virtual static groups, which is to make it possible to use static group idioms to determine whether a given user is a member. If this attribute is set to false, attempts to retrieve the entire set of values receive an empty set, and only attempts to determine whether the attribute has a specific value or set of values (which is the primary anticipated use for virtual static groups) are handled properly.

      Returns:
      Returns the "allow-retrieving-membership" property definition.

    • 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 Member 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.