org.apache.directory.server.config.beans

Class TransportBean

java.lang.Object

org.apache.directory.server.config.beans.AdsBaseBean

org.apache.directory.server.config.beans.TransportBean

Direct Known Subclasses:

TcpTransportBean, UdpTransportBean

public class TransportBean
extends AdsBaseBean

A class used to store the Transport configuration.

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_BACKLOG_NB The default backlog queue size
private static int	DEFAULT_NB_THREADS The default number of threads
private java.util.List<java.lang.String>	enabledCiphers The transport list of enabled ciphers
private java.util.List<java.lang.String>	enabledProtocols The transport list of enabled protocols
private boolean	needClientAuth The transport 'need client auth' flag
private int	systemPort The port number
private java.lang.String	transportAddress The transport address
private int	transportBackLog The backlog for the transport services
private boolean	transportEnableSsl A flag set if SSL is enabled
private java.lang.String	transportId The unique identifier for this transport
private int	transportNbThreads The number of threads to use for the IoAcceptor executor
private boolean	wantClientAuth The transport 'want client auth' flag

Constructor Summary

Constructors

Constructor and Description
TransportBean() Create a new TransportBean instance

Method Summary

Modifier and Type	Method and Description
void	addEnabledCiphers(java.lang.String... enabledCiphers)
void	addEnabledProtocols(java.lang.String... enabledProtocols)
java.util.List<java.lang.String>	getEnabledCiphers()
java.util.List<java.lang.String>	getEnabledProtocols()
boolean	getNeedClientAuth()
int	getSystemPort()
java.lang.String	getTransportAddress()
int	getTransportBackLog()
java.lang.String	getTransportId()
int	getTransportNbThreads()
boolean	getWantClientAuth()
boolean	isTransportEnableSSL()
void	setEnabledCiphers(java.util.List<java.lang.String> enabledCiphers)
void	setEnabledProtocols(java.util.List<java.lang.String> enabledProtocols)
void	setNeedClientAuth(boolean needClientAuth)
void	setSystemPort(int systemPort)
void	setTransportAddress(java.lang.String transportAddress)
void	setTransportBackLog(int transportBacklog) Sets the size of the incoming requests waiting queue
void	setTransportEnableSSL(boolean transportEnableSSL) Enable or disable SSL
void	setTransportId(java.lang.String transportId)
void	setTransportNbThreads(int transportNbThreads) Sets the number of thread to use to process incoming requests
void	setWantClientAuth(boolean wantClientAuth)
java.lang.String	toString()
java.lang.String	toString(java.lang.String tabs)

Methods inherited from class org.apache.directory.server.config.beans.AdsBaseBean

getDescription, getDn, isDisabled, isEnabled, setDescription, setDn, setEnabled, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BACKLOG_NB

private static final int DEFAULT_BACKLOG_NB

The default backlog queue size

See Also:

Constant Field Values

DEFAULT_NB_THREADS

private static final int DEFAULT_NB_THREADS

The default number of threads

See Also:

Constant Field Values

transportId

@ConfigurationElement(attributeType="ads-transportId",
                      isRdn=true)
private java.lang.String transportId

The unique identifier for this transport

transportAddress

@ConfigurationElement(attributeType="ads-transportAddress")
private java.lang.String transportAddress

The transport address

systemPort

@ConfigurationElement(attributeType="ads-systemPort")
private int systemPort

The port number

transportEnableSsl

@ConfigurationElement(attributeType="ads-transportEnableSsl",
                      isOptional=true,
                      defaultValue="false")
private boolean transportEnableSsl

A flag set if SSL is enabled

transportNbThreads

@ConfigurationElement(attributeType="ads-transportNbThreads",
                      isOptional=true,
                      defaultValue="3")
private int transportNbThreads

The number of threads to use for the IoAcceptor executor

transportBackLog

@ConfigurationElement(attributeType="ads-transportBackLog",
                      isOptional=true,
                      defaultValue="50")
