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

Class StreamProxyValuesBackendSetValue

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.extensions.StreamProxyValuesBackendSetValue

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class StreamProxyValuesBackendSetValue
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure for holding a value included in the stream proxy values intermediate response. It contains the value, and the ID of the backend set with which the value is associated.

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:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StreamProxyValuesBackendSetValue(ASN1OctetString backendSetID, ASN1OctetString value)	Creates a new stream proxy values backend set value object with the provided information.

Method Summary

Modifier and Type	Method	Description
static StreamProxyValuesBackendSetValue	decode(ASN1Element element)	Decodes the provided ASN.1 element as a stream proxy values backend set value.
ASN1Element	encode()	Encodes this backend set value in a form suitable for inclusion in a stream proxy values intermediate response.
ASN1OctetString	getBackendSetID()	Retrieves the backend set ID for this backend set value.
ASN1OctetString	getValue()	Retrieves the value for this backend set value.
java.lang.String	toString()	Retrieves a string representation of this backend set value.
void	toString(java.lang.StringBuilder buffer)	Appends a string representation of this backend set value to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamProxyValuesBackendSetValue

public StreamProxyValuesBackendSetValue(@NotNull
                                        ASN1OctetString backendSetID,
                                        @NotNull
                                        ASN1OctetString value)

Creates a new stream proxy values backend set value object with the provided information.

Parameters:

backendSetID - The backend set ID for this backend set value. It must not be null.

value - The value for this backend set value. It must not be null.

Method Detail

getBackendSetID

@NotNull
public ASN1OctetString getBackendSetID()

Retrieves the backend set ID for this backend set value.

Returns:

The backend set ID for this backend set value.

getValue

@NotNull
public ASN1OctetString getValue()

Retrieves the value for this backend set value.

Returns:

The value for this backend set value.

encode

@NotNull
public ASN1Element encode()

Encodes this backend set value in a form suitable for inclusion in a stream proxy values intermediate response.

Returns:

An ASN.1 element containing the encoded representation of this stream proxy values backend set value.

decode

@NotNull
public static StreamProxyValuesBackendSetValue decode(@NotNull
                                                      ASN1Element element)
                                               throws LDAPException

Decodes the provided ASN.1 element as a stream proxy values backend set value.

Parameters:

element - The ASN.1 element to be decoded as a stream proxy values backend set value.

Returns:

The decoded stream proxy values backend set value.

Throws:

LDAPException - If a problem occurs while attempting to decode the provided ASN.1 element as a stream proxy values backend set value.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this backend set value.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this backend set value.

toString

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

Appends a string representation of this backend set value to the provided buffer.

Parameters:

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