Connection (bus-image 5.9.0 API)

java.lang.Object
- org.aoju.bus.image.metric.Connection

All Implemented Interfaces:

Serializable
```
public class Connection
extends Object
implements Serializable
```
Since:

JDK 1.8+

Version:

5.9.0

Author:

Kimi Liu

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Connection.Protocol

Nested Classes
Modifier and Type	Class and Description
`static class`	`Connection.Protocol`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEF_BACKLOG`
`static int`	`DEF_BUFFERSIZE`
`static int`	`DEF_MAX_PDU_LENGTH`
`static int`	`DEF_SOCKETDELAY`
`static String[]`	`DEFAULT_TLS_PROTOCOLS`
`static int`	`NO_TIMEOUT`
`static int`	`NOT_LISTENING`
`static int`	`SYNCHRONOUS_MODE`
`static String`	`TLS_RSA_WITH_3DES_EDE_CBC_SHA`
`static String`	`TLS_RSA_WITH_AES_128_CBC_SHA`
`static String`	`TLS_RSA_WITH_NULL_SHA`

Constructor Summary

Constructors
Constructor and Description
`Connection()`
`Connection(String commonName, String hostname)`
`Connection(String commonName, String hostname, int port)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`bind()` Bind this network connection to a TCP port and start a server socket accept loop.
`void`	`close(Socket s)`
`Socket`	`connect(Connection remoteConn)`
`DatagramSocket`	`createDatagramSocket()`
`boolean`	`equalsRDN(Connection other)`
`int`	`getAcceptTimeout()`
`int`	`getBacklog()`
`String`	`getBindAddress()` Bind address of listening socket or `null`.
`InetSocketAddress`	`getBindPoint()`
`String[]`	`getBlacklist()` Get a list of IP addresses from which we should ignore connections.
`String`	`getClientBindAddress()` Bind address of outgoing connections, `"0.0.0.0"` or `null`.
`InetSocketAddress`	`getClientBindPoint()`
`String`	`getCommonName()` An arbitrary name for the Network Connections object.
`int`	`getConnectTimeout()`
`Device`	`getDevice()` Get the Device object that this Network Connection belongs to.
`InetSocketAddress`	`getEndPoint()`
`String`	`getHostname()` This is the DNS name for this particular connection.
`String`	`getHttpProxy()`
`int`	`getIdleTimeout()`
`Boolean`	`getInstalled()`
`SocketListener`	`getListener()`
`int`	`getMaxOpsInvoked()`
`int`	`getMaxOpsPerformed()`
`int`	`getPort()` The TCP port that the AE is listening on or -1 for a network connection that only initiates associations.
`Connection.Protocol`	`getProtocol()`
`int`	`getReceiveBufferSize()` Get the SO_RCVBUF socket value in KB.
`int`	`getReceivePDULength()`
`int`	`getReleaseTimeout()` Timeout in ms for receiving A-RELEASE-RP, 5000 by default.
`int`	`getRequestTimeout()` Timeout in ms for receiving A-ASSOCIATE-RQ, 5000 by default
`int`	`getResponseTimeout()`
`int`	`getRetrieveTimeout()`
`int`	`getSendBufferSize()` Get the SO_SNDBUF socket option value in KB,
`int`	`getSendPDULength()`
`int`	`getSocketCloseDelay()` Delay in ms for Socket close after sending A-ABORT, 50ms by default.
`String[]`	`getTlsCipherSuites()` The TLS CipherSuites that are supported on this particular connection.
`String[]`	`getTlsProtocols()`
`boolean`	`isBlackListed(InetAddress ia)`
`boolean`	`isCompatible(Connection remoteConn)`
`boolean`	`isInstalled()` True if the Network Connection is installed on the network.
`boolean`	`isListening()`
`boolean`	`isPackPDV()`
`boolean`	`isRebindNeeded()`
`boolean`	`isRetrieveTimeoutTotal()`
`boolean`	`isServer()`
`boolean`	`isTcpNoDelay()` Determine if this network connection is using Nagle's algorithm as part of its network communication.
`boolean`	`isTls()`
`boolean`	`isTlsNeedClientAuth()`
`void`	`needRebind()`
`StringBuilder`	`promptTo(StringBuilder sb, String indent)`
`void`	`rebind()`
`void`	`reconfigure(Connection from)`
`static TCPHandler`	`registerTCPProtocolHandler(Connection.Protocol protocol, TCPHandler handler)`
`static UDPHandler`	`registerUDPProtocolHandler(Connection.Protocol protocol, UDPHandler handler)`
`void`	`setAcceptTimeout(int timeout)`
`void`	`setBacklog(int backlog)`
`void`	`setBindAddress(String bindAddress)` Bind address of listening socket or `null`.
`void`	`setBlacklist(String[] blacklist)` Set a list of IP addresses from which we should ignore connections.
`void`	`setClientBindAddress(String bindAddress)` Bind address of outgoing connections, `"0.0.0.0"` or `null`.
`void`	`setCommonName(String name)` An arbitrary name for the Network Connections object.
`void`	`setConnectTimeout(int timeout)`
`void`	`setDevice(Device device)` Set the Device object that this Network Connection belongs to.
`void`	`setHostname(String hostname)` This is the DNS name for this particular connection.
`void`	`setHttpProxy(String proxy)`
`void`	`setIdleTimeout(int idleTimeout)`
`void`	`setInstalled(Boolean installed)` True if the Network Connection is installed on the network.
`void`	`setMaxOpsInvoked(int maxOpsInvoked)`
`void`	`setMaxOpsPerformed(int maxOpsPerformed)`
`void`	`setPackPDV(boolean packPDV)`
`void`	`setPort(int port)` The TCP port that the AE is listening on or 0 for a network connection that only initiates associations.
`void`	`setProtocol(Connection.Protocol protocol)`
`void`	`setReceiveBufferSize(DatagramSocket ds)`
`void`	`setReceiveBufferSize(int size)` Set the SO_RCVBUF socket option to specified value in KB.
`void`	`setReceiveBufferSize(ServerSocket ss)`
`void`	`setReceivePDULength(int receivePDULength)`
`void`	`setReleaseTimeout(int timeout)` Timeout in ms for receiving A-RELEASE-RP, 5000 by default.
`void`	`setRequestTimeout(int timeout)` Timeout in ms for receiving A-ASSOCIATE-RQ, 5000 by default
`void`	`setResponseTimeout(int timeout)`
`void`	`setRetrieveTimeout(int timeout)`
`void`	`setRetrieveTimeoutTotal(boolean retrieveTimeoutTotal)`
`void`	`setSendBufferSize(int size)` Set the SO_SNDBUF socket option to specified value in KB,
`void`	`setSendPDULength(int sendPDULength)`
`void`	`setSocketCloseDelay(int delay)` Delay in ms for Socket close after sending A-ABORT, 50ms by default.
`void`	`setSocketSendOptions(Socket s)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)` Set whether or not this network connection should use Nagle's algorithm as part of its network communication.
`void`	`setTlsCipherSuites(String... tlsCipherSuites)` The TLS CipherSuites that are supported on this particular connection.
`void`	`setTlsNeedClientAuth(boolean tlsNeedClientAuth)`
`void`	`setTlsProtocols(String... tlsProtocols)`
`String`	`toString()`
`void`	`unbind()`
`static TCPHandler`	`unregisterTCPProtocolHandler(Connection.Protocol protocol)`
`static UDPHandler`	`unregisterUDPProtocolHandler(Connection.Protocol protocol)`
`boolean`	`useHttpProxy()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_TIMEOUT
```
public static final int NO_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SYNCHRONOUS_MODE
```
public static final int SYNCHRONOUS_MODE
```
    See Also:
    
    Constant Field Values
  - NOT_LISTENING
