Package org.ldaptive.ad.control

Class GetStatsControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.ad.control.GetStatsControl

All Implemented Interfaces:

Control, RequestControl, ResponseControl

public class GetStatsControl
extends AbstractControl
implements RequestControl, ResponseControl

Request/response control for active directory servers to return statistics along with search results. This implementation supports the format for Windows Server 2008, Windows Server 2008 R2, and Windows Server 2012 DCs. The response control is defined as:

   SEQUENCE {
     threadCountTag        INTEGER
     threadCount           INTEGER
     callTimeTag           INTEGER
     callTime              INTEGER
     entriesReturnedTag    INTEGER
     entriesReturned       INTEGER
     entriesVisitedTag     INTEGER
     entriesVisited        INTEGER
     filterTag             INTEGER
     filter                OCTET STRING
     indexTag              INTEGER
     index                 OCTET STRING
     pagesReferencedTag    INTEGER
     pagesReferenced       INTEGER
     pagesReadTag          INTEGER
     pagesRead             INTEGER
     pagesPrereadTag       INTEGER
     pagesPreread          INTEGER
     pagesDirtiedTag       INTEGER
     pagesDirtied          INTEGER
     pagesRedirtiedTag     INTEGER
     pagesRedirtied        INTEGER
     logRecordCountTag     INTEGER
     logRecordCount        INTEGER
     logRecordBytesTag     INTEGER
     logRecordBytes        INTEGER
   }
 

See http://msdn.microsoft.com/en-us/library/cc223350.aspx

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	GetStatsControl.IntegerHandler	Parse handler implementation for integer stats.
private static class	GetStatsControl.StringHandler	Parse handler implementation for string stats.

Field Summary

Fields

Modifier and Type	Field	Description
private static DERPath	CALL_TIME_PATH	DER path to call time.
private static DERPath	ENTRIES_RETURNED_PATH	DER path to entries returned.
private static DERPath	ENTRIES_VISITED_PATH	DER path to entries visited.
private static DERPath	FILTER_PATH	DER path to filter.
private static int	HASH_CODE_SEED	hash code seed.
private static DERPath	INDEX_PATH	DER path to index.
private static DERPath	LOG_RECORD_BYTES_PATH	DER path to log record bytes.
private static DERPath	LOG_RECORD_COUNT_PATH	DER path to log record count.
static String	OID	OID of this control.
private static DERPath	PAGES_DIRTIED_PATH	DER path to pages dirtied.
private static DERPath	PAGES_PREREAD_PATH	DER path to pages preread.
private static DERPath	PAGES_READ_PATH	DER path to pages read.
private static DERPath	PAGES_REDIRTIED_PATH	DER path to pages redirtied.
private static DERPath	PAGES_REFERENCED_PATH	DER path to pages referenced.
private Map<String,Object>	statistics	statistics.
private static DERPath	THREAD_COUNT_PATH	DER path to thread count.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor	Description
GetStatsControl()	Default constructor.
GetStatsControl(boolean critical)	Creates a new get stats control.

Method Summary

Modifier and Type	Method	Description
void	decode(DERBuffer encoded)	Initializes this response control with the supplied BER encoded data.
byte[]	encode()	Provides the BER encoding of this control.
boolean	equals(Object o)
Map<String,Object>	getStatistics()	Returns the statistics.
int	hashCode()	Returns the hash code for this object.
boolean	hasValue()	Returns whether the control has a value associated with it.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

getCriticality, getOID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.control.Control

getCriticality, getOID

Field Detail

OID

public static final String OID

OID of this control.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

THREAD_COUNT_PATH

private static final DERPath THREAD_COUNT_PATH

DER path to thread count.

CALL_TIME_PATH

private static final DERPath CALL_TIME_PATH

DER path to call time.

ENTRIES_RETURNED_PATH

private static final DERPath ENTRIES_RETURNED_PATH

DER path to entries returned.

ENTRIES_VISITED_PATH

private static final DERPath ENTRIES_VISITED_PATH

DER path to entries visited.

FILTER_PATH

private static final DERPath FILTER_PATH

DER path to filter.

INDEX_PATH

private static final DERPath INDEX_PATH

DER path to index.

PAGES_REFERENCED_PATH

private static final DERPath PAGES_REFERENCED_PATH

DER path to pages referenced.

PAGES_READ_PATH

private static final DERPath PAGES_READ_PATH

DER path to pages read.

PAGES_PREREAD_PATH

private static final DERPath PAGES_PREREAD_PATH

DER path to pages preread.

PAGES_DIRTIED_PATH

private static final DERPath PAGES_DIRTIED_PATH

DER path to pages dirtied.

PAGES_REDIRTIED_PATH

private static final DERPath PAGES_REDIRTIED_PATH

DER path to pages redirtied.

LOG_RECORD_COUNT_PATH

private static final DERPath LOG_RECORD_COUNT_PATH

DER path to log record count.

LOG_RECORD_BYTES_PATH

private static final DERPath LOG_RECORD_BYTES_PATH

DER path to log record bytes.

statistics

private final Map<String,Object> statistics

statistics.

Constructor Detail

GetStatsControl

public GetStatsControl()

Default constructor.

GetStatsControl

public GetStatsControl(boolean critical)

Creates a new get stats control.

Parameters:

critical - whether this control is critical

Method Detail

hasValue

public boolean hasValue()

Description copied from interface: RequestControl

Returns whether the control has a value associated with it.

Specified by:

hasValue in interface RequestControl

Returns:

whether the control has a value

getStatistics

public Map<String,Object> getStatistics()

Returns the statistics.

Returns:

statistics

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractControl

hashCode

public int hashCode()

Description copied from class: AbstractControl

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public String toString()

Overrides:

toString in class AbstractControl

encode

public byte[] encode()

Description copied from interface: RequestControl

Provides the BER encoding of this control.

Specified by:

encode in interface RequestControl

Returns:

BER encoded request control

decode

public void decode(DERBuffer encoded)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

encoded - BER encoded response control