org.apache.directory.api.dsmlv2.response

Class Dsmlv2ResponseGrammar

java.lang.Object

org.apache.directory.api.dsmlv2.AbstractGrammar

org.apache.directory.api.dsmlv2.response.Dsmlv2ResponseGrammar

All Implemented Interfaces:

Grammar

public final class Dsmlv2ResponseGrammar
extends AbstractGrammar
implements Grammar

This Class represents the DSMLv2 Response Grammar

Field Summary

Fields

Modifier and Type	Field and Description
private GrammarAction	addResponseCreation GrammarAction that creates the Add Response
private GrammarAction	authResponseCreation GrammarAction that creates the Auth Response
private GrammarAction	batchResponseCreation GrammarAction that creates the Batch Response
private GrammarAction	compareResponseCreation GrammarAction that creates the Compare Response
private GrammarAction	delResponseCreation GrammarAction that creates the Del Response
private static java.util.Set<java.lang.String>	DSMLV2_DESCR_TAGS The DSMLv2 description tags
private static GrammarAction	ERROR_RESPONSE_ADD_DETAIL GrammarAction that adds Detail to an Error Response
private GrammarAction	errorResponseAddMessage GrammarAction that adds Message to an Error Response
private GrammarAction	errorResponseCreation GrammarAction that creates the Error Response
private GrammarAction	extendedResponseAddErrorMessage GrammarAction that creates the Search Response
private GrammarAction	extendedResponseAddReferral GrammarAction that adds a Referral to an Extended Response
private GrammarAction	extendedResponseAddResponse GrammarAction that adds a Response to an Extended Response
private GrammarAction	extendedResponseAddResponseName GrammarAction that adds a Response Name to an Extended Response
private GrammarAction	extendedResponseAddResultCode GrammarAction that adds Result Code to an Extended Response
private GrammarAction	extendedResponseCreation GrammarAction that creates the Extended Response
private static Dsmlv2ResponseGrammar	instance The instance of grammar.
private GrammarAction	ldapResultAddErrorMessage GrammarAction that adds a Error Message to a LDAP Result
private GrammarAction	ldapResultAddReferral GrammarAction that adds a Referral to a LDAP Result
private GrammarAction	ldapResultAddResultCode GrammarAction that adds a Result Code to a LDAP Result
private GrammarAction	ldapResultControlCreation GrammarAction that creates a Control for LDAP Result
private GrammarAction	ldapResultControlValueCreation GrammarAction that creates a Control Value for LDAP Result
private GrammarAction	modDNResponseCreation GrammarAction that creates the Mod Dn Response
private GrammarAction	modifyResponseCreation GrammarAction that creates the Modify Response
private GrammarAction	searchResponseCreation GrammarAction that creates the Search Response
private GrammarAction	searchResultDoneCreation GrammarAction that creates a Search Result Done
private GrammarAction	searchResultEntryAddAttr GrammarAction that adds an Attr to a Search Result Entry
private GrammarAction	searchResultEntryAddValue GrammarAction that adds a Value to an Attr of a Search Result Entry
private GrammarAction	searchResultEntryControlCreation GrammarAction that creates a Control for Search Result Entry
private GrammarAction	searchResultEntryControlValueCreation GrammarAction that creates a Control Value for Search Result Entry
private GrammarAction	searchResultEntryCreation GrammarAction that creates a Search Result Entry
private GrammarAction	searchResultReferenceAddRef GrammarAction that adds a Ref to a Search Result Reference
private GrammarAction	searchResultReferenceControlCreation GrammarAction that creates a Control for Search Result Entry
private GrammarAction	searchResultReferenceControlValueCreation GrammarAction that creates a Control Value for Search Result Reference
private GrammarAction	searchResultReferenceCreation GrammarAction that creates a Search Result Reference

Fields inherited from class org.apache.directory.api.dsmlv2.AbstractGrammar

name, transitions

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Dsmlv2ResponseGrammar()

Method Summary

Modifier and Type	Method and Description
private void	createAndAddControl(Dsmlv2Container container, AbstractDsmlMessageDecorator<? extends Message> parent) Creates a Control parsing the current node and adds it to the given parent
private void	createAndAddControlValue(Dsmlv2Container container, AbstractDsmlMessageDecorator<? extends Message> parent) Creates a Control Value parsing the current node and adds it to the given parent
static Dsmlv2ResponseGrammar	getInstance() Get the instance of this grammar

Methods inherited from class org.apache.directory.api.dsmlv2.AbstractGrammar

executeAction, getName, getStatesEnum, getTransition, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.dsmlv2.Grammar

executeAction, getName, getStatesEnum, setName

Field Detail

instance

private static Dsmlv2ResponseGrammar instance

The instance of grammar. Dsmlv2ResponseGrammar is a singleton

DSMLV2_DESCR_TAGS

private static final java.util.Set<java.lang.String> DSMLV2_DESCR_TAGS

The DSMLv2 description tags

batchResponseCreation

private final GrammarAction batchResponseCreation

GrammarAction that creates the Batch Response

