Package com.unboundid.ldap.sdk.unboundidds.extensions

Class TimeWindowCollectSupportDataLogCaptureWindow

java.lang.Object

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

com.unboundid.ldap.sdk.unboundidds.extensions.TimeWindowCollectSupportDataLogCaptureWindow

All Implemented Interfaces:

java.io.Serializable

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

This class provides a collect support data log capture window implementation that indicates that the tool should capture information for a specified window of time (between start and end times, inclusive) 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	Description
TimeWindowCollectSupportDataLogCaptureWindow(long startTimeMillis, java.lang.Long endTimeMillis)	Creates a new instance of this collect support data log capture window object that will capture log content within the specified window of time.
TimeWindowCollectSupportDataLogCaptureWindow(java.util.Date startTime, java.util.Date endTime)	Creates a new instance of this collect support data log capture window object that will capture log content within the specified window of time.

Method Summary

Modifier and Type	Method	Description
ASN1Element	encode()	Encodes this collect support data log capture window object to an ASN.1 element.
java.util.Date	getEndTime()	Retrieves the time of the most recent log messages to include in the support data archive, if specified.
java.lang.Long	getEndTimeMillis()	Retrieves the time of the most recent log messages to include in the support data archive, if specified.
java.util.Date	getStartTime()	Retrieves the time of the oldest log messages to include in the support data archive.
long	getStartTimeMillis()	Retrieves the time of the oldest log messages to include in the support data archive, represented as the number of milliseconds since midnight on January 1, 1970, UTC (i.e., the format used by System.currentTimeMillis() and Date.getTime()).
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

TimeWindowCollectSupportDataLogCaptureWindow

public TimeWindowCollectSupportDataLogCaptureWindow(@NotNull
                                                    java.util.Date startTime,
                                                    @Nullable
                                                    java.util.Date endTime)

Creates a new instance of this collect support data log capture window object that will capture log content within the specified window of time.

Parameters:

startTime - The time of the oldest log messages to include in the support data archive. It must be non-null, and it must represent a time no earlier than midnight on January 1, 1970, UTC.

endTime - The time of the most recent log messages to include in the support data archive. This may be null if the end time should be set to the time the CollectSupportDataExtendedRequest was received by the server. If it is non-null, then it must represent a time no earlier than the provided start time.

TimeWindowCollectSupportDataLogCaptureWindow

public TimeWindowCollectSupportDataLogCaptureWindow(long startTimeMillis,
                                                    @Nullable
                                                    java.lang.Long endTimeMillis)

Creates a new instance of this collect support data log capture window object that will capture log content within the specified window of time.

Parameters:

startTimeMillis - The time of the oldest log messages to include in the support data archive, represented as the number of milliseconds since midnight on January 1, 1970, UTC (i.e., the format used by System.currentTimeMillis() and Date.getTime()).

endTimeMillis - The time of the most recent log messages to include in the support data archive, represented as the number of milliseconds since midnight on January 1, 1970, UTC. This may be null if the end time should be set to the time the CollectSupportDataExtendedRequest was received by the server. If it is non-null, then it must be greater than or equal to the provided start time.

Method Detail

getStartTime

@NotNull
public java.util.Date getStartTime()

Retrieves the time of the oldest log messages to include in the support data archive.

Returns:

The time of the oldest log messages to include in the support data archive.

getStartTimeMillis

public long getStartTimeMillis()

Retrieves the time of the oldest log messages to include in the support data archive, represented as the number of milliseconds since midnight on January 1, 1970, UTC (i.e., the format used by System.currentTimeMillis() and Date.getTime()).

Returns:

The time of the oldest log messages to include in the support data archive, represented as the number of milliseconds since midnight on January 1, 1970, UTC.

getEndTime

@Nullable
public java.util.Date getEndTime()

Retrieves the time of the most recent log messages to include in the support data archive, if specified.

Returns:

The time of the most recent log messages to include in the support data archive, or null if the end time should be set to the time the CollectSupportDataExtendedRequest was received by the server.

getEndTimeMillis

@Nullable
public java.lang.Long getEndTimeMillis()

Retrieves the time of the most recent log messages to include in the support data archive, if specified. The value will represent the number of milliseconds since midnight on January 1, 1970, UTC (i.e., the format used by System.currentTimeMillis() and Date.getTime()).

Returns:

The time of the most recent log messages to include in the support data archive, or null if the end time should be set to the time the CollectSupportDataExtendedRequest was received by the server.

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.