|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.schema.DescriptionUtils
public class DescriptionUtils
Utility class used to generate schema object specifications. Some of the latest work coming out of the LDAPBIS working body adds optional extensions to these syntaxes. We have not yet added extension support to these functions or the schema interfaces in this package. Descriptions can be generated for the following objects:
Constructor Summary | |
---|---|
DescriptionUtils()
|
Method Summary | |
---|---|
static String |
getDescription(AttributeType attributeType)
Generates the description using the AttributeTypeDescription as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.3. |
static String |
getDescription(DITContentRule dITContentRule)
Generates the DITContentRuleDescription for a DITContentRule as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.16. |
static String |
getDescription(DITStructureRule dITStructureRule)
Generates the DITStructureRuleDescription for a DITStructureRule as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.17. |
static String |
getDescription(MatchingRule matchingRule)
Generates the MatchingRuleDescription for a MatchingRule as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.30. |
static String |
getDescription(MatchingRuleUse matchingRuleUse)
Generates the MatchingRuleUseDescription for a MatchingRuleUse as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.31. |
static String |
getDescription(NameForm nameForm)
Generates the NameFormDescription for a NameForm as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.35. |
static String |
getDescription(ObjectClass objectClass)
Generates the ObjectClassDescription for an ObjectClass as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.37. |
static String |
getDescription(Syntax syntax)
Generates the SyntaxDescription for a Syntax as defined by the syntax: 1.3.6.1.4.1.1466.115.121.1.54. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DescriptionUtils()
Method Detail |
---|
public static String getDescription(AttributeType attributeType) throws NamingException
AttributeTypeDescription = "(" whsp numericoid whsp ; AttributeType identifier [ "NAME" qdescrs ] ; name used in AttributeType [ "DESC" qdstring ] ; description [ "OBSOLETE" whsp ] [ "SUP" woid ] ; derived from parent AttributeType [ "EQUALITY" woid ; Matching Rule name [ "ORDERING" woid ; Matching Rule name [ "SUBSTR" woid ] ; Matching Rule name [ "SYNTAX" whsp noidlen whsp ] ; see section 4.3 RFC 2252 [ "SINGLE-VALUE" whsp ] ; default multi-valued [ "COLLECTIVE" whsp ] ; default not collective [ "NO-USER-MODIFICATION" whsp ]; default user modifiable [ "USAGE" whsp AttributeUsage ]; default userApplications whsp ")"
attributeType
- the attributeType to generate a description for
NamingException
public static String getDescription(DITContentRule dITContentRule) throws NamingException
DITContentRuleDescription = "(" numericoid ; Structural ObjectClass identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" ] [ "AUX" oids ] ; Auxiliary ObjectClasses [ "MUST" oids ] ; AttributeType identifiers [ "MAY" oids ] ; AttributeType identifiers [ "NOT" oids ] ; AttributeType identifiers ")"
dITContentRule
- the DIT content rule specification
NamingException
public static String getDescription(MatchingRule matchingRule) throws NamingException
MatchingRuleDescription = "(" whsp numericoid whsp ; MatchingRule object identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" whsp ] "SYNTAX" numericoid whsp ")"
matchingRule
- the MatchingRule to generate the description for
NamingException
public static String getDescription(MatchingRuleUse matchingRuleUse) throws NamingException
MatchingRuleUseDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "APPLIES" SP oids ; attribute types extensions WSP RPAREN ; extensions where: [numericoid] is the object identifier of the matching rule associated with this matching rule use description; NAME [qdescrs] are short names (descriptors) identifying this matching rule use; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this matching rule use is not active; APPLIES provides a list of attribute types the matching rule applies to; and [extensions] describe extensions.
matchingRuleUse
- The matching rule from which we want to generate
a MatchingRuleUseDescription.
NamingException
public static String getDescription(NameForm nameForm) throws NamingException
NameFormDescription = "(" whsp numericoid whsp ; NameForm identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" whsp ] "OC" woid ; Structural ObjectClass "MUST" oids ; AttributeTypes [ "MAY" oids ] ; AttributeTypes whsp ")"
nameForm
- the NameForm to generate the description for
NamingException
public static String getDescription(ObjectClass objectClass) throws NamingException
ObjectClassDescription = "(" whsp numericoid whsp ; ObjectClass identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" whsp ] [ "SUP" oids ] ; Superior ObjectClasses [ ( "ABSTRACT" / "STRUCTURAL" / "AUXILIARY" ) whsp ] ; default structural [ "MUST" oids ] ; AttributeTypes [ "MAY" oids ] ; AttributeTypes whsp ")"
objectClass
- the ObjectClass to generate a description for
NamingException
public static String getDescription(DITStructureRule dITStructureRule) throws NamingException
DITStructureRuleDescription = "(" whsp ruleidentifier whsp ; DITStructureRule identifier [ "NAME" qdescrs ] [ "DESC" qdstring ] [ "OBSOLETE" whsp ] "FORM" woid whsp ; NameForm [ "SUP" ruleidentifiers whsp ]; superior DITStructureRules ")"
dITStructureRule
- the DITStructureRule to generate the description for
NamingException
public static String getDescription(Syntax syntax)
SyntaxDescription = "(" whsp numericoid whsp [ "DESC" qdstring ] whsp ")"
syntax
- the Syntax to generate a description for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |