summaryrefslogtreecommitdiff
path: root/src/connectors/src/data/io/ldap/LDAPConnectionWrapper.java
blob: 3f6497b93077531c89d98b879454f9bdaed71a12 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 * SSSync, a Simple and Stupid Synchronizer for data with multi-valued attributes
 * Copyright (C) 2014  Ludovic Pouzenc <ludovic@pouzenc.fr>
 *  
 * This file is part of SSSync.
 *
 *  SSSync 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, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  SSSync 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 SSSync.  If not, see <http://www.gnu.org/licenses/>
 */

package data.io.ldap;

import java.io.Closeable;
import java.io.IOException;

import com.unboundid.ldap.sdk.BindResult;
import com.unboundid.ldap.sdk.LDAPConnection;
import com.unboundid.ldap.sdk.LDAPConnectionOptions;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;

/**
 * TODO javadoc
 * 
 * @author lpouzenc
 */
public class LDAPConnectionWrapper  implements Closeable {
	
	private final LDAPConnection conn;
	
	/**
	 * TODO javadoc
	 * @param host
	 * @param port
	 * @param bindDN
	 * @param password
	 */
	public LDAPConnectionWrapper(String host, int port, String bindDN, String password) {
		LDAPConnectionOptions options = new LDAPConnectionOptions();
		options.setAbandonOnTimeout(true);
		options.setAllowConcurrentSocketFactoryUse(true);
		options.setAutoReconnect(true);
		options.setCaptureConnectStackTrace(true);
		options.setConnectTimeoutMillis(2000); // 2 seconds
		options.setResponseTimeoutMillis(5000); // 5 seconds
		options.setUseSynchronousMode(false);
		
		BindResult bindResult=null;
		try {
			conn = new LDAPConnection(options, host, port);
			bindResult = conn.bind(bindDN, password);
		}
		catch (LDAPException e) {
			throw new RuntimeException(e);
		}
		
		ResultCode resultCode = bindResult.getResultCode();
		if ( resultCode != ResultCode.SUCCESS ) {
			throw new RuntimeException("LDAP Bind failed : " + resultCode);
		}
	}
	
	/**
	 * Builds a new reader against current connection and a LDAP baseDN.
	 * 
	 * @param dataSourceName Short name of this data source (for logging)
	 * @param baseDN Search base DN (will return childs of this DN)
	 * @param keyAttr Attribute name that is the primary key of the entry, identifying the entry in a unique manner
	 * @param lookAheadAmount Grab this amount of entries at once (in memory-sorted, 128 could be great)
	 * @return A new reader ready to iterate on search results
	 */
	public LDAPFlatDataReader newFlatReader(String dataSourceName, String baseDN, String keyAttr, int lookAheadAmount) {
		try {
			return new LDAPFlatDataReader(dataSourceName, conn, baseDN, keyAttr, lookAheadAmount);
		} catch (LDAPException e) {
			throw new RuntimeException(e);
		}
	}

	/**
	 * Builds a new writer that could insert/update/delete entries on a particular LDAP connection and baseDN.
	 * 
	 * @param baseDN Search base DN (will return childs of this DN)
	 * @param keyAttr Attribute name that is the primary key of the entry, identifying the entry in a unique manner
	 * @return A new writter limited on a particular baseDN
	 */
	public LDAPFlatDataWriter newFlatWriter(String baseDN, String keyAttr) {
		try {
			return new LDAPFlatDataWriter(conn, baseDN, keyAttr);
		} catch (LDAPException e) {
			throw new RuntimeException(e);
		}
	}

	/**
	 * Close the current ldap connection.
	 */
	@Override
	public void close() throws IOException {
		this.conn.close();
	}
}