View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector;
19  
20  import edu.vt.middleware.ldap.Ldap;
21  import edu.vt.middleware.ldap.pool.LdapFactory;
22  import edu.vt.middleware.ldap.pool.LdapPoolConfig;
23  
24  /**
25   * Used by the ldap data connector to interface with various pooling implementations. 
26   */
27  public interface LdapPoolStrategy {
28  
29      /**
30       * Sets the ldap factory.
31       *
32       * @param  factory  to create ldap objects with
33       */
34      void setLdapFactory(LdapFactory<Ldap> factory);
35  
36      /**
37       * Sets the ldap pool configuration.
38       *
39       * @param  config  to manage ldap pool with
40       */
41      void setLdapPoolConfig(LdapPoolConfig config);
42  
43      /**
44       * Sets whether to block when the pool is empty.
45       *
46       * @param  block  when the pool is empty
47       */
48      void setBlockWhenEmpty(boolean block);
49  
50      /**
51       * Prepare the pool for use.
52       */
53      void initialize();
54  
55      /**
56       * Retrieve an ldap object.
57       * 
58       * @return  ldap object
59       * @throws Exception
60       */
61      Ldap checkOut() throws Exception;
62  
63      /**
64       * Return an ldap object.
65       *
66       * @param l
67       */
68      void checkIn(Ldap l) throws Exception;
69  }