edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector
Class LdapDataConnectorFactoryBean

java.lang.Object
  extended by org.springframework.beans.factory.config.AbstractFactoryBean
      extended by edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean
          extended by edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.BaseDataConnectorFactoryBean
              extended by edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.LdapDataConnectorFactoryBean
All Implemented Interfaces:
BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean, InitializingBean

public class LdapDataConnectorFactoryBean
extends BaseDataConnectorFactoryBean

Spring factory for creating LdapDataConnector beans.


Field Summary
 
Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
logger
 
Constructor Summary
LdapDataConnectorFactoryBean()
           
 
Method Summary
protected  Object createInstance()
          
 LdapDataConnector.AUTHENTICATION_TYPE getAuthenticationType()
          Gets the authentication type used when connecting to the directory.
 String getBaseDN()
          Gets the base search DN.
 org.opensaml.xml.security.x509.X509Credential getConnectionCredential()
          Gets the client authentication material used when connecting to the LDAP via SSL or TLS.
 String getFilterTemplate()
          Gets the LDAP query filter template.
 Map<String,String> getLdapProperties()
          Gets the LDAP connection provider specific properties.
 String getLdapUrl()
          Gets the LDAP server's URL.
 int getMaxResultSize()
          Gets the maximum number of results to return from a query.
 Class getObjectType()
          
 int getPoolInitialSize()
          Gets the initial number of connection to create in the connection pool.
 int getPoolMaxIdleSize()
          Gets the maximum number of idle connection that will be kept in the connection pool.
 String getPrincipal()
          Gets the principal DN used to bind to the directory.
 String getPrincipalCredential()
          Gets the credential of the principal DN used to bind to the directory.
 String[] getReturnAttributes()
          Gets the attributes to return from a query.
 LdapDataConnector.SEARCH_SCOPE getSearchScope()
          Gets the search scope of a query.
 int getSearchTimeLimit()
          Gets the maximum amount of time, in milliseconds, to wait for a search to complete.
 TemplateEngine getTemplateEngine()
          Gets the template engine used to construct query filters.
 org.opensaml.xml.security.x509.X509Credential getTrustCredential()
          Gets the trust material used when connecting to the LDAP via SSL or TLS.
 boolean getUseStartTLS()
          Gets whether to use StartTLS when connecting to the LDAP.
 boolean isCacheResults()
          Gets whether to cache query results.
 boolean isMergeResults()
          Gets whether to merge multiple results into a single result.
 boolean isNoResultsIsError()
          Gets whether a query that returns no results is an error condition.
 void setAuthenticationType(LdapDataConnector.AUTHENTICATION_TYPE type)
          Sets the authentication type used when connecting to the directory.
 void setBaseDN(String dn)
          Sets the base search DN.
 void setCacheResults(boolean cache)
          Sets whether to cache query results.
 void setConnectionCredential(org.opensaml.xml.security.x509.X509Credential credential)
          Sets the client authentication material used when connecting to the LDAP via SSL or TLS.
 void setFilterTemplate(String template)
          Sets the LDAP query filter template.
 void setLdapProperties(Map<String,String> properties)
          Sets the LDAP connection provider specific properties.
 void setLdapUrl(String url)
          Sets the LDAP server's URL.
 void setMaxResultSize(int max)
          Sets the maximum number of results to return from a query.
 void setMergeResults(boolean merge)
          Sets whether to merge multiple results into a single result.
 void setNoResultsIsError(boolean isError)
          Sets whether a query that returns no results is an error condition.
 void setPoolInitialSize(int initialSize)
          Sets the initial number of connection to create in the connection pool.
 void setPoolMaxIdleSize(int maxIdle)
          Sets the maximum number of idle connection that will be kept in the connection pool.
 void setPrincipal(String principalName)
          Sets the principal DN used to bind to the directory.
 void setPrincipalCredential(String credential)
          Sets the credential of the principal DN used to bind to the directory.
 void setReturnAttributes(String[] attributes)
          Sets the attributes to return from a query.
 void setSearchScope(LdapDataConnector.SEARCH_SCOPE scope)
          Sets the search scope of a query.
 void setSearchTimeLimit(int timeLimit)
          Sets the maximum amount of time, in milliseconds, to wait for a search to complete.
 void setTemplateEngine(TemplateEngine engine)
          Sets the template engine used to construct query filters.
 void setTrustCredential(org.opensaml.xml.security.x509.X509Credential credential)
          Sets the trust material used when connecting to the LDAP via SSL or TLS.
 void setUseStartTLS(boolean startTLS)
          Sets whether to use StartTLS when connecting to the LDAP.
 
