|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.AttributeSyntax<AttributeSyntaxCfg>
org.opends.server.schema.NameFormSyntax
public class NameFormSyntax
This class implements the name form description syntax, which is used to hold name form definitions in the server schema. The format of this syntax is defined in RFC 2252.
Constructor Summary | |
---|---|
NameFormSyntax()
Creates a new instance of this syntax. |
Method Summary | |
---|---|
static NameForm |
decodeNameForm(ByteString value,
Schema schema,
boolean allowUnknownElements)
Decodes the contents of the provided ASN.1 octet string as a name form definition according to the rules of this syntax. |
ApproximateMatchingRule |
getApproximateMatchingRule()
Retrieves the default approximate matching rule that will be used for attributes with this syntax. |
java.lang.String |
getDescription()
Retrieves a description for this attribute syntax. |
EqualityMatchingRule |
getEqualityMatchingRule()
Retrieves the default equality matching rule that will be used for attributes with this syntax. |
java.lang.String |
getOID()
Retrieves the OID for this attribute syntax. |
OrderingMatchingRule |
getOrderingMatchingRule()
Retrieves the default ordering matching rule that will be used for attributes with this syntax. |
SubstringMatchingRule |
getSubstringMatchingRule()
Retrieves the default substring matching rule that will be used for attributes with this syntax. |
java.lang.String |
getSyntaxName()
Retrieves the common name for this attribute syntax. |
void |
initializeSyntax(AttributeSyntaxCfg configuration)
Initializes this attribute syntax based on the information in the provided configuration entry. |
boolean |
valueIsAcceptable(ByteString value,
MessageBuilder invalidReason)
Indicates whether the provided value is acceptable for use in an attribute with this syntax. |
Methods inherited from class org.opends.server.api.AttributeSyntax |
---|
equals, finalizeSyntax, hashCode, isConfigurationAcceptable, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public NameFormSyntax()
initializeSyntax
method.
Method Detail |
---|
public void initializeSyntax(AttributeSyntaxCfg configuration) throws ConfigException, InitializationException
initializeSyntax
in class AttributeSyntax<AttributeSyntaxCfg>
configuration
- The configuration to use to initialize
this attribute syntax.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem occurs during
initialization that is not
related to the server
configuration.public java.lang.String getSyntaxName()
getSyntaxName
in class AttributeSyntax<AttributeSyntaxCfg>
public java.lang.String getOID()
getOID
in class AttributeSyntax<AttributeSyntaxCfg>
public java.lang.String getDescription()
getDescription
in class AttributeSyntax<AttributeSyntaxCfg>
public EqualityMatchingRule getEqualityMatchingRule()
getEqualityMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if equality
matches will not be allowed for this type by default.public OrderingMatchingRule getOrderingMatchingRule()
getOrderingMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if ordering
matches will not be allowed for this type by default.public SubstringMatchingRule getSubstringMatchingRule()
getSubstringMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if
substring matches will not be allowed for this type by
default.public ApproximateMatchingRule getApproximateMatchingRule()
getApproximateMatchingRule
in class AttributeSyntax<AttributeSyntaxCfg>
null
if
approximate matches will not be allowed for this type by
default.public boolean valueIsAcceptable(ByteString value, MessageBuilder invalidReason)
valueIsAcceptable
in class AttributeSyntax<AttributeSyntaxCfg>
value
- The value for which to make the
determination.invalidReason
- The buffer to which the invalid reason
should be appended.
true
if the provided value is acceptable for use
with this syntax, or false
if not.public static NameForm decodeNameForm(ByteString value, Schema schema, boolean allowUnknownElements) throws DirectoryException
value
- The ASN.1 octet string containing the value
to decode (it does not need to be
normalized).schema
- The schema to use to resolve references to
other schema elements.allowUnknownElements
- Indicates whether to allow values that
reference a structural objectclass and/or
required or optional attribute types which
are not defined in the server schema. This
should only be true when called by
valueIsAcceptable
.
DirectoryException
- If the provided value cannot be decoded as an
name form definition.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |