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

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

public class GrouperLoaderLdapServer
extends java.lang.Object

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

Constructor Summary

GrouperLoaderLdapServer()
empty constructor

Method Summary

java.lang.String	getBaseDn() get the base dn from the URL, e.g. ldaps://server/baseDn would return baseDn
int	getBatchSize() batch size for results
java.lang.String	getConfigFileFromClasspath() load this vt-ldap config file before the configs here.
int	getCountLimit() count limit for results
java.lang.String	getDriver() db driver to use to login
int	getExpirationTime() if connections expire after a certain amount of time, this is it, in millis, defaults to 300000 (5 minutes)
int	getMaxPoolSize() maximum pool size
int	getMinPoolSize() minimum pool size
int	getPagedResultsSize() if the ldap server has a max page size, then this will get the results in pages
java.lang.String	getPass() pass to login to db
int	getPruneTimerPeriod() period for which prune timer will run, in millis
java.lang.String	getReferral() ldap.personLdap.referral: set to 'follow' if using AD and using paged results size
java.lang.String	getSaslAuthorizationId() if using sasl, this is authz id
java.lang.String	getSaslRealm() if using sasl, this is the realm
int	getTimeLimit() time limit is for of search operation
int	getTimeout() timeout is for connection timeouts
java.lang.String	getUrl() note the URL should start with ldap: or ldaps: if it is SSL.
java.lang.String	getUser() user to login to ldap e.g. uid=someapp,ou=people,dc=myschool,dc=edu
int	getValidateTimerPeriod() if validating periodically, this is the period in millis
boolean	isTls() optional, if you are using tls, set this to TRUE.
boolean	isValidateOnCheckIn() if should validate on check in to pool
boolean	isValidateOnCheckOut() if should validate on check out of pool (default true if all other validate methods are false)
boolean	isValidatePeriodically() if should validate periodically while in pool
void	setBatchSize(int batchSize1) batch size for results
void	setConfigFileFromClasspath(java.lang.String configFileFromClasspath1) load this vt-ldap config file before the configs here.
void	setCountLimit(int countLimit1) count limit for results
void	setDriver(java.lang.String driver1) db driver to use to login
void	setExpirationTime(int expirationTime1) if connections expire after a certain amount of time, this is it, in millis, defaults to 300000 (5 minutes)
void	setMaxPoolSize(int maxPoolSize1) maximum pool size
void	setMinPoolSize(int minPoolSize1) minimum pool size
void	setPagedResultsSize(int pagedResultsSize1) if the ldap server has a max page size, then this will get the results in pages
void	setPass(java.lang.String pass1) pass to login to db
void	setPruneTimerPeriod(int pruneTimerPeriod1) period for which prune timer will run, in millis
void	setReferral(java.lang.String referral1) ldap.personLdap.referral: set to 'follow' if using AD and using paged results size
void	setSaslAuthorizationId(java.lang.String saslAuthorizationId1) if using sasl, this is authz id
void	setSaslRealm(java.lang.String saslRealm1) if using sasl, this is the realm
void	setTimeLimit(int timeLimit1) time limit is for of search operation
void	setTimeout(int timeout1) timeout is for connection timeouts
void	setTls(boolean tls1) optional, if you are using tls, set this to TRUE.
void	setUrl(java.lang.String url1) note the URL should start with ldap: or ldaps: if it is SSL.
void	setUser(java.lang.String user1) user to login to ldap e.g. uid=someapp,ou=people,dc=myschool,dc=edu
void	setValidateOnCheckIn(boolean validateOnCheckIn1) if should validate on check in to pool
void	setValidateOnCheckOut(boolean validateOnCheckOut1) if should validate on check out of pool (default true if all other validate methods are false)
void	setValidatePeriodically(boolean validatePeriodically1) if should validate periodically while in pool
void	setValidateTimerPeriod(int validateTimerPeriod1) if validating periodically, this is the period in millis
java.lang.String	toString() note, this is generated by eclipse, with the exception of password

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GrouperLoaderLdapServer

public GrouperLoaderLdapServer()

empty constructor

Method Detail

getBaseDn

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

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

Returns:

the configFileFromClasspath

setConfigFileFromClasspath

public void setConfigFileFromClasspath(java.lang.String configFileFromClasspath1)

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

Parameters:

configFileFromClasspath1 - the configFileFromClasspath to set

getReferral

public java.lang.String getReferral()

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

Returns:

the referral

setReferral

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

getSaslAuthorizationId

public java.lang.String getSaslAuthorizationId()

if using sasl, this is authz id

Returns:

authz id

setSaslAuthorizationId

public void setSaslAuthorizationId(java.lang.String saslAuthorizationId1)

if using sasl, this is authz id

Parameters:

saslAuthorizationId1 -

getSaslRealm

public java.lang.String getSaslRealm()

if using sasl, this is the realm

Returns:

sasl realm

setSaslRealm

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

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

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

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getUser

public java.lang.String getUser()

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

Returns:

the user

setUser

public void setUser(java.lang.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 java.lang.String getPass()

pass to login to db

Returns:

the pass

setPass

public void setPass(java.lang.String pass1)

pass to login to db

Parameters:

pass1 - the pass to set

getUrl

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

db driver to use to login

Returns:

the driver

setDriver

public void setDriver(java.lang.String driver1)

db driver to use to login

Parameters:

driver1 - the driver to set