Methods inherited from class edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.BaseDataConnectorFactoryBean
getFailoverDataConnectorId, populateDataConnector, setFailoverDataConnectorIds
 
Methods inherited from class edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean
getDependencyIds, getPluginId, setDependencyIds, setPluginId
 
Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LdapDataConnectorFactoryBean

public LdapDataConnectorFactoryBean()
Method Detail

createInstance

protected Object createInstance()
                         throws Exception

Specified by:
createInstance in class AbstractFactoryBean
Throws:
Exception

getAuthenticationType

public LdapDataConnector.AUTHENTICATION_TYPE getAuthenticationType()
Gets the authentication type used when connecting to the directory.

Returns:
authentication type used when connecting to the directory

getBaseDN

public String getBaseDN()
Gets the base search DN.

Returns:
the base search DN

getConnectionCredential

public org.opensaml.xml.security.x509.X509Credential getConnectionCredential()
Gets the client authentication material used when connecting to the LDAP via SSL or TLS.

Returns:
client authentication material used when connecting to the LDAP via SSL or TLS

getFilterTemplate

public String getFilterTemplate()
Gets the LDAP query filter template.

Returns:
LDAP query filter template

getLdapProperties

public Map<String,String> getLdapProperties()
Gets the LDAP connection provider specific properties.

Returns:
LDAP connection provider specific properties

getLdapUrl

public String getLdapUrl()
Gets the LDAP server's URL.

Returns:
LDAP server's URL

getMaxResultSize

public int getMaxResultSize()
Gets the maximum number of results to return from a query.

Returns:
maximum number of results to return from a query

getObjectType

public Class getObjectType()

Specified by:
getObjectType in interface FactoryBean
Specified by:
getObjectType in class AbstractFactoryBean

getPoolInitialSize

public int getPoolInitialSize()
Gets the initial number of connection to create in the connection pool.

Returns:
initial number of connection to create in the connection pool

getPoolMaxIdleSize

public int getPoolMaxIdleSize()
Gets the maximum number of idle connection that will be kept in the connection pool.

Returns:
maximum number of idle connection that will be kept in the connection pool

getPrincipal

public String getPrincipal()
Gets the principal DN used to bind to the directory.

Returns:
principal DN used to bind to the directory

getPrincipalCredential

public String getPrincipalCredential()
Gets the credential of the principal DN used to bind to the directory.

Returns:
credential of the principal DN used to bind to the directory

getReturnAttributes

public String[] getReturnAttributes()
Gets the attributes to return from a query.

Returns:
attributes to return from a query

getSearchScope

public LdapDataConnector.SEARCH_SCOPE getSearchScope()
Gets the search scope of a query.

Returns:
search scope of a query

getSearchTimeLimit

public int getSearchTimeLimit()
Gets the maximum amount of time, in milliseconds, to wait for a search to complete.

Returns:
maximum amount of time, in milliseconds, to wait for a search to complete

getTemplateEngine

public TemplateEngine getTemplateEngine()
Gets the template engine used to construct query filters.

Returns:
template engine used to construct query filters

getTrustCredential

public org.opensaml.xml.security.x509.X509Credential getTrustCredential()
Gets the trust material used when connecting to the LDAP via SSL or TLS.

Returns:
trust material used when connecting to the LDAP via SSL or TLS

getUseStartTLS

public boolean getUseStartTLS()
Gets whether to use StartTLS when connecting to the LDAP.

Returns:
whether to use StartTLS when connecting to the LDAP

isCacheResults

public boolean isCacheResults()
Gets whether to cache query results.