addResponseCreation

private final GrammarAction addResponseCreation

GrammarAction that creates the Add Response

authResponseCreation

private final GrammarAction authResponseCreation

GrammarAction that creates the Auth Response

compareResponseCreation

private final GrammarAction compareResponseCreation

GrammarAction that creates the Compare Response

delResponseCreation

private final GrammarAction delResponseCreation

GrammarAction that creates the Del Response

modifyResponseCreation

private final GrammarAction modifyResponseCreation

GrammarAction that creates the Modify Response

modDNResponseCreation

private final GrammarAction modDNResponseCreation

GrammarAction that creates the Mod Dn Response

extendedResponseCreation

private final GrammarAction extendedResponseCreation

GrammarAction that creates the Extended Response

errorResponseCreation

private final GrammarAction errorResponseCreation

GrammarAction that creates the Error Response

errorResponseAddMessage

private final GrammarAction errorResponseAddMessage

GrammarAction that adds Message to an Error Response

ERROR_RESPONSE_ADD_DETAIL

private static final GrammarAction ERROR_RESPONSE_ADD_DETAIL

GrammarAction that adds Detail to an Error Response

ldapResultControlCreation

private final GrammarAction ldapResultControlCreation

GrammarAction that creates a Control for LDAP Result

searchResultEntryControlCreation

private final GrammarAction searchResultEntryControlCreation

GrammarAction that creates a Control for Search Result Entry

searchResultReferenceControlCreation

private final GrammarAction searchResultReferenceControlCreation

GrammarAction that creates a Control for Search Result Entry

ldapResultControlValueCreation

private final GrammarAction ldapResultControlValueCreation

GrammarAction that creates a Control Value for LDAP Result

searchResultEntryControlValueCreation

private final GrammarAction searchResultEntryControlValueCreation

GrammarAction that creates a Control Value for Search Result Entry

searchResultReferenceControlValueCreation

private final GrammarAction searchResultReferenceControlValueCreation

GrammarAction that creates a Control Value for Search Result Reference

ldapResultAddResultCode

private final GrammarAction ldapResultAddResultCode

GrammarAction that adds a Result Code to a LDAP Result

ldapResultAddErrorMessage

private final GrammarAction ldapResultAddErrorMessage

GrammarAction that adds a Error Message to a LDAP Result

ldapResultAddReferral

private final GrammarAction ldapResultAddReferral

GrammarAction that adds a Referral to a LDAP Result

searchResponseCreation

private final GrammarAction searchResponseCreation

GrammarAction that creates the Search Response

searchResultEntryCreation

private final GrammarAction searchResultEntryCreation

GrammarAction that creates a Search Result Entry

searchResultReferenceCreation

private final GrammarAction searchResultReferenceCreation

GrammarAction that creates a Search Result Reference

searchResultDoneCreation

private final GrammarAction searchResultDoneCreation

GrammarAction that creates a Search Result Done

searchResultEntryAddAttr

private final GrammarAction searchResultEntryAddAttr

GrammarAction that adds an Attr to a Search Result Entry

searchResultEntryAddValue

private final GrammarAction searchResultEntryAddValue

GrammarAction that adds a Value to an Attr of a Search Result Entry

searchResultReferenceAddRef

private final GrammarAction searchResultReferenceAddRef

GrammarAction that adds a Ref to a Search Result Reference

extendedResponseAddResultCode

private final GrammarAction extendedResponseAddResultCode

GrammarAction that adds Result Code to an Extended Response

extendedResponseAddErrorMessage

private final GrammarAction extendedResponseAddErrorMessage

GrammarAction that creates the Search Response

extendedResponseAddReferral

private final GrammarAction extendedResponseAddReferral

GrammarAction that adds a Referral to an Extended Response

extendedResponseAddResponseName

private final GrammarAction extendedResponseAddResponseName

GrammarAction that adds a Response Name to an Extended Response

extendedResponseAddResponse

private final GrammarAction extendedResponseAddResponse

GrammarAction that adds a Response to an Extended Response

Constructor Detail

Dsmlv2ResponseGrammar

private Dsmlv2ResponseGrammar()

Method Detail

createAndAddControl

private void createAndAddControl(Dsmlv2Container container,
                                 AbstractDsmlMessageDecorator<? extends Message> parent)
                          throws org.xmlpull.v1.XmlPullParserException

Creates a Control parsing the current node and adds it to the given parent

Parameters:

container - the DSMLv2Container

parent - the parent

Throws:

org.xmlpull.v1.XmlPullParserException

createAndAddControlValue

private void createAndAddControlValue(Dsmlv2Container container,
                                      AbstractDsmlMessageDecorator<? extends Message> parent)
                               throws org.xmlpull.v1.XmlPullParserException

Creates a Control Value parsing the current node and adds it to the given parent

Parameters:

container - the DSMLv2Container

parent - the parent

Throws:

org.xmlpull.v1.XmlPullParserException

getInstance

public static Dsmlv2ResponseGrammar getInstance()

Get the instance of this grammar

Returns:

an instance on this grammar