edu.internet2.middleware.grouper.app.loader.ldap
Class GrouperLoaderLdapServer

java.lang.Object
  edu.internet2.middleware.grouper.app.loader.ldap.GrouperLoaderLdapServer

public class GrouperLoaderLdapServer
extends Object

db profile from grouper.properties (or possibly grouper.hibernate.properties)

GrouperLoaderLdapServer

public GrouperLoaderLdapServer()

empty constructor

getBaseDn

public String getBaseDn()

get the base dn from the URL, e.g. ldaps://server/baseDn would return baseDn

Returns:

base dn or null if none

isTls

public boolean isTls()

optional, if you are using tls, set this to TRUE. Generally you will not be using an SSL URL to use TLS...

Returns:

if tls

setTls

public void setTls(boolean tls1)

optional, if you are using tls, set this to TRUE. Generally you will not be using an SSL URL to use TLS...

Parameters:

tls1 -

getConfigFileFromClasspath

public String getConfigFileFromClasspath()

load this vt-ldap config file before the configs here. load from classpath

Returns:

the configFileFromClasspath

setConfigFileFromClasspath

public void setConfigFileFromClasspath(String configFileFromClasspath1)

load this vt-ldap config file before the configs here. load from classpath

Parameters:

configFileFromClasspath1 - the configFileFromClasspath to set

getReferral

public String getReferral()

ldap.personLdap.referral: set to 'follow' if using AD and using paged results size

Returns:

the referral

setReferral

public void setReferral(String referral1)

ldap.personLdap.referral: set to 'follow' if using AD and using paged results size

Parameters:

referral1 - the referral to set

getPagedResultsSize

public int getPagedResultsSize()

if the ldap server has a max page size, then this will get the results in pages

Returns:

page size

setPagedResultsSize

public void setPagedResultsSize(int pagedResultsSize1)

if the ldap server has a max page size, then this will get the results in pages

Parameters:

pagedResultsSize1 -

setSearchResultHandlers

public void setSearchResultHandlers(String handlerNames)

comma-separated list of classes to handle search results

Parameters:

handlerNames -

getSearchResultHandlers

public edu.vt.middleware.ldap.handler.SearchResultHandler[] getSearchResultHandlers()

getSaslAuthorizationId

public String getSaslAuthorizationId()

if using sasl, this is authz id

Returns:

authz id

setSaslAuthorizationId

public void setSaslAuthorizationId(String saslAuthorizationId1)

if using sasl, this is authz id

Parameters:

saslAuthorizationId1 -

getSaslRealm

public String getSaslRealm()

if using sasl, this is the realm

Returns:

sasl realm

setSaslRealm

public void setSaslRealm(String saslRealm1)

if using sasl, this is the realm

Parameters:

saslRealm1 -

getBatchSize

public int getBatchSize()

batch size for results

Returns:

batch size for results

setBatchSize

public void setBatchSize(int batchSize1)

batch size for results

Parameters:

batchSize1 -

getCountLimit

public int getCountLimit()

count limit for results

Returns:

count limit for results

setCountLimit

public void setCountLimit(int countLimit1)

count limit for results

Parameters:

countLimit1 -

getTimeLimit

public int getTimeLimit()

time limit is for of search operation

Returns:

time limit is for of search operation

setTimeLimit

public void setTimeLimit(int timeLimit1)

time limit is for of search operation

Parameters:

timeLimit1 -

getTimeout

public int getTimeout()

timeout is for connection timeouts

Returns:

timeout is for connection timeouts

setTimeout

public void setTimeout(int timeout1)

timeout is for connection timeouts

Parameters:

timeout1 -

getMinPoolSize

public int getMinPoolSize()

minimum pool size

Returns:

minimum pool size

setMinPoolSize

public void setMinPoolSize(int minPoolSize1)

minimum pool size

Parameters:

minPoolSize1 -

getMaxPoolSize

public int getMaxPoolSize()

maximum pool size

Returns:

maximum pool size

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize1)

