@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class VirtualAttributeRule extends Object
Constructor and Description |
---|
VirtualAttributeRule(AttributeType attributeType,
VirtualAttributeProvider<? extends VirtualAttributeCfg> provider,
Set<Dn> baseDNs,
SearchScope scope,
Set<Dn> groupDNs,
Set<SearchFilter> anyFilter,
VirtualAttributeCfgDefn.ConflictBehavior conflictBehavior)
Creates a new virtual attribute rule with the provided information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
appliesToEntry(Entry entry)
Indicates whether this virtual attribute rule applies to the provided entry, taking into account the eligibility
requirements defined in the rule.
|
Attribute |
getAttribute(Entry entry)
Generates an attribute with the values for the provided entry.
|
AttributeDescription |
getAttributeDescription()
Retrieves the attribute description for which the values should be generated.
|
Set<Dn> |
getBaseDNs()
Retrieves the set of base DNs for branches that are eligible to have this virtual attribute.
|
VirtualAttributeCfgDefn.ConflictBehavior |
getConflictBehavior()
Retrieves the behavior that the server should exhibit for entries that already have one or more real values for
the target attribute.
|
Set<Dn> |
getGroupDNs()
Retrieves the set of DNs for groups whose members are eligible to have this virtual attribute.
|
VirtualAttributeProvider<? extends VirtualAttributeCfg> |
getProvider()
Retrieves the virtual attribute provider used to generate the values.
|
SearchScope |
getScope()
Retrieves the scope of entries in the base DNs that are eligible to have this virtual attribute.
|
String |
toString() |
public VirtualAttributeRule(AttributeType attributeType, VirtualAttributeProvider<? extends VirtualAttributeCfg> provider, Set<Dn> baseDNs, SearchScope scope, Set<Dn> groupDNs, Set<SearchFilter> anyFilter, VirtualAttributeCfgDefn.ConflictBehavior conflictBehavior)
attributeType
- The attribute type for which the values should be generated.provider
- The virtual attribute provider to use to generate the values.baseDNs
- The set of base DNs for branches that are eligible to have this virtual attribute.scope
- The scope of entries, related to the base DNs, that are eligible to have this virtual attribute.groupDNs
- The set of DNs for groups whose members are eligible to have this virtual attribute.anyFilter
- The set of search filters for entries that are eligible to have this virtual attribute.conflictBehavior
- The behavior that the server should exhibit for entries that already have one or more real values for
the target attribute.public Attribute getAttribute(Entry entry)
entry
- The entry for which the values are to be generated.null
(maybe empty) attribute with the values generated for the provided entry.public AttributeDescription getAttributeDescription()
public VirtualAttributeProvider<? extends VirtualAttributeCfg> getProvider()
public Set<Dn> getBaseDNs()
public SearchScope getScope()
public Set<Dn> getGroupDNs()
public VirtualAttributeCfgDefn.ConflictBehavior getConflictBehavior()
public boolean appliesToEntry(Entry entry)
entry
- The entry for which to make the determination.true
if this virtual attribute rule may be used to generate values for the entry, or
false
if not.Copyright 2010-2018 ForgeRock AS.