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
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 ClassesModifier and TypeClassDescriptionprivate static class
Parse handler implementation for integer stats.private static class
Parse handler implementation for string stats. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final DERPath
DER path to call time.private static final DERPath
DER path to entries returned.private static final DERPath
DER path to entries visited.private static final DERPath
DER path to filter.private static final int
hash code seed.private static final DERPath
DER path to index.private static final DERPath
DER path to log record bytes.private static final DERPath
DER path to log record count.static final String
OID of this control.private static final DERPath
DER path to pages dirtied.private static final DERPath
DER path to pages preread.private static final DERPath
DER path to pages read.private static final DERPath
DER path to pages redirtied.private static final DERPath
DER path to pages referenced.statistics.private static final DERPath
DER path to thread count.Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.GetStatsControl
(boolean critical) Creates a new get stats control. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Initializes this response control with the supplied BER encoded data.byte[]
encode()
Provides the BER encoding of this control.boolean
Returns the statistics.int
hashCode()
Returns the hash code for this object.boolean
hasValue()
Returns whether the control has a value associated with it.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 Details
-
OID
OID of this control.- See Also:
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
THREAD_COUNT_PATH
DER path to thread count. -
CALL_TIME_PATH
DER path to call time. -
ENTRIES_RETURNED_PATH
DER path to entries returned. -
ENTRIES_VISITED_PATH
DER path to entries visited. -
FILTER_PATH
DER path to filter. -
INDEX_PATH
DER path to index. -
PAGES_REFERENCED_PATH
DER path to pages referenced. -
PAGES_READ_PATH
DER path to pages read. -
PAGES_PREREAD_PATH
DER path to pages preread. -
PAGES_DIRTIED_PATH
DER path to pages dirtied. -
PAGES_REDIRTIED_PATH
DER path to pages redirtied. -
LOG_RECORD_COUNT_PATH
DER path to log record count. -
LOG_RECORD_BYTES_PATH
DER path to log record bytes. -
statistics
statistics.
-
-
Constructor Details
-
GetStatsControl
public GetStatsControl()Default constructor. -
GetStatsControl
public GetStatsControl(boolean critical) Creates a new get stats control.- Parameters:
critical
- whether this control is critical
-
-
Method Details
-
hasValue
public boolean hasValue()Description copied from interface:RequestControl
Returns whether the control has a value associated with it.- Specified by:
hasValue
in interfaceRequestControl
- Returns:
- whether the control has a value
-
getStatistics
Returns the statistics.- Returns:
- statistics
-
equals
- Overrides:
equals
in classAbstractControl
-
hashCode
public int hashCode()Description copied from class:AbstractControl
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractControl
- Returns:
- hash code
-
toString
- Overrides:
toString
in classAbstractControl
-
encode
public byte[] encode()Description copied from interface:RequestControl
Provides the BER encoding of this control.- Specified by:
encode
in interfaceRequestControl
- Returns:
- BER encoded request control
-
decode
Description copied from interface:ResponseControl
Initializes this response control with the supplied BER encoded data.- Specified by:
decode
in interfaceResponseControl
- Parameters:
encoded
- BER encoded response control
-