|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.DITContentRule
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class DITContentRule
This class defines a DIT content rule, which defines the set of allowed, required, and prohibited attributes for entries with a given structural objectclass, and also indicates which auxiliary classes that may be included in the entry.
Constructor Summary | |
---|---|
DITContentRule(java.lang.String definition,
ObjectClass structuralClass,
java.util.Map<java.lang.String,java.lang.String> names,
java.lang.String description,
java.util.Set<ObjectClass> auxiliaryClasses,
java.util.Set<AttributeType> requiredAttributes,
java.util.Set<AttributeType> optionalAttributes,
java.util.Set<AttributeType> prohibitedAttributes,
boolean isObsolete,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> extraProperties)
Creates a new DIT content rule definition with the provided information. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this DIT content rule. |
java.util.Set<ObjectClass> |
getAuxiliaryClasses()
Retrieves the set of auxiliary objectclasses that may be used for entries associated with this DIT content rule. |
java.lang.String |
getDefinition()
Retrieves the definition string used to create this DIT content rule. |
java.lang.String |
getDescription()
Retrieves the description for this DIT content rule. |
java.util.Map<java.lang.String,java.util.List<java.lang.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. |
java.util.List<java.lang.String> |
getExtraProperty(java.lang.String propertyName)
Retrieves the value of the specified "extra" property for this DIT content rule. |
java.lang.String |
getName()
Retrieves the primary name to use to reference this DIT content rule. |
java.util.Map<java.lang.String,java.lang.String> |
getNames()
Retrieves the set of names that may be used to reference this DIT content rule. |
java.util.Set<AttributeType> |
getOptionalAttributes()
Retrieves the set of optional attributes for this DIT content rule. |
java.util.Set<AttributeType> |
getProhibitedAttributes()
Retrieves the set of prohibited attributes for this DIT content rule. |
java.util.Set<AttributeType> |
getRequiredAttributes()
Retrieves the set of required attributes for this DIT content rule. |
java.lang.String |
getSchemaFile()
Retrieves the name of the schema file that contains the definition 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(java.lang.String lowerName)
Indicates whether the provided lowercase name may be used to reference this DIT content rule. |
boolean |
isAllowedAuxiliaryClass(ObjectClass auxiliaryClass)
Indicates whether the provided auxiliary objectclass is allowed for use by 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 |
isProhibited(AttributeType attributeType)
Indicates whether the provided attribute type is included in the prohibited 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. |
boolean |
isRequiredOrOptional(AttributeType attributeType,
boolean acceptEmpty)
Indicates whether the provided attribute type is in the list of required or optional attributes for this DIT content rule. |
DITContentRule |
recreateFromDefinition()
Creates a new instance of this DIT content rule based on the definition string. |
void |
setExtraProperty(java.lang.String name,
java.util.List<java.lang.String> values)
Specifies the provided "extra" property for this DIT content rule. |
void |
setExtraProperty(java.lang.String name,
java.lang.String value)
Specifies the provided "extra" property for this DIT content rule. |
void |
setSchemaFile(java.lang.String schemaFile)
Specifies the name of the schema file that contains the definition for this DIT content rule. |
java.lang.String |
toString()
Retrieves the string representation of this DIT content rule in the form specified in RFC 2252. |
void |
toString(java.lang.StringBuilder buffer,
boolean includeFileElement)
Appends a string representation of this attribute type in the form specified in RFC 2252 to the provided buffer. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DITContentRule(java.lang.String definition, ObjectClass structuralClass, java.util.Map<java.lang.String,java.lang.String> names, java.lang.String description, java.util.Set<ObjectClass> auxiliaryClasses, java.util.Set<AttributeType> requiredAttributes, java.util.Set<AttributeType> optionalAttributes, java.util.Set<AttributeType> prohibitedAttributes, boolean isObsolete, java.util.Map<java.lang.String,java.util.List<java.lang.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.Method Detail |
---|
public java.lang.String getDefinition()
getDefinition
in interface SchemaFileElement
public DITContentRule recreateFromDefinition() throws DirectoryException
recreateFromDefinition
in interface SchemaFileElement
DirectoryException
- If a problem occurs while attempting
to create a new DIT content rule
instance from the definition string.public ObjectClass getStructuralClass()
public java.util.Map<java.lang.String,java.lang.String> getNames()
public java.lang.String getName()
null
if there is none.public boolean hasName(java.lang.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 java.lang.String getSchemaFile()
getSchemaFile
in interface SchemaFileElement
null
if it is not
known or if it is not stored in any schema file.public void setSchemaFile(java.lang.String schemaFile)
setSchemaFile
in interface SchemaFileElement
schemaFile
- The name of the schema file that contains the
definition for this DIT content rule.public java.lang.String getDescription()
null
if there is none.public java.util.Set<ObjectClass> getAuxiliaryClasses()
public boolean isAllowedAuxiliaryClass(ObjectClass auxiliaryClass)
auxiliaryClass
- The auxiliary objectclass for which to
make the determination.
true
if the provided auxiliary objectclass is
allowed for use by this DIT content rule, or
false
if not.public java.util.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 java.util.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 boolean isRequiredOrOptional(AttributeType attributeType, boolean acceptEmpty)
attributeType
- The attribute type for which to make the
determination.acceptEmpty
- Indicates whether an empty list of
required or optional attributes should be
taken to indicate that all attributes
allowed for an objectclass will be
acceptable.
true
if the provided attribute type is required
or allowed for this DIT content rule, or false
if it is not.public java.util.Set<AttributeType> getProhibitedAttributes()
public boolean isProhibited(AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.
true
if the provided attribute type is
prohibited for this DIT content rule, or false
if not.public boolean isObsolete()
true
if this DIT content rule is declared
"obsolete", or false
if it is not.public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getExtraProperties()
public java.util.List<java.lang.String> getExtraProperty(java.lang.String propertyName)
propertyName
- The name of the "extra" property for which
to retrieve the value.
null
if no such property is
defined.public void setExtraProperty(java.lang.String name, java.lang.String value)
name
- The name for the "extra" property. It must not be
null
.value
- The value for the "extra" property, or
null
if the property is to be removed.public void setExtraProperty(java.lang.String name, java.util.List<java.lang.String> values)
name
- The name for the "extra" property. It must not
be null
.values
- The set of value for the "extra" property, or
null
if the property is to be removed.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is equal to
this DIT content rule, or false
if not.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer, boolean includeFileElement)
buffer
- The buffer to which the information
should be appended.includeFileElement
- Indicates whether to include an
"extra" property that specifies the
path to the schema file from which
this DIT content rule was loaded.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |