Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol
Class WildcardEndpoint

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.Endpoint
      extended by com.genesyslab.platform.commons.protocol.WildcardEndpoint
All Implemented Interfaces:
java.lang.Cloneable

public class WildcardEndpoint
extends Endpoint

A special case of Endpoint that allows user to specify wildcard address for a server socket. Socket opened using such address would listen to incoming connections on all available network interfaces (NICs). This class should only be used for server-side applications. Special notes: According to RFC 2396 "Uniform Resource Identifiers (URI): Generic Syntax" URI must contain a real host name or IP address, so URI can not hold wildcard address. Therefore WildcardEndpoint can not be created using URI or converted to URI, attempting it will result in UnsupportedOperationException. As a consequence, configuring protocol through URI is not supported. Users should provide any configuration directly to protocol instance or use Endpoint class and specify wildcard address in explicit form ("0.0.0.0" or "[::]")


Field Summary
 
Fields inherited from class com.genesyslab.platform.commons.protocol.Endpoint
connConfig, defaultPrefix, hasName, host, name, port, spn, sslContext, sslOptions, tostringPrefix
 
Constructor Summary
WildcardEndpoint(int port)
           
WildcardEndpoint(int port, ConnectionConfiguration connConf)
           
WildcardEndpoint(int port, ConnectionConfiguration connConf, boolean tlsEnabled, javax.net.ssl.SSLContext sslContext, SSLExtendedOptions sslOptions)
           
WildcardEndpoint(java.lang.String name, int port)
           
WildcardEndpoint(java.lang.String name, int port, ConnectionConfiguration connConf)
           
WildcardEndpoint(java.lang.String name, int port, ConnectionConfiguration connConf, boolean tlsEnabled, javax.net.ssl.SSLContext sslContext, SSLExtendedOptions sslOptions)
           
 
Method Summary
 java.net.URI getUri()
          Deprecated. 
 java.lang.String toString()
           
protected  void validatePort(int port)
           
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Endpoint
clone, equals, getConfiguration, getHost, getName, getPort, getSPN, getSSLContext, getSSLOptions, hashCode, hasName, setEndpointName, setSPN
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WildcardEndpoint

public WildcardEndpoint(int port)
Parameters:
port - Port to bind socket to

WildcardEndpoint

public WildcardEndpoint(java.lang.String name,
                        int port)
Parameters:
name - Name of endpoint, will be seen in logs
port - Port to bind socket to

WildcardEndpoint

public WildcardEndpoint(int port,
                        ConnectionConfiguration connConf)
Parameters:
port - Port to bind socket to
connConf - Connection configuration properties. Must not be null.

WildcardEndpoint

public WildcardEndpoint(java.lang.String name,
                        int port,
                        ConnectionConfiguration connConf)
Parameters:
name - Name of endpoint, will be seen in logs
port - Port to bind socket to
connConf - Connection configuration properties. Must not be null.

WildcardEndpoint

public WildcardEndpoint(int port,
                        ConnectionConfiguration connConf,
                        boolean tlsEnabled,
                        javax.net.ssl.SSLContext sslContext,
                        SSLExtendedOptions sslOptions)
Parameters:
port - Port to bind socket to
connConf - Connection configuration properties. Must not be null.
tlsEnabled - if true, TLS will be started immediately upon connection; if false, TLS is only started by request from protocol
sslContext - TLS configuration to be used with this Endpoint. Can be null.
sslOptions - Additional TLS options to be used with this Endpoint. Can be null.

WildcardEndpoint

public WildcardEndpoint(java.lang.String name,
                        int port,
                        ConnectionConfiguration connConf,
                        boolean tlsEnabled,
                        javax.net.ssl.SSLContext sslContext,
                        SSLExtendedOptions sslOptions)
Parameters:
name - Name of endpoint, will be seen in logs
port - Port to bind socket to
connConf - Connection configuration properties. Must not be null.
tlsEnabled - if true, TLS will be started immediately upon connection; if false, TLS is only started by request from protocol
sslContext - TLS configuration to be used with this Endpoint. Can be null.
sslOptions - Additional TLS options to be used with this Endpoint. Can be null.
Method Detail

validatePort

protected void validatePort(int port)
Overrides:
validatePort in class Endpoint

getUri

@Deprecated
public java.net.URI getUri()
Deprecated. 

This method is blocked. See class documentation.

Overrides:
getUri in class Endpoint
Returns:
Always throws UnsupportedOperationException

toString

public java.lang.String toString()
Overrides:
toString in class Endpoint

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.