private int transportBackLog

The backlog for the transport services

enabledCiphers

@ConfigurationElement(attributeType="ads-enabledCiphers",
                      isOptional=true)
private java.util.List<java.lang.String> enabledCiphers

The transport list of enabled ciphers

enabledProtocols

@ConfigurationElement(attributeType="ads-enabledProtocols",
                      isOptional=true)
private java.util.List<java.lang.String> enabledProtocols

The transport list of enabled protocols

needClientAuth

@ConfigurationElement(attributeType="ads-needClientAuth",
                      isOptional=true,
                      defaultValue="false")
private boolean needClientAuth

The transport 'need client auth' flag

wantClientAuth

@ConfigurationElement(attributeType="ads-wantClientAuth",
                      isOptional=true,
                      defaultValue="false")
private boolean wantClientAuth

The transport 'want client auth' flag

Constructor Detail

TransportBean

public TransportBean()

Create a new TransportBean instance

Method Detail

setSystemPort

public void setSystemPort(int systemPort)

Parameters:

systemPort - the port to set

getSystemPort

public int getSystemPort()

Returns:

the port

setTransportAddress

public void setTransportAddress(java.lang.String transportAddress)

Parameters:

transportAddress - the address to set

getTransportAddress

public java.lang.String getTransportAddress()

Returns:

the address

isTransportEnableSSL

public boolean isTransportEnableSSL()

Returns:

true id SSL is enabled for this transport

setTransportEnableSSL

public void setTransportEnableSSL(boolean transportEnableSSL)

Enable or disable SSL

Parameters:

transportEnableSSL - if true, SSL is enabled.

getTransportNbThreads

public int getTransportNbThreads()

Returns:

The number of threads used to handle the incoming requests

setTransportNbThreads

public void setTransportNbThreads(int transportNbThreads)

Sets the number of thread to use to process incoming requests

Parameters:

The - number of threads

getTransportBackLog

public int getTransportBackLog()

Returns:

the size of the incoming request waiting queue

setTransportBackLog

public void setTransportBackLog(int transportBacklog)

Sets the size of the incoming requests waiting queue

Parameters:

The - size of waiting request queue

getTransportId

public java.lang.String getTransportId()

Returns:

the transportId

setTransportId

public void setTransportId(java.lang.String transportId)

Parameters:

transportId - the transportId to set

setNeedClientAuth

public void setNeedClientAuth(boolean needClientAuth)

Parameters:

needClientAuth - The flag to set when the client authentication is needed

getNeedClientAuth

public boolean getNeedClientAuth()

Returns:

the needClientAuth flag

setWantClientAuth

public void setWantClientAuth(boolean wantClientAuth)

Parameters:

wantClientAuth - The flag to set when the client authentication is wanted

getWantClientAuth

public boolean getWantClientAuth()

Returns:

the wantClientAuth flag

getEnabledCiphers

public java.util.List<java.lang.String> getEnabledCiphers()

Returns:

the EnabledCiphers list

setEnabledCiphers

public void setEnabledCiphers(java.util.List<java.lang.String> enabledCiphers)

Parameters:

enabledCiphers - the enabledCiphers to set

addEnabledCiphers

public void addEnabledCiphers(java.lang.String... enabledCiphers)

Parameters:

enabledCiphers - the enabledCiphers to add

getEnabledProtocols

public java.util.List<java.lang.String> getEnabledProtocols()

Returns:

the enabledProtocols list

setEnabledProtocols

public void setEnabledProtocols(java.util.List<java.lang.String> enabledProtocols)

Parameters:

enabledProtocols - the enabledProtocols to set

addEnabledProtocols

public void addEnabledProtocols(java.lang.String... enabledProtocols)

Parameters:

enabledProtocols - the enabledProtocols to add

toString

public java.lang.String toString(java.lang.String tabs)

Overrides:

toString in class AdsBaseBean

toString

public java.lang.String toString()

Overrides:

toString in class AdsBaseBean