com.unboundid.ldap.sdk.unboundidds.extensions

Class HeadAndTailSizeCollectSupportDataLogCaptureWindow

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataLogCaptureWindow

com.unboundid.ldap.sdk.unboundidds.extensions.HeadAndTailSizeCollectSupportDataLogCaptureWindow

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class HeadAndTailSizeCollectSupportDataLogCaptureWindow
extends CollectSupportDataLogCaptureWindow

This class provides a collect support data log capture window implementation that indicates that the tool should capture a specified amount of data (in kilobytes) from the beginning and end of each log file when processing a CollectSupportDataExtendedRequest.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

CollectSupportDataExtendedRequest, Serialized Form

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataLogCaptureWindow

TYPE_DURATION, TYPE_HEAD_AND_TAIL_SIZE, TYPE_TIME_WINDOW, TYPE_TOOL_DEFAULT

Constructor Summary

Constructors

Constructor and Description
HeadAndTailSizeCollectSupportDataLogCaptureWindow(java.lang.Integer headSizeKB, java.lang.Integer tailSizeKB) Creates a new instance of this collect support data log capture window object that will capture the specified amount of data from the beginning and end of each log file.

Method Summary

Modifier and Type	Method and Description
ASN1Element	encode() Encodes this collect support data log capture window object to an ASN.1 element.
java.lang.Integer	getHeadSizeKB() Retrieves the amount of data in kilobytes to capture from the beginning of each log file, if specified.
java.lang.Integer	getTailSizeKB() Retrieves the amount of data in kilobytes to capture from the end of each log file, if specified.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this collect support data log capture window object to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataLogCaptureWindow

decode, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HeadAndTailSizeCollectSupportDataLogCaptureWindow

public HeadAndTailSizeCollectSupportDataLogCaptureWindow(@Nullable
                                                         java.lang.Integer headSizeKB,
                                                         @Nullable
                                                         java.lang.Integer tailSizeKB)

Creates a new instance of this collect support data log capture window object that will capture the specified amount of data from the beginning and end of each log file.

Parameters:

headSizeKB - The amount of data in kilobytes to capture from the beginning of each log file. This may be null if the server should select an appropriate value.

tailSizeKB - The amount of data in kilobytes to capture from the end of each log file. This may be null if the server should select an appropriate value.

Method Detail

getHeadSizeKB

@Nullable
public java.lang.Integer getHeadSizeKB()

Retrieves the amount of data in kilobytes to capture from the beginning of each log file, if specified.

Returns:

The amount of data in kilobytes to capture from the beginning of each log file, or null if the server should select an appropriate value.

getTailSizeKB

@Nullable
public java.lang.Integer getTailSizeKB()

Retrieves the amount of data in kilobytes to capture from the end of each log file, if specified.

Returns:

The amount of data in kilobytes to capture from the end of each log file, or null if the server should select an appropriate value.

encode

@NotNull
public ASN1Element encode()

Encodes this collect support data log capture window object to an ASN.1 element.

Specified by:

encode in class CollectSupportDataLogCaptureWindow

Returns:

The ASN.1 element that contains an encoded representation of this collect support data log capture window object.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this collect support data log capture window object to the provided buffer.

Specified by:

toString in class CollectSupportDataLogCaptureWindow

Parameters:

buffer - The buffer to which the string representation will be appended. It must not be null.