public interface VirtualAttributeCfgClient extends ConfigurationClient
Virtual Attributes are responsible for dynamically generating attribute values that appear in entries but are not persistently stored in the backend.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends VirtualAttributeCfgClient,? extends VirtualAttributeCfg> |
definition()
Get the configuration definition associated with this Virtual Attribute.
|
ValueOrExpression<AttributeType> |
getAttributeType()
Gets the "attribute-type" property.
|
SortedSet<ValueOrExpression<Dn>> |
getBaseDn()
Gets the "base-dn" property.
|
ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> |
getConflictBehavior()
Gets the "conflict-behavior" property.
|
SortedSet<ValueOrExpression<String>> |
getFilter()
Gets the "filter" property.
|
SortedSet<ValueOrExpression<Dn>> |
getGroupDn()
Gets the "group-dn" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<VirtualAttributeCfgDefn.Scope> |
getScope()
Gets the "scope" property.
|
ValueOrExpression<Boolean> |
isEnabled()
Gets the "enabled" property.
|
void |
setAttributeType(ValueOrExpression<AttributeType> value)
Sets the "attribute-type" property.
|
void |
setBaseDn(Collection<ValueOrExpression<Dn>> values)
Sets the "base-dn" property.
|
void |
setConflictBehavior(ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> value)
Sets the "conflict-behavior" property.
|
void |
setEnabled(ValueOrExpression<Boolean> value)
Sets the "enabled" property.
|
void |
setFilter(Collection<ValueOrExpression<String>> values)
Sets the "filter" property.
|
void |
setGroupDn(Collection<ValueOrExpression<Dn>> values)
Sets the "group-dn" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setScope(ValueOrExpression<VirtualAttributeCfgDefn.Scope> value)
Sets the "scope" property.
|
commit, properties
ManagedObjectDefinition<? extends VirtualAttributeCfgClient,? extends VirtualAttributeCfg> definition()
definition
in interface ConfigurationClient
ValueOrExpression<AttributeType> getAttributeType()
Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
void setAttributeType(ValueOrExpression<AttributeType> value) throws PropertyException
Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
value
- The value of the "attribute-type" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<Dn>> getBaseDn()
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.
void setBaseDn(Collection<ValueOrExpression<Dn>> values) throws PropertyException
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.
values
- The values of the "base-dn" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> getConflictBehavior()
Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.
void setConflictBehavior(ValueOrExpression<VirtualAttributeCfgDefn.ConflictBehavior> value) throws PropertyException
Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.
value
- The value of the "conflict-behavior" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isEnabled()
Indicates whether the Virtual Attribute is enabled for use.
void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the Virtual Attribute is enabled for use.
value
- The value of the "enabled" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<String>> getFilter()
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.
void setFilter(Collection<ValueOrExpression<String>> values) throws PropertyException
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.
values
- The values of the "filter" property.PropertyException
- If one or more of the new values are invalid.SortedSet<ValueOrExpression<Dn>> getGroupDn()
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.
void setGroupDn(Collection<ValueOrExpression<Dn>> values) throws PropertyException
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.
values
- The values of the "group-dn" property.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<VirtualAttributeCfgDefn.Scope> getScope()
Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.
void setScope(ValueOrExpression<VirtualAttributeCfgDefn.Scope> value) throws PropertyException
Specifies the LDAP scope associated with base DNs for entries that are eligible to use this virtual attribute.
value
- The value of the "scope" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.