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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
// --- 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, 2014 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.cmscore.base;
import java.io.ByteArrayOutputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.util.Map;
import netscape.ldap.LDAPAttribute;
import netscape.ldap.LDAPAttributeSet;
import netscape.ldap.LDAPConnection;
import netscape.ldap.LDAPConstraints;
import netscape.ldap.LDAPControl;
import netscape.ldap.LDAPEntry;
import netscape.ldap.LDAPException;
import netscape.ldap.LDAPModification;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.ldap.ELdapException;
import com.netscape.certsrv.ldap.ILdapConnFactory;
import com.netscape.cmsutil.ldap.LDAPPostReadControl;
import com.netscape.cmsutil.ldap.LDAPUtil;
/**
* LDAPConfigStore:
* Extends PropConfigStore with methods to load/save from/to file for
* persistent storage. This is a configuration store agent who
* reads data from an LDAP entry.
* <P>
*
* @version $Revision$, $Date$
* @see PropConfigStore
*/
public class LDAPConfigStore extends PropConfigStore implements IConfigStore {
private ILdapConnFactory dbFactory;
private String dn;
private String attr;
private LDAPAttribute[] createAttrs;
/**
*
*/
private static final long serialVersionUID = 3642124526598175633L;
/**
* Constructs an LDAP configuration store.
* <P>
*
* @param dbFactory Database connection factory
* @param dn Distinguished name of record containing config store
* @param attr Name of attribute containing config store
* @param createAttrs Set of initial attributes if creating the entry. Should
* contain cn, objectclass and possibly other attributes.
*/
public LDAPConfigStore(
ILdapConnFactory dbFactory,
String dn, LDAPAttribute[] createAttrs, String attr
) {
super(null); // top-level store without a name
this.dbFactory = dbFactory;
this.dn = dn;
this.createAttrs = createAttrs;
this.attr = attr;
}
@Override
public void save(OutputStream out, String header) {
try (PrintWriter writer = new PrintWriter(out)) {
Map<String, String> map = getProperties();
for (String k : map.keySet()) {
writer.println(k + "=" + map.get(k));
}
}
}
/**
* Commit the configuration to the database.
*
* All uses of LDAPProfileStore at time of writing call with
* createBackup=false, so the argument is ignored.
*
* If backup becomes necessary, the constructor should be
* modified to take a String backupAttr, and the existing
* content be copied to that attribute.
*
* @param createBackup Ignored.
*/
public void commit(boolean createBackup) throws ELdapException {
String[] attrs = {};
commitReturn(createBackup, attrs);
}
/**
* This version of commit also returns the post-read entry that
* the change resulted in.
*/
public LDAPEntry commitReturn(boolean createBackup, String[] attrs)
throws ELdapException {
ByteArrayOutputStream data = new ByteArrayOutputStream();
save(data, null);
LDAPAttribute configAttr = new LDAPAttribute(attr, data.toByteArray());
LDAPConnection conn = dbFactory.getConn();
LDAPConstraints cons = new LDAPConstraints();
cons.setServerControls(new LDAPPostReadControl(true, attrs));
LDAPControl[] responseControls;
// first attempt to modify; if modification fails (due
// to no such object), try and add the entry instead.
try {
try {
commitModify(conn, configAttr, cons);
} catch (LDAPException e) {
if (e.getLDAPResultCode() == LDAPException.NO_SUCH_OBJECT) {
commitAdd(conn, configAttr, cons);
} else {
throw e;
}
}
responseControls = conn.getResponseControls();
} catch (LDAPException e) {
throw new ELdapException(
"Error writing LDAPConfigStore '"
+ dn + "': " + e.toString()
);
} finally {
dbFactory.returnConn(conn);
}
LDAPPostReadControl control = (LDAPPostReadControl)
LDAPUtil.getControl(LDAPPostReadControl.class, responseControls);
return control.getEntry();
}
/**
* Update the record via an LDAPModification.
*
* @param conn LDAP connection.
* @param configAttr Config store attribute.
* @return true on success, false if the entry does not exist.
*/
private void commitModify(
LDAPConnection conn,
LDAPAttribute configAttr,
LDAPConstraints cons)
throws LDAPException {
LDAPModification ldapMod =
new LDAPModification(LDAPModification.REPLACE, configAttr);
conn.modify(dn, ldapMod, cons);
}
/**
* Add the LDAPEntry via LDAPConnection.add.
*
* @param conn LDAP connection.
* @param configAttr Config store attribute.
* @return true on success, false if the entry already exists.
*/
private void commitAdd(
LDAPConnection conn,
LDAPAttribute configAttr,
LDAPConstraints cons)
throws LDAPException {
LDAPAttributeSet attrSet = new LDAPAttributeSet(createAttrs);
attrSet.add(configAttr);
LDAPEntry ldapEntry = new LDAPEntry(dn, attrSet);
conn.add(ldapEntry, cons);
}
}
|
