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 and 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 and Description
private static int	HASH_CODE_SEED hash code seed.
static java.lang.String	OID OID of this control.
private java.util.Map<java.lang.String,java.lang.Object>	statistics statistics.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	decode(byte[] berValue) Initializes this response control with the supplied BER encoded data.
byte[]	encode() Provides the BER encoding of this control.
java.util.Map<java.lang.String,java.lang.Object>	getStatistics() Returns the statistics.
int	hashCode() Returns the hash code for this object.
java.lang.String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

equals, 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 java.lang.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

statistics

private final java.util.Map<java.lang.String,java.lang.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

getStatistics

public java.util.Map<java.lang.String,java.lang.Object> getStatistics()

Returns the statistics.

Returns:

statistics

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

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(byte[] berValue)

Description copied from interface: ResponseControl

Initializes this response control with the supplied BER encoded data.

Specified by:

decode in interface ResponseControl

Parameters:

berValue - BER encoded response control