|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.beans.factory.config.AbstractFactoryBean
edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean
edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.BaseDataConnectorFactoryBean
edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.LdapDataConnectorFactoryBean
public class LdapDataConnectorFactoryBean
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 |
---|
public LdapDataConnectorFactoryBean()
Method Detail |
---|
protected Object createInstance() throws Exception
createInstance
in class AbstractFactoryBean
Exception
public LdapDataConnector.AUTHENTICATION_TYPE getAuthenticationType()
public String getBaseDN()
public org.opensaml.xml.security.x509.X509Credential getConnectionCredential()
public String getFilterTemplate()
public Map<String,String> getLdapProperties()
public String getLdapUrl()
public int getMaxResultSize()
public Class getObjectType()
getObjectType
in interface FactoryBean
getObjectType
in class AbstractFactoryBean
public int getPoolInitialSize()
public int getPoolMaxIdleSize()
public String getPrincipal()
public String getPrincipalCredential()
public String[] getReturnAttributes()
public LdapDataConnector.SEARCH_SCOPE getSearchScope()
public int getSearchTimeLimit()
public TemplateEngine getTemplateEngine()
public org.opensaml.xml.security.x509.X509Credential getTrustCredential()
public boolean getUseStartTLS()
public boolean isCacheResults()
public boolean isMergeResults()
public boolean isNoResultsIsError()
public void setAuthenticationType(LdapDataConnector.AUTHENTICATION_TYPE type)
type
- authentication type used when connecting to the directorypublic void setBaseDN(String dn)
dn
- the base search DNpublic void setCacheResults(boolean cache)
cache
- whether to cache query resultspublic void setConnectionCredential(org.opensaml.xml.security.x509.X509Credential credential)
credential
- client authentication material used when connecting to the LDAP via SSL or TLSpublic void setFilterTemplate(String template)
template
- LDAP query filter templatepublic void setLdapProperties(Map<String,String> properties)
properties
- LDAP connection provider specific propertiespublic void setLdapUrl(String url)
url
- LDAP server's URLpublic void setMaxResultSize(int max)
max
- maximum number of results to return from a querypublic void setMergeResults(boolean merge)
merge
- Twhether to merge multiple results into a single resultpublic void setNoResultsIsError(boolean isError)
isError
- whether a query that returns no results is an error conditionpublic void setPoolInitialSize(int initialSize)
initialSize
- initial number of connection to create in the connection poolpublic void setPoolMaxIdleSize(int maxIdle)
maxIdle
- maximum number of idle connection that will be kept in the connection poolpublic void setPrincipal(String principalName)
principalName
- principal DN used to bind to the directorypublic void setPrincipalCredential(String credential)
credential
- credential of the principal DN used to bind to the directorypublic void setReturnAttributes(String[] attributes)
attributes
- attributes to return from a querypublic void setSearchScope(LdapDataConnector.SEARCH_SCOPE scope)
scope
- search scope of a querypublic void setSearchTimeLimit(int timeLimit)
timeLimit
- maximum amount of time, in milliseconds, to wait for a search to completepublic void setTemplateEngine(TemplateEngine engine)
engine
- template engine used to construct query filterspublic void setTrustCredential(org.opensaml.xml.security.x509.X509Credential credential)
credential
- trust material used when connecting to the LDAP via SSL or TLSpublic void setUseStartTLS(boolean startTLS)
startTLS
- whether to use StartTLS when connecting to the LDAP
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |