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

Class StreamProxyValuesBackendSetValue

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.extensions.StreamProxyValuesBackendSetValue
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StreamProxyValuesBackendSetValue extends Object implements 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:

  • Constructor Details

    • 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 Details

    • 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 String toString()
      Retrieves a string representation of this backend set value.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this backend set value.

    • toString

      public void toString(@NotNull 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.