Interface VirtualAttributeCfg
-
- All Superinterfaces:
Configuration
- All Known Subinterfaces:
CollectiveAttributeSubentriesVirtualAttributeCfg
,EntityTagVirtualAttributeCfg
,EntryDnVirtualAttributeCfg
,EntryUuidVirtualAttributeCfg
,GoverningStructureRuleVirtualAttributeCfg
,HasSubordinatesVirtualAttributeCfg
,IsMemberOfVirtualAttributeCfg
,MemberVirtualAttributeCfg
,NumSubordinatesVirtualAttributeCfg
,PasswordExpirationTimeVirtualAttributeCfg
,PasswordPolicySubentryVirtualAttributeCfg
,StructuralObjectClassVirtualAttributeCfg
,SubschemaSubentryVirtualAttributeCfg
,UserDefinedVirtualAttributeCfg
public interface VirtualAttributeCfg extends Configuration
A server-side interface for querying Virtual Attribute settings.Virtual Attributes are responsible for dynamically generating attribute values that appear in entries but are not persistently stored in the backend.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addChangeListener(ConfigurationChangeListener<VirtualAttributeCfg> listener)
Register to be notified when this Virtual Attribute is changed.Class<? extends VirtualAttributeCfg>
configurationClass()
Gets the configuration class associated with this Virtual Attribute.AttributeType
getAttributeType()
Gets the "attribute-type" property.SortedSet<Dn>
getBaseDn()
Gets the "base-dn" property.VirtualAttributeCfgDefn.ConflictBehavior
getConflictBehavior()
Gets the "conflict-behavior" property.SortedSet<String>
getFilter()
Gets the "filter" property.SortedSet<Dn>
getGroupDn()
Gets the "group-dn" property.String
getJavaClass()
Gets the "java-class" property.VirtualAttributeCfgDefn.Scope
getScope()
Gets the "scope" property.boolean
isEnabled()
Gets the "enabled" property.void
removeChangeListener(ConfigurationChangeListener<VirtualAttributeCfg> listener)
Deregister an existing Virtual Attribute configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
-
-
-
Method Detail
-
configurationClass
Class<? extends VirtualAttributeCfg> configurationClass()
Gets the configuration class associated with this Virtual Attribute.- Specified by:
configurationClass
in interfaceConfiguration
- Returns:
- Returns the configuration class associated with this Virtual Attribute.
-
addChangeListener
void addChangeListener(ConfigurationChangeListener<VirtualAttributeCfg> listener)
Register to be notified when this Virtual Attribute is changed.- Parameters:
listener
- The Virtual Attribute configuration change listener.
-
removeChangeListener
void removeChangeListener(ConfigurationChangeListener<VirtualAttributeCfg> listener)
Deregister an existing Virtual Attribute configuration change listener.- Parameters:
listener
- The Virtual Attribute configuration change listener.
-
getAttributeType
AttributeType getAttributeType()
Gets the "attribute-type" property.Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
- Returns:
- Returns the value of the "attribute-type" property.
-
getBaseDn
SortedSet<Dn> getBaseDn()
Gets the "base-dn" property.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 an unmodifiable set containing the values of the "base-dn" property.
-
getConflictBehavior
VirtualAttributeCfgDefn.ConflictBehavior getConflictBehavior()
Gets the "conflict-behavior" property.Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.
Default value:
real-overrides-virtual
- Returns:
- Returns the value of the "conflict-behavior" property.
-
isEnabled
boolean isEnabled()
Gets the "enabled" property.Indicates whether the Virtual Attribute is enabled for use.
- Returns:
- Returns the value of the "enabled" property.
-
getFilter
SortedSet<String> getFilter()
Gets the "filter" property.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.
Default value:
(objectClass=*)
- Returns:
- Returns an unmodifiable set containing the values of the "filter" property.
-
getGroupDn
SortedSet<Dn> getGroupDn()
Gets the "group-dn" property.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 an unmodifiable set containing the values of the "group-dn" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
- Returns:
- Returns the value of the "java-class" property.
-
getScope
VirtualAttributeCfgDefn.Scope getScope()
Gets the "scope" property.Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.
Default value:
whole-subtree
- Returns:
- Returns the value of the "scope" property.
-
-