com.atlassian.user.impl.ldap.properties
Class DefaultLdapConnectionProperties

java.lang.Object
  com.atlassian.user.impl.ldap.properties.DefaultLdapConnectionProperties

All Implemented Interfaces:

LdapConnectionProperties

public class DefaultLdapConnectionProperties
extends Object
implements LdapConnectionProperties

Field Summary

static String	DEFAULT_AUTHENTICATION
static int	DEFAULT_BATCH_SIZE
static int	DEFAULT_CONNECT_TIMEOUT_MILLIS
static int	DEFAULT_LDAP_PORT
static int	DEFAULT_READ_TIMEOUT_MILLIS

Constructor Summary

DefaultLdapConnectionProperties()

Method Summary

int	getConnectTimeoutMillis()
String	getJNDIInitialContextFactoryIdentifier()
String	getProviderURL() If the provider URL has been set explicitly by setProviderURL(String) returns that value, otherwise returns a concatenation of protocol, host and port in the form 'ldaps://localhost:389'.
int	getReadTimeoutMillis()
int	getSearchBatchSize()
String	getSecurityAuthentication()
String	getSecurityCredential()
String	getSecurityPrincipal()
String	getSecurityProtocol()
boolean	isPoolingOn()
void	setConnectTimeoutMillis(int connectTimeoutMillis)
void	setHost(String host)
void	setJndiInitialContextFactoryIdentifier(String jndiInitialContextFactoryIdentifier)
void	setPoolingOn(boolean poolingOn)
void	setPort(int port)
void	setProviderURL(String providerURL)
void	setReadTimeoutMillis(int readTimeoutMillis)
void	setSearchBatchSize(int searchBatchSize)
void	setSecurityAuthentication(String securityAuthentication)
void	setSecurityCredential(String securityCredential)
void	setSecurityPrincipal(String securityPrincipal)
void	setSecurityProtocol(String securityProtocol)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LDAP_PORT

public static final int DEFAULT_LDAP_PORT

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT_MILLIS

public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT_MILLIS

public static final int DEFAULT_READ_TIMEOUT_MILLIS

See Also:

Constant Field Values

DEFAULT_AUTHENTICATION

public static final String DEFAULT_AUTHENTICATION

See Also:

Constant Field Values

Constructor Detail

DefaultLdapConnectionProperties

public DefaultLdapConnectionProperties()

Method Detail

getSecurityPrincipal

public String getSecurityPrincipal()

Specified by:

getSecurityPrincipal in interface LdapConnectionProperties

Returns:

the user to be used for authenticating to the LDAP server

See Also:

Context.SECURITY_PRINCIPAL

getSecurityCredential

public String getSecurityCredential()

Specified by:

getSecurityCredential in interface LdapConnectionProperties

Returns:

the password to be used for authenticating to the LDAP server

See Also:

Context.SECURITY_CREDENTIALS

getProviderURL

public String getProviderURL()

If the provider URL has been set explicitly by setProviderURL(String) returns that value, otherwise returns a concatenation of protocol, host and port in the form 'ldaps://localhost:389'.

Specified by:

getProviderURL in interface LdapConnectionProperties

Returns:

the configured provider URL

See Also:

Context.PROVIDER_URL

getJNDIInitialContextFactoryIdentifier

public String getJNDIInitialContextFactoryIdentifier()

Specified by:

getJNDIInitialContextFactoryIdentifier in interface LdapConnectionProperties

Returns:

the fully-qualified class name of the JNDI InitialContextFactory to use for opening the connection

See Also:

Context.INITIAL_CONTEXT_FACTORY

getSearchBatchSize

public int getSearchBatchSize()

Specified by:

getSearchBatchSize in interface LdapConnectionProperties

Returns:

the batch size used for search results returned from the LDAP server

See Also:

Context.BATCHSIZE

getSecurityAuthentication

public String getSecurityAuthentication()

Specified by:

getSecurityAuthentication in interface LdapConnectionProperties

Returns:

the type of security to use for authentication, for example "simple"

See Also:

Context.SECURITY_AUTHENTICATION

getSecurityProtocol

public String getSecurityProtocol()

Specified by:

getSecurityProtocol in interface LdapConnectionProperties

Returns:

the type of security to use for the LDAP connection, for example "ssl"

See Also:

Context.SECURITY_PROTOCOL

isPoolingOn

public boolean isPoolingOn()

Specified by:

isPoolingOn in interface LdapConnectionProperties

Returns:

true if LDAP connection pooling is enabled, otherwise false.

getConnectTimeoutMillis

public int getConnectTimeoutMillis()

Specified by:

getConnectTimeoutMillis in interface LdapConnectionProperties

Returns:

the time limit in milliseconds to be used when connecting to the LDAP server

getReadTimeoutMillis

public int getReadTimeoutMillis()

Specified by:

getReadTimeoutMillis in interface LdapConnectionProperties

Returns:

the time limit in milliseconds to be used when reading data from the LDAP server

setSecurityPrincipal

public void setSecurityPrincipal(String securityPrincipal)

setSecurityCredential

public void setSecurityCredential(String securityCredential)

setHost

public void setHost(String host)

setPort

public void setPort(int port)

setJndiInitialContextFactoryIdentifier

public void setJndiInitialContextFactoryIdentifier(String jndiInitialContextFactoryIdentifier)

setSearchBatchSize

public void setSearchBatchSize(int searchBatchSize)

setSecurityAuthentication

public void setSecurityAuthentication(String securityAuthentication)

setSecurityProtocol

public void setSecurityProtocol(String securityProtocol)

setPoolingOn

public void setPoolingOn(boolean poolingOn)

setProviderURL

public void setProviderURL(String providerURL)

setConnectTimeoutMillis

public void setConnectTimeoutMillis(int connectTimeoutMillis)

setReadTimeoutMillis

public void setReadTimeoutMillis(int readTimeoutMillis)

toString

public String toString()

Overrides:

toString in class Object