Package org.apache.directory.api.dsmlv2.request

Class BatchRequestDsml

java.lang.Object

org.apache.directory.api.dsmlv2.request.BatchRequestDsml

public class BatchRequestDsml
extends Object

This class represents the Batch Request. It can be used to generate an the XML String of a BatchRequest.

Author:

Apache Directory Project

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatchRequestDsml.OnError	This enum represents the different types of on error handling for a BatchRequest
static class	BatchRequestDsml.Processing	This enum represents the different types of processing for a Batch Request
static class	BatchRequestDsml.ResponseOrder	This enum represents the different types of response order for a Batch Request

Constructor Summary

Constructors

Constructor	Description
BatchRequestDsml()	Creates a new instance of BatchResponseDsml.

Method Summary

Modifier and Type	Method	Description
boolean	addRequest(DsmlDecorator<? extends Request> request)	Adds a request to the Batch Request DSML.
DsmlDecorator<? extends Request>	getCurrentRequest()	Gets the current request
BatchRequestDsml.OnError	getOnError()	Gets the on error handling type of the request
BatchRequestDsml.Processing	getProcessing()	Gets the processing type of the request
int	getRequestID()	Gets the ID of the request
List<DsmlDecorator<? extends Request>>	getRequests()	Gets the List of all the requests in the Batch Request
BatchRequestDsml.ResponseOrder	getResponseOrder()	Gets the response order type of the request
boolean	isStoringRequests()
boolean	removeRequest(DsmlDecorator<? extends Request> request)	Removes a request from the Batch Request DSML.
void	setOnError(BatchRequestDsml.OnError onError)	Sets the on error handling type of the request
void	setProcessing(BatchRequestDsml.Processing processing)	Sets the processing type of the request
void	setRequestID(int requestID)	Sets the ID of the request
void	setResponseOrder(BatchRequestDsml.ResponseOrder responseOrder)	Sets the response order type of the request
void	setStoreReq(boolean storeReq)	set the storeReq flag to turn on/off storing of request objects Note: it is better to set this flag to false while processing large DSML batch requests
String	toDsml()	Converts this Batch Request to its XML representation in the DSMLv2 format.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchRequestDsml

public BatchRequestDsml()

Creates a new instance of BatchResponseDsml.

Method Detail

getCurrentRequest

public DsmlDecorator<? extends Request> getCurrentRequest()

Gets the current request

Returns:

the current request

addRequest

public boolean addRequest(DsmlDecorator<? extends Request> request)

Adds a request to the Batch Request DSML.

Parameters:

request - the request to add

Returns:

true (as per the general contract of the Collection.add method).

removeRequest

public boolean removeRequest(DsmlDecorator<? extends Request> request)

Removes a request from the Batch Request DSML.

Parameters:

request - the request to remove

Returns:

true if this list contained the specified element.

getRequestID

public int getRequestID()

Gets the ID of the request

Returns:

the ID of the request

setRequestID

public void setRequestID(int requestID)

Sets the ID of the request

Parameters:

requestID - the ID to set

getProcessing

public BatchRequestDsml.Processing getProcessing()

Gets the processing type of the request

Returns:

the processing type of the request

setProcessing

public void setProcessing(BatchRequestDsml.Processing processing)

Sets the processing type of the request

Parameters:

processing - the processing type to set

getOnError

public BatchRequestDsml.OnError getOnError()

Gets the on error handling type of the request

Returns:

the on error handling type of the request

setOnError

public void setOnError(BatchRequestDsml.OnError onError)

Sets the on error handling type of the request

Parameters:

onError - the on error handling type to set

getResponseOrder

public BatchRequestDsml.ResponseOrder getResponseOrder()

Gets the response order type of the request

Returns:

the response order type of the request

setResponseOrder

public void setResponseOrder(BatchRequestDsml.ResponseOrder responseOrder)

Sets the response order type of the request

Parameters:

responseOrder - the response order type to set

getRequests

public List<DsmlDecorator<? extends Request>> getRequests()

Gets the List of all the requests in the Batch Request

Returns:

the List of all the requests in the Batch Request

toDsml

public String toDsml()

Converts this Batch Request to its XML representation in the DSMLv2 format.

Returns:

the XML representation in DSMLv2 format

isStoringRequests

public boolean isStoringRequests()

Returns:

true if the request objects are stored, false otherwise

setStoreReq

public void setStoreReq(boolean storeReq)

set the storeReq flag to turn on/off storing of request objects Note: it is better to set this flag to false while processing large DSML batch requests

Parameters:

storeReq - Tells if the request objects must be stored or not

toString

public String toString()

Overrides:

toString in class Object