```
public static final int NOT_LISTENING
```
    See Also:
    
    Constant Field Values
  - DEF_BACKLOG
```
public static final int DEF_BACKLOG
```
    See Also:
    
    Constant Field Values
  - DEF_SOCKETDELAY
```
public static final int DEF_SOCKETDELAY
```
    See Also:
    
    Constant Field Values
  - DEF_BUFFERSIZE
```
public static final int DEF_BUFFERSIZE
```
    See Also:
    
    Constant Field Values
  - DEF_MAX_PDU_LENGTH
```
public static final int DEF_MAX_PDU_LENGTH
```
    See Also:
    
    Constant Field Values
  - TLS_RSA_WITH_NULL_SHA
```
public static final String TLS_RSA_WITH_NULL_SHA
```
    See Also:
    
    Constant Field Values
  - TLS_RSA_WITH_3DES_EDE_CBC_SHA
```
public static final String TLS_RSA_WITH_3DES_EDE_CBC_SHA
```
    See Also:
    
    Constant Field Values
  - TLS_RSA_WITH_AES_128_CBC_SHA
```
public static final String TLS_RSA_WITH_AES_128_CBC_SHA
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TLS_PROTOCOLS
```
public static final String[] DEFAULT_TLS_PROTOCOLS
```
- Constructor Detail
  - Connection
```
public Connection()
```
  - Connection
```
public Connection(String commonName,
                  String hostname)
