Package org.apache.directory.api.ldap.codec.controls.search.persistentSearch

Class PersistentSearchContainer

java.lang.Object

org.apache.directory.api.asn1.ber.AbstractContainer

org.apache.directory.api.ldap.codec.controls.search.persistentSearch.PersistentSearchContainer

All Implemented Interfaces:

Asn1Container

public class PersistentSearchContainer
extends AbstractContainer

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
PersistentSearchContainer(LdapApiService codec)	Creates a new PSearchControlContainer object.
PersistentSearchContainer(LdapApiService codec, PersistentSearch control)	Creates a new PSearchControlContainer object pre-populated with a decorator wrapping the supplied control, or using the supplied control if it already is a decorator.

Method Summary

Modifier and Type	Method	Description
void	clean()	Clean the container
void	decorate(PersistentSearch control)	Conditionally decorates a control if is not a decorator already.
PersistentSearchDecorator	getPersistentSearchDecorator()
void	setPersistentSearchDecorator(PersistentSearchDecorator decorator)	Set a PSearchControl Object into the container.

Methods inherited from class org.apache.directory.api.asn1.ber.AbstractContainer

getCurrentTLV, getDecodedBytes, getGrammar, getMaxPDUSize, getNewTlvId, getParentTLV, getState, getStream, getTlvId, getTransition, incrementDecodedBytes, isGathering, isGrammarEndAllowed, rewind, setCurrentTLV, setDecodedBytes, setGathering, setGrammar, setGrammarEndAllowed, setMaxPDUSize, setParentTLV, setState, setStream, setTransition, updateParent

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentSearchContainer

public PersistentSearchContainer(LdapApiService codec)

Creates a new PSearchControlContainer object. We will store one grammar, it's enough ...

Parameters:

codec - The LDAP service instance

PersistentSearchContainer

public PersistentSearchContainer(LdapApiService codec,
                                 PersistentSearch control)

Creates a new PSearchControlContainer object pre-populated with a decorator wrapping the supplied control, or using the supplied control if it already is a decorator.

Parameters:

codec - The LDAP service instance

control - The PersistentSearch Control or a decorating wrapper.

Method Detail

decorate

public void decorate(PersistentSearch control)

Conditionally decorates a control if is not a decorator already.

Parameters:

control - The PersistentSearch Control to decorate if it already is not a decorator, if it is then the object is set as this container's decorator.

getPersistentSearchDecorator

public PersistentSearchDecorator getPersistentSearchDecorator()

Returns:

Returns the persistent search decorator.

setPersistentSearchDecorator

public void setPersistentSearchDecorator(PersistentSearchDecorator decorator)

Set a PSearchControl Object into the container. It will be completed by the ldapDecoder.

Parameters:

decorator - the PSearchControl to set.

clean

public void clean()

Clean the container

Overrides:

clean in class AbstractContainer