org.apache.directory.api.ldap.model.schema.parsers

Class OpenLdapSchemaParser

java.lang.Object

org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser<SchemaObject>

org.apache.directory.api.ldap.model.schema.parsers.OpenLdapSchemaParser

public class OpenLdapSchemaParser
extends AbstractSchemaParser<SchemaObject>

A reusable wrapper for antlr generated OpenLDAP schema parsers.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<MutableAttributeType>	attributeTypes The list of attribute type, initialized by splitParsedSchemaDescriptions()
private boolean	isResolveObjectIdentifierMacros Flag whether object identifier macros should be resolved.
private java.util.List<ObjectClass>	objectClasses The list of object classes, initialized by splitParsedSchemaDescriptions()
private java.util.Map<java.lang.String,OpenLdapObjectIdentifierMacro>	objectIdentifierMacros The map of object identifier macros, initialized by splitParsedSchemaDescriptions()
private java.util.List<java.lang.Object>	schemaDescriptions The list of parsed schema descriptions

Fields inherited from class org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser

lexer, LOG, monitor, parser

Constructor Summary

Constructors

Constructor and Description
OpenLdapSchemaParser() Creates a reusable instance of an OpenLdapSchemaParser.

Method Summary

Modifier and Type	Method and Description
private void	afterParse() Splits parsed schema descriptions and resolved object identifier macros.
void	clear() Reset the parser
protected SchemaObject	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
java.util.List<MutableAttributeType>	getAttributeTypes() Gets the attribute types.
java.util.List<ObjectClass>	getObjectClassTypes() Gets the object class types.
java.util.Map<java.lang.String,OpenLdapObjectIdentifierMacro>	getObjectIdentifierMacros() Gets the object identifier macros.
private java.lang.String	getResolveOid(java.lang.String oid)
private void	invokeParser(java.lang.String subject)
boolean	isResolveObjectIdentifierMacros() Checks if object identifier macros should be resolved.
void	parse(java.io.File schemaFile) Parses a file of OpenLDAP schemaObject elements/objects.
void	parse(java.io.InputStream schemaIn) Parses a stream of OpenLDAP schemaObject elements/objects.
SchemaObject	parse(java.lang.String schemaObject) Parses an OpenLDAP schemaObject element/object.
private void	resolveObjectIdentifierMacro(OpenLdapObjectIdentifierMacro macro)
void	setResolveObjectIdentifierMacros(boolean resolveObjectIdentifierMacros) Sets if object identifier macros should be resolved.

Methods inherited from class org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser

isQuirksMode, reset, setParserMonitor, setQuirksMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

schemaDescriptions

private java.util.List<java.lang.Object> schemaDescriptions

The list of parsed schema descriptions

attributeTypes

private java.util.List<MutableAttributeType> attributeTypes

The list of attribute type, initialized by splitParsedSchemaDescriptions()

objectClasses

private java.util.List<ObjectClass> objectClasses

The list of object classes, initialized by splitParsedSchemaDescriptions()

objectIdentifierMacros

private java.util.Map<java.lang.String,OpenLdapObjectIdentifierMacro> objectIdentifierMacros

The map of object identifier macros, initialized by splitParsedSchemaDescriptions()

isResolveObjectIdentifierMacros

private boolean isResolveObjectIdentifierMacros

Flag whether object identifier macros should be resolved.

Constructor Detail

OpenLdapSchemaParser

public OpenLdapSchemaParser()
                     throws java.io.IOException

Creates a reusable instance of an OpenLdapSchemaParser.

Throws:

java.io.IOException - if the pipe cannot be formed

Method Detail

doParse

protected SchemaObject doParse()
                        throws antlr.RecognitionException,
                               antlr.TokenStreamException

Description copied from class: AbstractSchemaParser

Parse a SchemaObject description and returns back an instance of SchemaObject.

Specified by:

doParse in class AbstractSchemaParser<SchemaObject>

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception

clear

public void clear()

Reset the parser

getAttributeTypes

public java.util.List<MutableAttributeType> getAttributeTypes()

Gets the attribute types.

Returns:

the attribute types

getObjectClassTypes

public java.util.List<ObjectClass> getObjectClassTypes()

Gets the object class types.

Returns:

the object class types

getObjectIdentifierMacros

public java.util.Map<java.lang.String,OpenLdapObjectIdentifierMacro> getObjectIdentifierMacros()

Gets the object identifier macros.

Returns:

the object identifier macros

afterParse

private void afterParse()
                 throws java.text.ParseException

Splits parsed schema descriptions and resolved object identifier macros.

Throws:

java.text.ParseException - the parse exception

getResolveOid

private java.lang.String getResolveOid(java.lang.String oid)

resolveObjectIdentifierMacro

private void resolveObjectIdentifierMacro(OpenLdapObjectIdentifierMacro macro)
                                   throws java.text.ParseException

Throws:

java.text.ParseException

parse

public SchemaObject parse(java.lang.String schemaObject)
                   throws java.text.ParseException

Parses an OpenLDAP schemaObject element/object.

Overrides:

parse in class AbstractSchemaParser<SchemaObject>

Parameters:

schemaObject - the String image of a complete schema object

Returns:

the schema object

Throws:

java.text.ParseException - If the schemaObject can't be parsed

invokeParser

private void invokeParser(java.lang.String subject)
                   throws java.text.ParseException

Throws:

java.text.ParseException

parse

public void parse(java.io.InputStream schemaIn)
           throws java.io.IOException,
                  java.text.ParseException

Parses a stream of OpenLDAP schemaObject elements/objects. Default charset is used.

Parameters:

schemaIn - a stream of schema objects

Throws:

java.io.IOException - If the schemaObject can't be transformed to a byteArrayInputStream

java.text.ParseException - If the schemaObject can't be parsed

parse

public void parse(java.io.File schemaFile)
           throws java.io.IOException,
                  java.text.ParseException

Parses a file of OpenLDAP schemaObject elements/objects. Default charset is used.

Parameters:

schemaFile - a file of schema objects

Throws:

java.io.IOException - If the schemaObject can't be transformed to a byteArrayInputStream

java.text.ParseException - If the schemaObject can't be parsed

isResolveObjectIdentifierMacros

public boolean isResolveObjectIdentifierMacros()

Checks if object identifier macros should be resolved.

Returns:

true, object identifier macros should be resolved.

setResolveObjectIdentifierMacros

public void setResolveObjectIdentifierMacros(boolean resolveObjectIdentifierMacros)

Sets if object identifier macros should be resolved.

Parameters:

resolveObjectIdentifierMacros - true if object identifier macros should be resolved