```
  - Connection
```
public Connection(String commonName,
                  String hostname,
                  int port)
```
- Method Detail
  - registerTCPProtocolHandler
```
public static TCPHandler registerTCPProtocolHandler(Connection.Protocol protocol,
                                                    TCPHandler handler)
```
  - unregisterTCPProtocolHandler
```
public static TCPHandler unregisterTCPProtocolHandler(Connection.Protocol protocol)
```
  - registerUDPProtocolHandler
```
public static UDPHandler registerUDPProtocolHandler(Connection.Protocol protocol,
                                                    UDPHandler handler)
```
  - unregisterUDPProtocolHandler
```
public static UDPHandler unregisterUDPProtocolHandler(Connection.Protocol protocol)
```
  - getDevice
```
public final Device getDevice()
```
    Get the Device object that this Network Connection belongs to.
    
    Returns:
    
    Device
  - setDevice
```
public final void setDevice(Device device)
```
    Set the Device object that this Network Connection belongs to.
    
    Parameters:
    
    device - The owning Device object.
  - getHostname
```
public final String getHostname()
```
    This is the DNS name for this particular connection. This is used to obtain the current IP address for connections. Hostname must be sufficiently qualified to be unambiguous for any client DNS user.
    
    Returns:
    
    A String containing the host name.
  - setHostname
```
public final void setHostname(String hostname)
```
    This is the DNS name for this particular connection. This is used to obtain the current IP address for connections. Hostname must be sufficiently qualified to be unambiguous for any client DNS user.
    
    Parameters:
    
    hostname - A String containing the host name.
  - getBindAddress
```
public final String getBindAddress()
```
    Bind address of listening socket or null. If null, bind listening socket to getHostname(). This is the default.
    
    Returns:
    
    Bind address of the connection or null
  - setBindAddress
```
public final void setBindAddress(String bindAddress)
```
    Bind address of listening socket or null. If null, bind listening socket to getHostname().
    
    Parameters:
    
    bindAddress - Bind address of listening socket or null
  - getClientBindAddress
```
public String getClientBindAddress()
```
    Bind address of outgoing connections, "0.0.0.0" or null. If "0.0.0.0" the system pick up any local ip for outgoing connections. If null, bind outgoing connections to getHostname(). This is the default.
    
    Returns:
    
    the string
  - setClientBindAddress
```
public void setClientBindAddress(String bindAddress)
```
    Bind address of outgoing connections, "0.0.0.0" or null. If "0.0.0.0" the system pick up any local ip for outgoing connections. If null, bind outgoing connections to getHostname().
    
    Parameters:
    
    bindAddress - Bind address of outgoing connection or null
  - getProtocol
```
public Connection.Protocol getProtocol()
```
  - setProtocol
```
public void setProtocol(Connection.Protocol protocol)
```
  - isRebindNeeded
```
public boolean isRebindNeeded()
```
  - needRebind
```
public void needRebind()
```
  - getCommonName
```
public final String getCommonName()
```
    An arbitrary name for the Network Connections object. Can be a meaningful name or any unique sequence of characters.
    
    Returns:
    
    A String containing the name.
  - setCommonName
```
public final void setCommonName(String name)
```
    An arbitrary name for the Network Connections object. Can be a meaningful name or any unique sequence of characters.
    
    Parameters:
    
    name - A String containing the name.
  - getPort
```
public final int getPort()
```
    The TCP port that the AE is listening on or -1 for a network connection that only initiates associations.
    
    Returns:
    
    An int containing the port number or -1.
  - setPort
```
public final void setPort(int port)
```
    The TCP port that the AE is listening on or 0 for a network connection that only initiates associations. A valid port value is between 0 and 65535.
    
    Parameters:
    
    port - The port number or -1.
  - getHttpProxy
```
public final String getHttpProxy()
```
  - setHttpProxy
```
public final void setHttpProxy(String proxy)
```
  - useHttpProxy
```
public final boolean useHttpProxy()
```
  - isServer
```
public final boolean isServer()
```
  - getBacklog
```
public final int getBacklog()
```
  - setBacklog
```
public final void setBacklog(int backlog)
```
  - getConnectTimeout
```
public final int getConnectTimeout()
```
  - setConnectTimeout
```
public final void setConnectTimeout(int timeout)
```
  - getRequestTimeout
```
public final int getRequestTimeout()
```
    Timeout in ms for receiving A-ASSOCIATE-RQ, 5000 by default
    
    Returns:
    
    the int
  - setRequestTimeout
```
public final void setRequestTimeout(int timeout)
```
    Timeout in ms for receiving A-ASSOCIATE-RQ, 5000 by default
    
    Parameters:
    
    timeout - An int value containing the milliseconds.
  - getAcceptTimeout
```
public final int getAcceptTimeout()
```
  - setAcceptTimeout
```
public final void setAcceptTimeout(int timeout)
```
  - getReleaseTimeout
```
public final int getReleaseTimeout()
```
    Timeout in ms for receiving A-RELEASE-RP, 5000 by default.
    
    Returns:
    
    An int value containing the milliseconds.
  - setReleaseTimeout
```
public final void setReleaseTimeout(int timeout)
```
    Timeout in ms for receiving A-RELEASE-RP, 5000 by default.
    
    Parameters:
    
    timeout - An int value containing the milliseconds.
  - getSocketCloseDelay
```
public final int getSocketCloseDelay()
```
    Delay in ms for Socket close after sending A-ABORT, 50ms by default.
    
    Returns:
    
    An int value containing the milliseconds.
  - setSocketCloseDelay
```
public final void setSocketCloseDelay(int delay)
```
    Delay in ms for Socket close after sending A-ABORT, 50ms by default.
    
    Parameters:
    
    delay - An int value containing the milliseconds.
  - getResponseTimeout
```
public final int getResponseTimeout()
```
  - setResponseTimeout
```
public final void setResponseTimeout(int timeout)
```
  - getRetrieveTimeout
```
public final int getRetrieveTimeout()
```
  - setRetrieveTimeout
```
public final void setRetrieveTimeout(int timeout)
```
  - isRetrieveTimeoutTotal
```
public final boolean isRetrieveTimeoutTotal()
```
  - setRetrieveTimeoutTotal
```
public final void setRetrieveTimeoutTotal(boolean retrieveTimeoutTotal)
```
  - getIdleTimeout
```
public final int getIdleTimeout()
```
  - setIdleTimeout
```
public final void setIdleTimeout(int idleTimeout)
```
  - getTlsCipherSuites
```
public String[] getTlsCipherSuites()
```
    The TLS CipherSuites that are supported on this particular connection. TLS CipherSuites shall be described using an RFC-2246 string representation (e.g. 'SSL_RSA_WITH_3DES_EDE_CBC_SHA')
    
    Returns:
    
    A String array containing the supported cipher suites
  - setTlsCipherSuites
```
public void setTlsCipherSuites(String... tlsCipherSuites)
```
    The TLS CipherSuites that are supported on this particular connection. TLS CipherSuites shall be described using an RFC-2246 string representation (e.g. 'SSL_RSA_WITH_3DES_EDE_CBC_SHA')
    
    Parameters:
    
    tlsCipherSuites - A String array containing the supported cipher suites
  - isTls
```
public final boolean isTls()
```
  - getTlsProtocols
```
public final String[] getTlsProtocols()
```
  - setTlsProtocols
```
public final void setTlsProtocols(String... tlsProtocols)
```
  - isTlsNeedClientAuth
```
public final boolean isTlsNeedClientAuth()
```
  - setTlsNeedClientAuth
```
public final void setTlsNeedClientAuth(boolean tlsNeedClientAuth)
```
  - getReceiveBufferSize
```
public final int getReceiveBufferSize()
```
    Get the SO_RCVBUF socket value in KB.
    
    Returns:
    
    An int value containing the buffer size in KB.
  - setReceiveBufferSize
```
public final void setReceiveBufferSize(int size)
```
    Set the SO_RCVBUF socket option to specified value in KB.
    
    Parameters:
    
    size - An int value containing the buffer size in KB.
  - setReceiveBufferSize
```
public void setReceiveBufferSize(ServerSocket ss)
                          throws SocketException
```
    Throws:
    
    SocketException
  - setReceiveBufferSize
```
public void setReceiveBufferSize(DatagramSocket ds)
                          throws SocketException
```
    Throws:
    
    SocketException
  - getSendBufferSize
```
public final int getSendBufferSize()
```
    Get the SO_SNDBUF socket option value in KB,
    
    Returns:
    
    An int value containing the buffer size in KB.
  - setSendBufferSize
```
public final void setSendBufferSize(int size)
```
    Set the SO_SNDBUF socket option to specified value in KB,
    
    Parameters:
    
    size - An int value containing the buffer size in KB.
  - getSendPDULength
```
public final int getSendPDULength()
```
  - setSendPDULength
```
public final void setSendPDULength(int sendPDULength)
```
  - getReceivePDULength
```
public final int getReceivePDULength()
```
  - setReceivePDULength
```
public final void setReceivePDULength(int receivePDULength)
```
  - getMaxOpsPerformed
```
public final int getMaxOpsPerformed()
```
  - setMaxOpsPerformed
```
public final void setMaxOpsPerformed(int maxOpsPerformed)
```
  - getMaxOpsInvoked
```
public final int getMaxOpsInvoked()
```
  - setMaxOpsInvoked
```
public final void setMaxOpsInvoked(int maxOpsInvoked)
```
  - isPackPDV
```
public final boolean isPackPDV()
```
  - setPackPDV
```
public final void setPackPDV(boolean packPDV)
```
  - isTcpNoDelay
```
public final boolean isTcpNoDelay()
```
    Determine if this network connection is using Nagle's algorithm as part of its network communication.
    
    Returns:
    
    boolean True if TCP no delay (disable Nagle's algorithm) is used.
  - setTcpNoDelay
```
public final void setTcpNoDelay(boolean tcpNoDelay)
```
    Set whether or not this network connection should use Nagle's algorithm as part of its network communication.
    
    Parameters:
    
    tcpNoDelay - boolean True if TCP no delay (disable Nagle's algorithm) should be used.
  - isInstalled
```
public boolean isInstalled()
```
    True if the Network Connection is installed on the network. If not present, information about the installed status of the Network Connection is inherited from the device.
    
    Returns:
    
    boolean True if the NetworkConnection is installed on the network.
  - getInstalled
```
public Boolean getInstalled()
```
  - setInstalled
```
public void setInstalled(Boolean installed)
```
    True if the Network Connection is installed on the network. If not present, information about the installed status of the Network Connection is inherited from the device.
    
    Parameters:
    
    installed - True if the NetworkConnection is installed on the network.
  - rebind
```
public void rebind()
            throws IOException,
                   GeneralSecurityException
