edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector

Interface LdapPoolStrategy

All Known Implementing Classes:

LdapPoolEmptyStrategy, LdapPoolVTStrategy

public interface LdapPoolStrategy

Used by the ldap data connector to interface with various pooling implementations.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkIn(edu.vt.middleware.ldap.Ldap l) Return an ldap object.
edu.vt.middleware.ldap.Ldap	checkOut() Retrieve an ldap object.
void	initialize() Prepare the pool for use.
void	setBlockWhenEmpty(boolean block) Sets whether to block when the pool is empty.
void	setLdapFactory(edu.vt.middleware.ldap.pool.LdapFactory<edu.vt.middleware.ldap.Ldap> factory) Sets the ldap factory.
void	setLdapPoolConfig(edu.vt.middleware.ldap.pool.LdapPoolConfig config) Sets the ldap pool configuration.

Method Detail

setLdapFactory

void setLdapFactory(edu.vt.middleware.ldap.pool.LdapFactory<edu.vt.middleware.ldap.Ldap> factory)

Sets the ldap factory.

Parameters:

factory - to create ldap objects with

setLdapPoolConfig

void setLdapPoolConfig(edu.vt.middleware.ldap.pool.LdapPoolConfig config)

Sets the ldap pool configuration.

Parameters:

config - to manage ldap pool with

setBlockWhenEmpty

void setBlockWhenEmpty(boolean block)

Sets whether to block when the pool is empty.

Parameters:

block - when the pool is empty

initialize

void initialize()

Prepare the pool for use.

checkOut

edu.vt.middleware.ldap.Ldap checkOut()
                                     throws Exception

Retrieve an ldap object.

Returns:

ldap object

Throws:

Exception - thrown if there is a problem checking in an Ldap object

checkIn

void checkIn(edu.vt.middleware.ldap.Ldap l)
             throws Exception

Return an ldap object.

Parameters:

l - the ldap object

Throws:

Exception - thrown if there is a problem checking out an Ldap object