Class CollectSupportDataLogCaptureWindow
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataLogCaptureWindow
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
DurationCollectSupportDataLogCaptureWindow
,HeadAndTailSizeCollectSupportDataLogCaptureWindow
,TimeWindowCollectSupportDataLogCaptureWindow
,ToolDefaultCollectSupportDataLogCaptureWindow
@NotExtensible @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class CollectSupportDataLogCaptureWindow extends java.lang.Object implements java.io.Serializable
This class defines an API that may be used to indicate how the tool should determine which log content to include in the support data archive when processing aCollectSupportDataExtendedRequest
.
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.
Available log capture window implementations include:-
ToolDefaultCollectSupportDataLogCaptureWindow
-- Indicates that the tool should capture a default amount of log content to include in the support data archive. -
DurationCollectSupportDataLogCaptureWindow
-- Indicates that the support data archive should include log messages for a specified duration leading up to the time that theCollectSupportDataExtendedRequest
was received by the server. -
TimeWindowCollectSupportDataLogCaptureWindow
-- Indicates that the support data archive should include log messages that fall between specified start and end times. -
HeadAndTailSizeCollectSupportDataLogCaptureWindow
-- Indicates that the support data archive should include a specified amount of data from the beginning and end of each log file.
- See Also:
CollectSupportDataExtendedRequest
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static byte
TYPE_DURATION
The BER type that should be used for duration log capture window objects.protected static byte
TYPE_HEAD_AND_TAIL_SIZE
The BER type that should be used for head and tail size log capture window objects.protected static byte
TYPE_TIME_WINDOW
The BER type that should be used for time window log capture window objects.protected static byte
TYPE_TOOL_DEFAULT
The BER type that should be used for tool-default log capture window objects.
-
Constructor Summary
Constructors Constructor Description CollectSupportDataLogCaptureWindow()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static CollectSupportDataLogCaptureWindow
decode(ASN1Element e)
Decodes the provided ASN.1 element as a collect support data log capture window object.abstract ASN1Element
encode()
Encodes this collect support data log capture window object to an ASN.1 element.java.lang.String
toString()
Retrieves a string representation of this collect support data log capture window object.abstract void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this collect support data log capture window object to the provided buffer.
-
-
-
Field Detail
-
TYPE_TOOL_DEFAULT
protected static final byte TYPE_TOOL_DEFAULT
The BER type that should be used for tool-default log capture window objects.- See Also:
- Constant Field Values
-
TYPE_DURATION
protected static final byte TYPE_DURATION
The BER type that should be used for duration log capture window objects.- See Also:
- Constant Field Values
-
TYPE_TIME_WINDOW
protected static final byte TYPE_TIME_WINDOW
The BER type that should be used for time window log capture window objects.- See Also:
- Constant Field Values
-
TYPE_HEAD_AND_TAIL_SIZE
protected static final byte TYPE_HEAD_AND_TAIL_SIZE
The BER type that should be used for head and tail size log capture window objects.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CollectSupportDataLogCaptureWindow
public CollectSupportDataLogCaptureWindow()
-
-
Method Detail
-
decode
@NotNull public static CollectSupportDataLogCaptureWindow decode(@NotNull ASN1Element e) throws LDAPException
Decodes the provided ASN.1 element as a collect support data log capture window object.- Parameters:
e
- The ASN.1 element to be decoded as a log capture window object. It must not benull
.- Returns:
- The collect support data log capture window object that was decoded from the provided ASN.1 element.
- Throws:
LDAPException
- If the provided element cannot be decoded as a valid collect support data log capture window object.
-
encode
@NotNull public abstract ASN1Element encode()
Encodes this collect support data log capture window object to an ASN.1 element.- Returns:
- The ASN.1 element that contains an encoded representation of this collect support data log capture window object.
-
toString
@NotNull public final java.lang.String toString()
Retrieves a string representation of this collect support data log capture window object.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this collect support data log capture window object.
-
-