com.unboundid.ldap.sdk.unboundidds.extensions

Class CollectSupportDataArchiveFragmentIntermediateResponse

java.lang.Object

com.unboundid.ldap.sdk.IntermediateResponse

com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataArchiveFragmentIntermediateResponse

All Implemented Interfaces:

LDAPResponse, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class CollectSupportDataArchiveFragmentIntermediateResponse
extends IntermediateResponse

This class provides an implementation of an intermediate response that can provide the client with a portion of the support data archive generated in response to 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.

The collect support data archive fragment intermediate response has an OID of 1.3.6.1.4.1.30221.2.6.66 and a value with the following encoding:

   CollectSupportDataArchiveDataIntermediateResponse ::= SEQUENCE {
      archiveFileName           [0] OCTET STRING,
      totalArchiveSizeBytes     [1] INTEGER,
      moreDataToReturn          [2] BOOLEAN,
      fragmentData              [3] OCTET STRING,
      ... }
 

See Also:

CollectSupportDataExtendedRequest, CollectSupportDataExtendedResult, CollectSupportDataOutputIntermediateResponse, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLLECT_SUPPORT_DATA_ARCHIVE_FRAGMENT_INTERMEDIATE_RESPONSE_OID The OID (1.3.6.1.4.1.30221.2.6.66) for the collect support data archive fragment intermediate response.

Fields inherited from class com.unboundid.ldap.sdk.IntermediateResponse

TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE

Constructor Summary

Constructors

Constructor and Description
CollectSupportDataArchiveFragmentIntermediateResponse(IntermediateResponse intermediateResponse) Creates a new collect support data archive fragment intermediate response that is decoded from the provided generic intermediate response.
CollectSupportDataArchiveFragmentIntermediateResponse(java.lang.String archiveFileName, long totalArchiveSizeBytes, boolean moreDataToReturn, byte[] fragmentData, Control... controls) Creates a new collect support data archive fragment intermediate response object with the provided information.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArchiveFileName() Retrieves the name (without any path information) that the server used for the support data archive file.
byte[]	getFragmentData() Retrieves the data included in this fragment.
java.lang.String	getIntermediateResponseName() Retrieves the user-friendly name for the intermediate response, if available.
long	getTotalArchiveSizeBytes() Retrieves the total number of bytes contained in the complete support data archive.
boolean	moreDataToReturn() Indicates whether there are one or more fragments still to be returned in the complete support data archive.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this intermediate response to the provided buffer.
java.lang.String	valueToString() Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate.

Methods inherited from class com.unboundid.ldap.sdk.IntermediateResponse

getControl, getControls, getMessageID, getOID, getValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

COLLECT_SUPPORT_DATA_ARCHIVE_FRAGMENT_INTERMEDIATE_RESPONSE_OID

@NotNull
public static final java.lang.String COLLECT_SUPPORT_DATA_ARCHIVE_FRAGMENT_INTERMEDIATE_RESPONSE_OID

The OID (1.3.6.1.4.1.30221.2.6.66) for the collect support data archive fragment intermediate response.

See Also:

Constant Field Values

Constructor Detail

CollectSupportDataArchiveFragmentIntermediateResponse

public CollectSupportDataArchiveFragmentIntermediateResponse(@NotNull
                                                             java.lang.String archiveFileName,
                                                             long totalArchiveSizeBytes,
                                                             boolean moreDataToReturn,
                                                             @NotNull
                                                             byte[] fragmentData,
                                                             @Nullable
                                                             Control... controls)

Creates a new collect support data archive fragment intermediate response object with the provided information.

Parameters:

archiveFileName - The name (without any path information) that the server used for the support data archive file. It must not be null.

totalArchiveSizeBytes - The size, in bytes, of the complete support data archive.

moreDataToReturn - Indicates whether there are more fragments to be returned to as part of the complete support data archive.

fragmentData - The data contained in this fragment of the support data archive. It must not be null.

controls - The set of controls to include in this intermediate response. It may be null or empty if no controls should be included.

CollectSupportDataArchiveFragmentIntermediateResponse

public CollectSupportDataArchiveFragmentIntermediateResponse(@NotNull
                                                             IntermediateResponse intermediateResponse)
                                                      throws LDAPException

Creates a new collect support data archive fragment intermediate response that is decoded from the provided generic intermediate response.

Parameters:

intermediateResponse - The generic intermediate response to be decoded as a collect support data archive fragment intermediate response. It must not be null.

Throws:

LDAPException - If the provided intermediate response object cannot be decoded as a collect support data archive fragment intermediate response.

Method Detail

getArchiveFileName

@NotNull
public java.lang.String getArchiveFileName()

Retrieves the name (without any path information) that the server used for the support data archive file.

Returns:

The name (without any path information) that the server used for the support data archive file.

getTotalArchiveSizeBytes

public long getTotalArchiveSizeBytes()

Retrieves the total number of bytes contained in the complete support data archive.

Returns:

The total number of bytes contained in the complete support data archive.

moreDataToReturn

public boolean moreDataToReturn()

Indicates whether there are one or more fragments still to be returned in the complete support data archive.

Returns:

true if there are still more fragments to be returned, or false if not.

getFragmentData

@NotNull
public byte[] getFragmentData()

Retrieves the data included in this fragment.

Returns:

The data included in this fragment.

getIntermediateResponseName

@NotNull
public java.lang.String getIntermediateResponseName()

Retrieves the user-friendly name for the intermediate response, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.

Overrides:

getIntermediateResponseName in class IntermediateResponse

Returns:

The user-friendly name for this intermediate response, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

valueToString

@NotNull
public java.lang.String valueToString()

Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. If one is provided, then it should be a relatively compact single-line representation of the most important elements of the value.

Overrides:

valueToString in class IntermediateResponse

Returns:

A human-readable string representation for the contents of the value for this intermediate response, or null if there is no value or no string representation is available.

toString

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

Appends a string representation of this intermediate response to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class IntermediateResponse

Parameters:

buffer - The buffer to which the string representation should be appended.