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

java.lang.Object
  extended bycom.atlassian.user.impl.ldap.properties.DefaultLdapConnectionProperties
All Implemented Interfaces:
LdapConnectionProperties

public class DefaultLdapConnectionProperties
extends java.lang.Object
implements LdapConnectionProperties


Field Summary
static java.lang.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()
           
 java.lang.String getJNDIInitialContextFactoryIdentifier()
           
 java.lang.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()
           
 java.lang.String getSecurityAuthentication()
           
 java.lang.String getSecurityCredential()
           
 java.lang.String getSecurityPrincipal()
           
 java.lang.String getSecurityProtocol()
           
 boolean isPoolingOn()
           
 void setConnectTimeoutMillis(int connectTimeoutMillis)
           
 void setHost(java.lang.String host)
           
 void setJndiInitialContextFactoryIdentifier(java.lang.String jndiInitialContextFactoryIdentifier)
           
 void setPoolingOn(boolean poolingOn)
           
 void setPort(int port)
           
 void setProviderURL(java.lang.String providerURL)
           
 void setReadTimeoutMillis(int readTimeoutMillis)
           
 void setSearchBatchSize(int searchBatchSize)
           
 void setSecurityAuthentication(java.lang.String securityAuthentication)
           
 void setSecurityCredential(java.lang.String securityCredential)
           
 void setSecurityPrincipal(java.lang.String securityPrincipal)
           
 void setSecurityProtocol(java.lang.String securityProtocol)
           
 java.lang.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 java.lang.String DEFAULT_AUTHENTICATION
See Also:
Constant Field Values
Constructor Detail

DefaultLdapConnectionProperties

public DefaultLdapConnectionProperties()
Method Detail

getSecurityPrincipal

public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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(java.lang.String securityPrincipal)

setSecurityCredential

public void setSecurityCredential(java.lang.String securityCredential)

setHost

public void setHost(java.lang.String host)

setPort

public void setPort(int port)

setJndiInitialContextFactoryIdentifier

public void setJndiInitialContextFactoryIdentifier(java.lang.String jndiInitialContextFactoryIdentifier)

setSearchBatchSize

public void setSearchBatchSize(int searchBatchSize)

setSecurityAuthentication

public void setSecurityAuthentication(java.lang.String securityAuthentication)

setSecurityProtocol

public void setSecurityProtocol(java.lang.String securityProtocol)

setPoolingOn

public void setPoolingOn(boolean poolingOn)

setProviderURL

public void setProviderURL(java.lang.String providerURL)

setConnectTimeoutMillis

public void setConnectTimeoutMillis(int connectTimeoutMillis)

setReadTimeoutMillis

public void setReadTimeoutMillis(int readTimeoutMillis)

toString

public java.lang.String toString()


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