Class StreamProxyValuesBackendSet

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class StreamProxyValuesBackendSet
    extends java.lang.Object
    implements java.io.Serializable
    This class provides a data structure for holding information about the configuration of backend sets as used by the stream proxy values extended request.
    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
      StreamProxyValuesBackendSet​(ASN1OctetString backendSetID, java.lang.String[] hosts, int[] ports)
      Creates a new backend set with the provided information.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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​(@NotNull
                                           ASN1OctetString backendSetID,
                                           @NotNull
                                           java.lang.String[] hosts,
                                           @NotNull
                                           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

      • getHosts

        @NotNull
        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

        @NotNull
        public int[] getPorts()
        Retrieves the ports of the servers for this backend set.
        Returns:
        The ports of the servers for this backend set.
      • encode

        @NotNull
        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.
      • toString

        @NotNull
        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​(@NotNull
                             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.