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()
           
 java.lang.String getJNDIInitialContextFactoryIdentifier()
           
 java.lang.String getProviderURL()
           
 int getReadTimeoutMillis()
           
 int getSearchBatchSize()
           
 java.lang.String getSecurityAuthentication()
           
 java.lang.String getSecurityCredential()
           
 java.lang.String getSecurityPrincipal()
           
 java.lang.String getSecurityProtocol()
           
 boolean isPoolingOn()
           
 

Method Detail

getSecurityPrincipal

public java.lang.String getSecurityPrincipal()
Returns:
the user to be used for authenticating to the LDAP server
See Also:
Context.SECURITY_PRINCIPAL

getSecurityCredential

public java.lang.String getSecurityCredential()
Returns:
the password to be used for authenticating to the LDAP server
See Also:
Context.SECURITY_CREDENTIALS

getProviderURL

public java.lang.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

public java.lang.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

public int getSearchBatchSize()
Returns:
the batch size used for search results returned from the LDAP server
See Also:
Context.BATCHSIZE

getSecurityAuthentication

public java.lang.String getSecurityAuthentication()
Returns:
the type of security to use for authentication, for example "simple"
See Also:
Context.SECURITY_AUTHENTICATION

getSecurityProtocol

public java.lang.String getSecurityProtocol()
Returns:
the type of security to use for the LDAP connection, for example "ssl"
See Also:
Context.SECURITY_PROTOCOL

isPoolingOn

public boolean isPoolingOn()
Returns:
true if LDAP connection pooling is enabled, otherwise false.

getConnectTimeoutMillis

public int getConnectTimeoutMillis()
Returns:
the time limit in milliseconds to be used when connecting to the LDAP server

getReadTimeoutMillis

public int getReadTimeoutMillis()
Returns:
the time limit in milliseconds to be used when reading data from the LDAP server


Copyright © 2005-2008 Atlassian Software Systems Pty Ltd. All Rights Reserved.