org.apache.directory.api.ldap.extras.controls.vlv

Class VirtualListViewRequestImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.controls.AbstractControl

org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewRequestImpl

All Implemented Interfaces:

VirtualListViewRequest, org.apache.directory.api.ldap.model.message.Control

public class VirtualListViewRequestImpl
extends org.apache.directory.api.ldap.model.message.controls.AbstractControl
implements VirtualListViewRequest

Virtual List View control as specified in draft-ietf-ldapext-ldapv3-vlv-09. VirtualListViewRequest ::= SEQUENCE { beforeCount INTEGER (0..maxInt), afterCount INTEGER (0..maxInt), target CHOICE { byOffset [0] SEQUENCE { offset INTEGER (1 .. maxInt), contentCount INTEGER (0 .. maxInt) }, greaterThanOrEqual [1] AssertionValue }, contextID OCTET STRING OPTIONAL } Simplistic implementation that only supports byOffset choice.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private int	afterCount
private static boolean	ASSERTION_VALUE
private byte[]	assertionValue The assertionValue
private int	beforeCount
private int	contentCount
private byte[]	contextId
private int	offset
private static boolean	OFFSET
private boolean	targetType A flag used for the target.

Fields inherited from interface org.apache.directory.api.ldap.extras.controls.vlv.VirtualListViewRequest

OID

Constructor Summary

Constructors

Constructor and Description
VirtualListViewRequestImpl() Creates a new instance of VirtualListViewRequestImpl.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getAfterCount()
byte[]	getAssertionValue()
int	getBeforeCount()
int	getContentCount()
byte[]	getContextId()
int	getOffset()
boolean	hasAssertionValue()
int	hashCode()
boolean	hasOffset()
void	setAfterCount(int afterCount)
void	setAssertionValue(byte[] assertionValue)
void	setBeforeCount(int beforeCount)
void	setContentCount(int contentCount)
void	setContextId(byte[] contextId)
void	setOffset(int offset)
String	toString() Return a String representing this VirtualListViewRequestImpl.

Methods inherited from class org.apache.directory.api.ldap.model.message.controls.AbstractControl

getOid, isCritical, setCritical

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Field Detail

beforeCount

private int beforeCount

afterCount

private int afterCount

offset

private int offset

contentCount

private int contentCount

contextId

private byte[] contextId

assertionValue

private byte[] assertionValue

The assertionValue

targetType

private boolean targetType

A flag used for the target. It default to OFFSET

OFFSET

private static final boolean OFFSET

See Also:

Constant Field Values

ASSERTION_VALUE

private static final boolean ASSERTION_VALUE

See Also:

Constant Field Values

Constructor Detail

VirtualListViewRequestImpl

public VirtualListViewRequestImpl()

Creates a new instance of VirtualListViewRequestImpl.

Method Detail

getBeforeCount

public int getBeforeCount()

Specified by:

getBeforeCount in interface VirtualListViewRequest

Returns:

The number of entries before the target entry that are going to be sent

setBeforeCount

public void setBeforeCount(int beforeCount)

Specified by:

setBeforeCount in interface VirtualListViewRequest

Parameters:

beforeCount - Set the number of entries to be returned before the target entry

getAfterCount

public int getAfterCount()

Specified by:

getAfterCount in interface VirtualListViewRequest

Returns:

The number of entries after the target entry that are going to be sent

setAfterCount

public void setAfterCount(int afterCount)

Specified by:

setAfterCount in interface VirtualListViewRequest

Parameters:

afterCount - Set the number of entries to be returned after the target entry

getOffset

public int getOffset()

Specified by:

getOffset in interface VirtualListViewRequest

Returns:

The position of the target entry

setOffset

public void setOffset(int offset)

Specified by:

setOffset in interface VirtualListViewRequest

Parameters:

offset - the position of the target entry

getContentCount

public int getContentCount()

Specified by:

getContentCount in interface VirtualListViewRequest

Returns:

The number of expected entries

setContentCount

public void setContentCount(int contentCount)

Specified by:

setContentCount in interface VirtualListViewRequest

Parameters:

contentCount - The number of entries

getAssertionValue

public byte[] getAssertionValue()

Specified by:

getAssertionValue in interface VirtualListViewRequest

Returns:

The AssertionValue

setAssertionValue

public void setAssertionValue(byte[] assertionValue)

Specified by:

setAssertionValue in interface VirtualListViewRequest

Parameters:

assertionValue - Set the AssertionValue

getContextId

public byte[] getContextId()

Specified by:

getContextId in interface VirtualListViewRequest

Returns:

The ID used for this request

setContextId

public void setContextId(byte[] contextId)

Specified by:

setContextId in interface VirtualListViewRequest

Parameters:

contextId - Set the context ID

hasOffset

public boolean hasOffset()

Specified by:

hasOffset in interface VirtualListViewRequest

Returns:

true if the VLV target is an offset, false otherwise

hasAssertionValue

public boolean hasAssertionValue()

Specified by:

hasAssertionValue in interface VirtualListViewRequest

Returns:

true if the VLV target is an assertionValue, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.hashCode()

equals

public boolean equals(Object o)

Overrides:

equals in class org.apache.directory.api.ldap.model.message.controls.AbstractControl

See Also:

Object.equals(Object)

toString

public String toString()

Return a String representing this VirtualListViewRequestImpl.

Overrides:

toString in class org.apache.directory.api.ldap.model.message.controls.AbstractControl