@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class DITContentRule extends Object implements SchemaFileElement
Constructor and Description |
---|
DITContentRule(String definition,
ObjectClass structuralClass,
Map<String,String> names,
String description,
Set<ObjectClass> auxiliaryClasses,
Set<AttributeType> requiredAttributes,
Set<AttributeType> optionalAttributes,
Set<AttributeType> prohibitedAttributes,
boolean isObsolete,
Map<String,List<String>> extraProperties)
Creates a new DIT content rule definition with the provided
information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Indicates whether the provided object is equal to this DIT
content rule.
|
Set<ObjectClass> |
getAuxiliaryClasses()
Retrieves the set of auxiliary objectclasses that may be used for
entries associated with this DIT content rule.
|
Map<String,List<String>> |
getExtraProperties()
Retrieves a mapping between the names of any extra non-standard
properties that may be associated with this DIT content rule and
the value for that property.
|
String |
getNameOrOID()
Retrieves the primary name to use to reference this DIT content
rule.
|
Map<String,String> |
getNames()
Retrieves the set of names that may be used to reference this DIT
content rule.
|
Set<AttributeType> |
getOptionalAttributes()
Retrieves the set of optional attributes for this DIT content
rule.
|
Set<AttributeType> |
getProhibitedAttributes()
Retrieves the set of prohibited attributes for this DIT content
rule.
|
Set<AttributeType> |
getRequiredAttributes()
Retrieves the set of required attributes for this DIT content
rule.
|
ObjectClass |
getStructuralClass()
Retrieves the structural objectclass for this DIT content rule.
|
int |
hashCode()
Retrieves the hash code for this DIT content rule.
|
boolean |
hasName(String lowerName)
Indicates whether the provided lowercase name may be used to
reference this DIT content rule.
|
boolean |
isObsolete()
Indicates whether this DIT content rule is declared "obsolete".
|
boolean |
isOptional(AttributeType attributeType)
Indicates whether the provided attribute type is included in the
optional attribute list for this DIT content rule.
|
boolean |
isRequired(AttributeType attributeType)
Indicates whether the provided attribute type is included in the
required attribute list for this DIT content rule.
|
boolean |
isRequiredOrOptional(AttributeType attributeType)
Indicates whether the provided attribute type is in the list of
required or optional attributes for this DIT content rule.
|
String |
toString()
Retrieves the string representation of this DIT content rule in
the form specified in RFC 2252.
|
public DITContentRule(String definition, ObjectClass structuralClass, Map<String,String> names, String description, Set<ObjectClass> auxiliaryClasses, Set<AttributeType> requiredAttributes, Set<AttributeType> optionalAttributes, Set<AttributeType> prohibitedAttributes, boolean isObsolete, Map<String,List<String>> extraProperties)
definition
- The definition string used to
create this DIT content rule. It
must not be null
.structuralClass
- The structural objectclass for this
DIT content rule. It must not be
null
.names
- The set of names that may be used
to reference this DIT content rule.description
- The description for this DIT
content rule.auxiliaryClasses
- The set of auxiliary classes for
this DIT content rulerequiredAttributes
- The set of required attribute types
for this DIT content rule.optionalAttributes
- The set of optional attribute types
for this DIT content rule.prohibitedAttributes
- The set of prohibited attribute
types for this DIT content rule.isObsolete
- Indicates whether this DIT content
rule is declared "obsolete".extraProperties
- A set of extra properties for this
DIT content rule.public ObjectClass getStructuralClass()
public Map<String,String> getNames()
public String getNameOrOID()
null
if there is none.public boolean hasName(String lowerName)
lowerName
- The name for which to make the determination,
in all lowercase characters.true
if the provided lowercase name may be used
to reference this DIT content rule, or false
if
not.public Set<ObjectClass> getAuxiliaryClasses()
public Set<AttributeType> getRequiredAttributes()
public boolean isRequired(AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.true
if the provided attribute type is required
by this DIT content rule, or false
if not.public Set<AttributeType> getOptionalAttributes()
public boolean isOptional(AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.true
if the provided attribute type is optional
for this DIT content rule, or false
if not.public boolean isRequiredOrOptional(AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.true
if the provided attribute type is required
or allowed for this DIT content rule, or false
if it is not.public Set<AttributeType> getProhibitedAttributes()
public boolean isObsolete()
true
if this DIT content rule is declared
"obsolete", or false
if it is not.public Map<String,List<String>> getExtraProperties()
getExtraProperties
in interface SchemaFileElement
public boolean equals(Object o)
public int hashCode()
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.