maximum pool size

Parameters:

maxPoolSize1 -

isValidateOnCheckIn

public boolean isValidateOnCheckIn()

if should validate on check in to pool

Returns:

if should validate on check in to pool

setValidateOnCheckIn

public void setValidateOnCheckIn(boolean validateOnCheckIn1)

if should validate on check in to pool

Parameters:

validateOnCheckIn1 -

isValidateOnCheckOut

public boolean isValidateOnCheckOut()

if should validate on check out of pool (default true if all other validate methods are false)

Returns:

if should validate on check out of pool (default true if all other validate methods are false)

setValidateOnCheckOut

public void setValidateOnCheckOut(boolean validateOnCheckOut1)

if should validate on check out of pool (default true if all other validate methods are false)

Parameters:

validateOnCheckOut1 -

isValidatePeriodically

public boolean isValidatePeriodically()

if should validate periodically while in pool

Returns:

if should validate periodically while in pool

setValidatePeriodically

public void setValidatePeriodically(boolean validatePeriodically1)

if should validate periodically while in pool

Parameters:

validatePeriodically1 -

getValidateTimerPeriod

public int getValidateTimerPeriod()

if validating periodically, this is the period in millis

Returns:

if validating periodically, this is the period in millis

setValidateTimerPeriod

public void setValidateTimerPeriod(int validateTimerPeriod1)

if validating periodically, this is the period in millis

Parameters:

validateTimerPeriod1 -

setValidator

public void setValidator(edu.vt.middleware.ldap.pool.LdapValidator<edu.vt.middleware.ldap.Ldap> validator)

if validating, the LDAPFactory validator

Parameters:

validator -

getValidator

public edu.vt.middleware.ldap.pool.LdapValidator<edu.vt.middleware.ldap.Ldap> getValidator()

if validating, the LDAPFactory validator

Returns:

the LDAPFactory validator

getPruneTimerPeriod

public int getPruneTimerPeriod()

period for which prune timer will run, in millis

Returns:

period for which prune timer will run, in millis

setPruneTimerPeriod

public void setPruneTimerPeriod(int pruneTimerPeriod1)

period for which prune timer will run, in millis

Parameters:

pruneTimerPeriod1 -

getExpirationTime

public int getExpirationTime()

if connections expire after a certain amount of time, this is it, in millis, defaults to 300000 (5 minutes)

Returns:

if connections expire after a certain amount of time, this is it, in millis, defaults to 300000 (5 minutes)

setExpirationTime

public void setExpirationTime(int expirationTime1)

if connections expire after a certain amount of time, this is it, in millis, defaults to 300000 (5 minutes)

Parameters:

expirationTime1 -

toString

public String toString()

note, this is generated by eclipse, with the exception of password

Overrides:

toString in class Object

See Also:

Object.toString()

getUser

public String getUser()

user to login to ldap e.g. uid=someapp,ou=people,dc=myschool,dc=edu

Returns:

the user

setUser

public void setUser(String user1)

user to login to ldap e.g. uid=someapp,ou=people,dc=myschool,dc=edu

Parameters:

user1 - the user to set

getPass

public String getPass()

pass to login to db

Returns:

the pass

setPass

public void setPass(String pass1)

pass to login to db

Parameters:

pass1 - the pass to set

getUrl

public String getUrl()

note the URL should start with ldap: or ldaps: if it is SSL. It should contain the server and port (optional if not default), and baseDn, e.g. ldaps://ldapserver.school.edu:636/dc=school,dc=edu

Returns:

the url

setUrl

public void setUrl(String url1)

note the URL should start with ldap: or ldaps: if it is SSL. It should contain the server and port (optional if not default), and baseDn, e.g. ldaps://ldapserver.school.edu:636/dc=school,dc=edu

Parameters:

url1 - the url to set

getDriver

public String getDriver()

db driver to use to login

Returns:

the driver

setDriver

public void setDriver(String driver1)

db driver to use to login

Parameters:

driver1 - the driver to set