```
    Throws:
    
    IOException
    
    GeneralSecurityException
  - getBlacklist
```
public final String[] getBlacklist()
```
    Get a list of IP addresses from which we should ignore connections. Useful in an environment that utilizes a load balancer. In the case of a TCP ping from a load balancing switch, we don't want to spin off a new thread and try to negotiate an association.
    
    Returns:
    
    Returns the list of IP addresses which should be ignored.
  - setBlacklist
```
public final void setBlacklist(String[] blacklist)
```
    Set a list of IP addresses from which we should ignore connections. Useful in an environment that utilizes a load balancer. In the case of a TCP ping from a load balancing switch, we don't want to spin off a new thread and try to negotiate an association.
    
    Parameters:
    
    blacklist - the list of IP addresses which should be ignored.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - promptTo
```
public StringBuilder promptTo(StringBuilder sb,
                              String indent)
```
  - setSocketSendOptions
```
public void setSocketSendOptions(Socket s)
                          throws SocketException
```
    Throws:
    
    SocketException
  - getEndPoint
```
public InetSocketAddress getEndPoint()
                              throws UnknownHostException
```
    Throws:
    
    UnknownHostException
  - getBindPoint
```
public InetSocketAddress getBindPoint()
                               throws UnknownHostException
```
    Throws:
    
    UnknownHostException
  - getClientBindPoint
```
public InetSocketAddress getClientBindPoint()
                                     throws UnknownHostException
