com.unboundid.ldap.sdk.unboundidds.extensions
Class StreamProxyValuesBackendSet

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.extensions.StreamProxyValuesBackendSet
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a data structure for holding information about the configuration of backend sets as used by the stream proxy values extended request.

See Also:
Serialized Form

Constructor Summary
StreamProxyValuesBackendSet(ASN1OctetString backendSetID, java.lang.String[] hosts, int[] ports)
          Creates a new backend set with the provided information.
 
Method Summary
static StreamProxyValuesBackendSet decode(ASN1Element element)
          Decodes the provided ASN.1 element as a backend set.
 ASN1Element encode()
          Encodes this backend set object in a form suitable for inclusion in the value of the stream proxy values extended request.
 ASN1OctetString getBackendSetID()
          Retrieves the backend set ID for this backend set.
 java.lang.String[] getHosts()
          Retrieves the addresses of the servers for this backend set.
 int[] getPorts()
          Retrieves the ports of the servers for this backend set.
 java.lang.String toString()
          Retrieves a string representation of this stream proxy values backend set.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this stream proxy values backend set to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StreamProxyValuesBackendSet

public StreamProxyValuesBackendSet(ASN1OctetString backendSetID,
                                   java.lang.String[] hosts,
                                   int[] ports)
Creates a new backend set with the provided information.

Parameters:
backendSetID - The backend set ID for this backend set. It must not be null.
hosts - The addresses of the servers for this backend set. It must not be null or empty, and it must have the same number of elements as the ports array.
ports - The ports of the servers for this backend set. It must not be null or empty, and it must have the same number of elements as the hosts array.
Method Detail

getBackendSetID

public ASN1OctetString getBackendSetID()
Retrieves the backend set ID for this backend set.

Returns:
The backend set ID for this backend set.

getHosts

public java.lang.String[] getHosts()
Retrieves the addresses of the servers for this backend set.

Returns:
The addresses of the servers for this backend set.

getPorts

public int[] getPorts()
Retrieves the ports of the servers for this backend set.

Returns:
The ports of the servers for this backend set.

encode

public ASN1Element encode()
Encodes this backend set object in a form suitable for inclusion in the value of the stream proxy values extended request.

Returns:
The encoded representation of this backend set.

decode

public static StreamProxyValuesBackendSet decode(ASN1Element element)
                                          throws LDAPException
Decodes the provided ASN.1 element as a backend set.

Parameters:
element - The element to be decoded as a backend set.
Returns:
The decoded backend set.
Throws:
LDAPException - If the provided ASN.1 element cannot be decoded as a backend set.

toString

public java.lang.String toString()
Retrieves a string representation of this stream proxy values backend set.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this stream proxy values backend set.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this stream proxy values backend set to the provided buffer.

Parameters:
buffer - The buffer to which the stream representation should be appended.