com.atlassian.user.impl.ldap.properties
Interface LdapConnectionProperties

All Known Implementing Classes:

DefaultLdapConnectionProperties

public interface LdapConnectionProperties

An interface for providing connection properties for connecting to an LDAP server via JNDI

Method Summary

int	getConnectTimeoutMillis()
String	getJNDIInitialContextFactoryIdentifier()
String	getProviderURL()
int	getReadTimeoutMillis()
int	getSearchBatchSize()
String	getSecurityAuthentication()
String	getSecurityCredential()
String	getSecurityPrincipal()
String	getSecurityProtocol()
boolean	isPoolingOn()

Method Detail

getSecurityPrincipal

String getSecurityPrincipal()

Returns:

the user to be used for authenticating to the LDAP server

See Also:

Context.SECURITY_PRINCIPAL

getSecurityCredential

String getSecurityCredential()

Returns:

the password to be used for authenticating to the LDAP server

See Also:

Context.SECURITY_CREDENTIALS

getProviderURL

String getProviderURL()

Returns:

the URL of the LDAP server to connect to, typically in the form 'ldap://host:port'

See Also:

Context.PROVIDER_URL

getJNDIInitialContextFactoryIdentifier

String getJNDIInitialContextFactoryIdentifier()

Returns:

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

See Also:

Context.INITIAL_CONTEXT_FACTORY

getSearchBatchSize

int getSearchBatchSize()

Returns:

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

See Also:

Context.BATCHSIZE

getSecurityAuthentication

String getSecurityAuthentication()

Returns:

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

See Also:

Context.SECURITY_AUTHENTICATION

getSecurityProtocol

String getSecurityProtocol()

Returns:

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

See Also:

Context.SECURITY_PROTOCOL

isPoolingOn

boolean isPoolingOn()

Returns:

true if LDAP connection pooling is enabled, otherwise false.

getConnectTimeoutMillis

int getConnectTimeoutMillis()

Returns:

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

getReadTimeoutMillis

int getReadTimeoutMillis()

Returns:

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