blob: efa1c271e3c8c734a15ded8098da283fd6b5399b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.ldap;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.base.ISubsystem;
/**
* Class on behalf of the Publishing system that controls an instance of an ILdapConnFactory.
* Allows a factory to be intialized and grants access
* to the factory to other interested parties.
*
* @version $Revision$, $Date$
*/
public interface ILdapConnModule {
/**
* Initialize ldap publishing module with config store.
*
* @param owner Entity that is interested in this instance of Publishing.
* @param config Config store containing the info needed to set up Publishing.
* @exception ELdapException Due to Ldap error.
* @exception EBaseException Due to config value errors and all other errors.
*/
public void init(ISubsystem owner, IConfigStore config)
throws EBaseException, ELdapException;
/**
* Returns the internal ldap connection factory.
* This can be useful to get a ldap connection to the
* ldap publishing directory without having to get it again from the
* config file. Note that this means sharing a ldap connection pool
* with the ldap publishing module so be sure to return connections to pool.
* Use ILdapConnFactory.getConn() to get a Ldap connection to the ldap
* publishing directory.
* Use ILdapConnFactory.returnConn() to return the connection.
*
* @return Instance of ILdapConnFactory.
*/
public ILdapConnFactory getLdapConnFactory();
}
|