Returns:
whether to cache query results.

isMergeResults

public boolean isMergeResults()
Gets whether to merge multiple results into a single result.

Returns:
whether to merge multiple results into a single result

isNoResultsIsError

public boolean isNoResultsIsError()
Gets whether a query that returns no results is an error condition.

Returns:
whether a query that returns no results is an error condition

setAuthenticationType

public void setAuthenticationType(LdapDataConnector.AUTHENTICATION_TYPE type)
Sets the authentication type used when connecting to the directory.

Parameters:
type - authentication type used when connecting to the directory

setBaseDN

public void setBaseDN(String dn)
Sets the base search DN.

Parameters:
dn - the base search DN

setCacheResults

public void setCacheResults(boolean cache)
Sets whether to cache query results.

Parameters:
cache - whether to cache query results

setConnectionCredential

public void setConnectionCredential(org.opensaml.xml.security.x509.X509Credential credential)
Sets the client authentication material used when connecting to the LDAP via SSL or TLS.

Parameters:
credential - client authentication material used when connecting to the LDAP via SSL or TLS

setFilterTemplate

public void setFilterTemplate(String template)
Sets the LDAP query filter template.

Parameters:
template - LDAP query filter template

setLdapProperties

public void setLdapProperties(Map<String,String> properties)
Sets the LDAP connection provider specific properties.

Parameters:
properties - LDAP connection provider specific properties

setLdapUrl

public void setLdapUrl(String url)
Sets the LDAP server's URL.

Parameters:
url - LDAP server's URL

setMaxResultSize

public void setMaxResultSize(int max)
Sets the maximum number of results to return from a query.

Parameters:
max - maximum number of results to return from a query

setMergeResults

public void setMergeResults(boolean merge)
Sets whether to merge multiple results into a single result.

Parameters:
merge - Twhether to merge multiple results into a single result

setNoResultsIsError

public void setNoResultsIsError(boolean isError)
Sets whether a query that returns no results is an error condition.

Parameters:
isError - whether a query that returns no results is an error condition

setPoolInitialSize

public void setPoolInitialSize(int initialSize)
Sets the initial number of connection to create in the connection pool.

Parameters:
initialSize - initial number of connection to create in the connection pool

setPoolMaxIdleSize

public void setPoolMaxIdleSize(int maxIdle)
Sets the maximum number of idle connection that will be kept in the connection pool.

Parameters:
maxIdle - maximum number of idle connection that will be kept in the connection pool

setPrincipal

public void setPrincipal(String principalName)
Sets the principal DN used to bind to the directory.

Parameters:
principalName - principal DN used to bind to the directory

setPrincipalCredential

public void setPrincipalCredential(String credential)
Sets the credential of the principal DN used to bind to the directory.

Parameters:
credential - credential of the principal DN used to bind to the directory

setReturnAttributes

public void setReturnAttributes(String[] attributes)
Sets the attributes to return from a query.

Parameters:
attributes - attributes to return from a query

setSearchScope

public void setSearchScope(LdapDataConnector.SEARCH_SCOPE scope)
Sets the search scope of a query.

Parameters:
scope - search scope of a query

setSearchTimeLimit

public void setSearchTimeLimit(int timeLimit)
Sets the maximum amount of time, in milliseconds, to wait for a search to complete.

Parameters:
timeLimit - maximum amount of time, in milliseconds, to wait for a search to complete

setTemplateEngine

public void setTemplateEngine(TemplateEngine engine)
Sets the template engine used to construct query filters.

Parameters:
engine - template engine used to construct query filters

setTrustCredential

public void setTrustCredential(org.opensaml.xml.security.x509.X509Credential credential)
Sets the trust material used when connecting to the LDAP via SSL or TLS.

Parameters:
credential - trust material used when connecting to the LDAP via SSL or TLS

setUseStartTLS

public void setUseStartTLS(boolean startTLS)
Sets whether to use StartTLS when connecting to the LDAP.

Parameters:
startTLS - whether to use StartTLS when connecting to the LDAP


Copyright © 2006-2009 Internet2. All Rights Reserved.