org.ldaptive.ssl

Class SocketConfig

java.lang.Object

org.ldaptive.AbstractConfig

org.ldaptive.ssl.SocketConfig

public class SocketConfig
extends AbstractConfig

Contains the configuration data for sockets.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Boolean	keepAlive Keep alive.
private java.lang.Boolean	oobInline OOB Inline.
private java.lang.Integer	receiveBufferSize Receive buffer size.
private java.lang.Boolean	reuseAddress Reuse address.
private java.lang.Integer	sendBufferSize Send buffer size.
private java.lang.Integer	soLinger SO Linger.
private java.lang.Integer	soTimeout SO Timeout.
private java.lang.Boolean	tcpNoDelay TCP No Delay.
private java.lang.Integer	trafficClass Traffic Class.

Fields inherited from class org.ldaptive.AbstractConfig

logger

Constructor Summary

Constructors

Constructor and Description
SocketConfig()

Method Summary

Modifier and Type	Method and Description
void	configureSocket(java.net.Socket socket) Applies this configuration to the supplied socket.
java.lang.Boolean	getKeepAlive() See Socket.getKeepAlive().
java.lang.Boolean	getOOBInline() See Socket.getOOBInline().
java.lang.Integer	getReceiveBufferSize() See Socket.getReceiveBufferSize().
java.lang.Boolean	getReuseAddress() See Socket.getReuseAddress().
java.lang.Integer	getSendBufferSize() See Socket.getSendBufferSize().
java.lang.Integer	getSoLinger() See Socket.getSoLinger().
java.lang.Integer	getSoTimeout() See Socket.getSoTimeout().
java.lang.Boolean	getTcpNoDelay() See Socket.getTcpNoDelay().
java.lang.Integer	getTrafficClass() See Socket.getTrafficClass().
boolean	isEmpty() Returns whether this socket config contains any configuration data.
void	setKeepAlive(boolean b) See Socket.setKeepAlive(boolean).
void	setOOBInline(boolean b) See Socket.setOOBInline(boolean).
void	setReceiveBufferSize(int i) See Socket.setReceiveBufferSize(int).
void	setReuseAddress(boolean b) See Socket.setReuseAddress(boolean).
void	setSendBufferSize(int i) See Socket.setSendBufferSize(int).
void	setSoLinger(int i) See Socket.setSoLinger(boolean, int).
void	setSoTimeout(int i) See Socket.setSoTimeout(int).
void	setTcpNoDelay(boolean b) See Socket.setTcpNoDelay(boolean).
void	setTrafficClass(int i) See Socket.setTrafficClass(int).
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractConfig

checkImmutable, checkStringInput, makeImmutable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

keepAlive

private java.lang.Boolean keepAlive

Keep alive.

oobInline

private java.lang.Boolean oobInline

OOB Inline.

receiveBufferSize

private java.lang.Integer receiveBufferSize

Receive buffer size.

sendBufferSize

private java.lang.Integer sendBufferSize

Send buffer size.

reuseAddress

private java.lang.Boolean reuseAddress

Reuse address.

soLinger

private java.lang.Integer soLinger

SO Linger.

soTimeout

private java.lang.Integer soTimeout

SO Timeout.

tcpNoDelay

private java.lang.Boolean tcpNoDelay

TCP No Delay.

trafficClass

private java.lang.Integer trafficClass

Traffic Class.

Constructor Detail

SocketConfig

public SocketConfig()

Method Detail

isEmpty

public boolean isEmpty()

Returns whether this socket config contains any configuration data.

Returns:

whether all properties are null

getKeepAlive

public java.lang.Boolean getKeepAlive()

See Socket.getKeepAlive().

Returns:

keep alive

setKeepAlive

public void setKeepAlive(boolean b)

See Socket.setKeepAlive(boolean).

Parameters:

b - keep alive

getOOBInline

public java.lang.Boolean getOOBInline()

See Socket.getOOBInline().

Returns:

OOB in line

setOOBInline

public void setOOBInline(boolean b)

See Socket.setOOBInline(boolean).

Parameters:

b - OOB in line

getReceiveBufferSize

public java.lang.Integer getReceiveBufferSize()

See Socket.getReceiveBufferSize().

Returns:

receive buffer size

setReceiveBufferSize

public void setReceiveBufferSize(int i)

See Socket.setReceiveBufferSize(int).

Parameters:

i - receive buffer size

getSendBufferSize

public java.lang.Integer getSendBufferSize()

See Socket.getSendBufferSize().

Returns:

send buffer size

setSendBufferSize

public void setSendBufferSize(int i)

See Socket.setSendBufferSize(int).

Parameters:

i - send buffer size

getReuseAddress

public java.lang.Boolean getReuseAddress()

See Socket.getReuseAddress().

Returns:

reuse address

setReuseAddress

public void setReuseAddress(boolean b)

See Socket.setReuseAddress(boolean).

Parameters:

b - reuse address

getSoLinger

public java.lang.Integer getSoLinger()

See Socket.getSoLinger().

Returns:

SO linger

setSoLinger

public void setSoLinger(int i)

See Socket.setSoLinger(boolean, int).

Parameters:

i - SO linger

getSoTimeout

public java.lang.Integer getSoTimeout()

See Socket.getSoTimeout().

Returns:

SO timeout

setSoTimeout

public void setSoTimeout(int i)

See Socket.setSoTimeout(int).

Parameters:

i - SO timeout

getTcpNoDelay

public java.lang.Boolean getTcpNoDelay()

See Socket.getTcpNoDelay().

Returns:

tcp no delay

setTcpNoDelay

public void setTcpNoDelay(boolean b)

See Socket.setTcpNoDelay(boolean).

Parameters:

b - tcp no delay

getTrafficClass

public java.lang.Integer getTrafficClass()

See Socket.getTrafficClass().

Returns:

traffic class

setTrafficClass

public void setTrafficClass(int i)

See Socket.setTrafficClass(int).

Parameters:

i - traffic class

configureSocket

public void configureSocket(java.net.Socket socket)
                     throws java.net.SocketException

Applies this configuration to the supplied socket.

Parameters:

socket - to set properties on

Throws:

java.net.SocketException - if an error occurs invoking a socket setter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object