```
    Throws:
    
    UnknownHostException
  - bind
```
public boolean bind()
             throws IOException,
                    GeneralSecurityException
```
    Bind this network connection to a TCP port and start a server socket accept loop.
    
    Returns:
    
    the boolean
    
    Throws:
    
    IOException - If there is a problem with the network interaction.
    
    GeneralSecurityException - exception
  - isListening
```
public final boolean isListening()
```
  - isBlackListed
```
public boolean isBlackListed(InetAddress ia)
```
  - unbind
```
public void unbind()
```
  - connect
```
public Socket connect(Connection remoteConn)
               throws IOException,
                      org.aoju.bus.core.lang.exception.InstrumentException,
                      GeneralSecurityException
```
    Throws:
    
    IOException
    
    org.aoju.bus.core.lang.exception.InstrumentException
    
    GeneralSecurityException
  - createDatagramSocket
```
public DatagramSocket createDatagramSocket()
                                    throws IOException
```
    Throws:
    
    IOException
  - getListener
```
public SocketListener getListener()
```
  - close
```
public void close(Socket s)
```
  - isCompatible
```
public boolean isCompatible(Connection remoteConn)
```
  - equalsRDN
```
public boolean equalsRDN(Connection other)
```
  - reconfigure
```
public void reconfigure(Connection from)
```

Class Connection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_TIMEOUT

SYNCHRONOUS_MODE

NOT_LISTENING

DEF_BACKLOG

DEF_SOCKETDELAY

DEF_BUFFERSIZE

DEF_MAX_PDU_LENGTH

TLS_RSA_WITH_NULL_SHA

TLS_RSA_WITH_3DES_EDE_CBC_SHA

TLS_RSA_WITH_AES_128_CBC_SHA

DEFAULT_TLS_PROTOCOLS

Constructor Detail

Connection

Connection

Connection

Method Detail

registerTCPProtocolHandler

unregisterTCPProtocolHandler

registerUDPProtocolHandler

unregisterUDPProtocolHandler

getDevice

setDevice

getHostname

setHostname

getBindAddress

setBindAddress

getClientBindAddress

setClientBindAddress

getProtocol

setProtocol

isRebindNeeded

needRebind

getCommonName

setCommonName

getPort

setPort

getHttpProxy

setHttpProxy

useHttpProxy

isServer

getBacklog

setBacklog

getConnectTimeout

setConnectTimeout

getRequestTimeout

setRequestTimeout

getAcceptTimeout

setAcceptTimeout

getReleaseTimeout

setReleaseTimeout

getSocketCloseDelay

setSocketCloseDelay

getResponseTimeout

setResponseTimeout

getRetrieveTimeout

setRetrieveTimeout

isRetrieveTimeoutTotal

setRetrieveTimeoutTotal

getIdleTimeout

setIdleTimeout

getTlsCipherSuites

setTlsCipherSuites

isTls

getTlsProtocols

setTlsProtocols

isTlsNeedClientAuth

setTlsNeedClientAuth

getReceiveBufferSize

setReceiveBufferSize

setReceiveBufferSize

setReceiveBufferSize

getSendBufferSize

setSendBufferSize