forked from IQSS/dataverse
-
Notifications
You must be signed in to change notification settings - Fork 2
/
DOIEZIdServiceBean.java
293 lines (268 loc) · 12.2 KB
/
DOIEZIdServiceBean.java
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
package edu.harvard.iq.dataverse;
import edu.ucsb.nceas.ezid.EZIDException;
import edu.ucsb.nceas.ezid.EZIDService;
import edu.ucsb.nceas.ezid.EZIDServiceRequest;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ejb.Stateless;
/**
*
* @author skraffmiller
*/
@Stateless
public class DOIEZIdServiceBean extends DOIServiceBean {
EZIDService ezidService;
EZIDServiceRequest ezidServiceRequest;
String baseURLString = "https://ezid.cdlib.org";
private static final Logger logger = Logger.getLogger("edu.harvard.iq.dvn.core.index.DOIEZIdServiceBean");
// get username and password from system properties
private String USERNAME = "";
private String PASSWORD = "";
public DOIEZIdServiceBean() {
logger.log(Level.FINE,"Constructor");
try {
// Guessing these are System.getProperty rather than using settingsService
// because this is a constructor rather than a @PostConstruct method
baseURLString = System.getProperty("doi.baseurlstring");
logger.log(Level.FINE, "Using baseURLString {0}", baseURLString);
ezidService = new EZIDService(baseURLString);
USERNAME = System.getProperty("doi.username");
PASSWORD = System.getProperty("doi.password");
ezidService.login(USERNAME, PASSWORD);
configured = true;
} catch (EZIDException e) {
// As a stateless bean, this constructor runs even when we're not using ezid, so
// lowering the log level in that case
// (Future work is expected to change PidProviders from being stateless beans
// going forward and at that point we won't be initializing this unless it's
// configured.
Level level = (baseURLString.contains("ezid")) ? Level.WARNING : Level.FINE;
logger.log(level, "login failed ");
logger.log(level, "Exception String: {0}", e.toString());
logger.log(level, "localized message: {0}", e.getLocalizedMessage());
logger.log(level, "cause: ", e.getCause());
logger.log(level, "message {0}", e.getMessage());
} catch (Exception e) {
logger.log(Level.SEVERE, "Other Error on ezidService.login(USERNAME, PASSWORD) - not EZIDException ", e.getMessage());
}
}
@Override
public boolean registerWhenPublished() {
return false;
}
@Override
public boolean alreadyExists(DvObject dvObject) throws Exception {
if(dvObject==null) {
logger.severe("Null DvObject sent to alreadyExists().");
return false;
}
return alreadyExists(dvObject.getGlobalId());
}
@Override
public boolean alreadyExists(GlobalId pid) throws Exception {
logger.log(Level.FINE,"alreadyExists");
try {
HashMap<String, String> result = ezidService.getMetadata(pid.asString());
return result != null && !result.isEmpty();
// TODO just check for HTTP status code 200/404, sadly the status code is swept under the carpet
} catch (EZIDException e ){
//No such identifier is treated as an exception
//but if that is the case then we want to just return false
if(pid.getIdentifier() == null){
return false;
}
if (e.getLocalizedMessage().contains("no such identifier")){
return false;
}
logger.log(Level.WARNING, "alreadyExists failed");
logger.log(Level.WARNING, "getIdentifier(dvObject) {0}", pid.asString());
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
throw e;
}
}
@Override
public Map<String, String> getIdentifierMetadata(DvObject dvObject) {
logger.log(Level.FINE,"getIdentifierMetadata");
String identifier = getIdentifier(dvObject);
Map<String, String> metadata = new HashMap<>();
try {
metadata = ezidService.getMetadata(identifier);
} catch (EZIDException e) {
logger.log(Level.WARNING, "getIdentifierMetadata failed");
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
return metadata;
}
return metadata;
}
/**
* Modifies the EZID metadata for a Dataset
*
* @param dvObject the Dataset whose metadata needs to be modified
* @return the Dataset identifier, or null if the modification failed
* @throws java.lang.Exception
*/
@Override
public String modifyIdentifierTargetURL(DvObject dvObject) throws Exception {
String identifier = getIdentifier(dvObject);
HashMap<String, String> metadata = new HashMap<>();
metadata.put("_target", getTargetUrl(dvObject));
try {
ezidService.setMetadata(identifier,metadata);
return identifier;
} catch (EZIDException e) {
logger.log(Level.WARNING, "modifyMetadata failed");
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
throw e;
}
}
@Override
public void deleteIdentifier(DvObject dvObject) throws Exception {
logger.log(Level.FINE,"deleteIdentifier");
String identifier = getIdentifier(dvObject);
HashMap<String, String> doiMetadata;
try {
doiMetadata = ezidService.getMetadata(identifier);
} catch (EZIDException e) {
logger.log(Level.WARNING, "get matadata failed cannot delete");
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause ", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
return;
}
String idStatus = doiMetadata.get("_status");
if (idStatus.equals("reserved")) {
logger.log(Level.INFO, "Delete status is reserved..");
try {
ezidService.deleteIdentifier(identifier);
} catch (EZIDException e) {
logger.log(Level.WARNING, "delete failed");
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
}
return;
}
if (idStatus.equals("public")) {
//if public then it has been released set to unavaialble and reset target to n2t url
updateIdentifierStatus(dvObject, "unavailable | withdrawn by author");
Map<String, String> metadata = new HashMap<>();
metadata.put("_target", "http://ezid.cdlib.org/id/" + dvObject.getProtocol() + ":" + dvObject.getAuthority()
+ "/" + dvObject.getIdentifier());
try {
modifyIdentifierTargetURL(dvObject);
if (dvObject instanceof Dataset) {
Dataset dataset = (Dataset) dvObject;
for (DataFile df : dataset.getFiles()) {
metadata = new HashMap<>();
metadata.put("_target", "http://ezid.cdlib.org/id/" + df.getProtocol() + ":" + df.getAuthority()
+ "/" + df.getIdentifier());
modifyIdentifierTargetURL(df);
}
}
} catch (Exception e) {
// TODO already logged, how to react here?
}
}
}
@Override
public boolean publicizeIdentifier(DvObject dvObject) {
logger.log(Level.FINE,"publicizeIdentifier - dvObject");
if(!dvObject.isIdentifierRegistered()){
try {
createIdentifier(dvObject);
} catch (Throwable e){
return false;
}
}
return updateIdentifierStatus(dvObject, "public");
}
private boolean updateIdentifierStatus(DvObject dvObject, String statusIn) {
logger.log(Level.FINE, "updateIdentifierStatus");
String identifier = getIdentifier(dvObject);
Map<String, String> metadata = getUpdateMetadata(dvObject);
String objMetadata = getMetadataFromDvObject(identifier, metadata, dvObject);
Map<String, String> dcMetadata;
dcMetadata = new HashMap<>();
dcMetadata.put("datacite", objMetadata);
dcMetadata.put("_status", statusIn);
dcMetadata.put("_target", getTargetUrl(dvObject));
try {
// ezID API requires HashMap, not just any map.
ezidService.setMetadata(identifier, asHashMap(dcMetadata));
return true;
} catch (EZIDException e) {
logger.log(Level.WARNING, "modifyMetadata failed");
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
return false;
}
}
@Override
public List<String> getProviderInformation(){
ArrayList <String> providerInfo = new ArrayList<>();
String providerName = "EZID";
String providerLink = baseURLString;
providerInfo.add(providerName);
providerInfo.add(providerLink);
return providerInfo;
}
@Override
public String createIdentifier(DvObject dvObject) throws Throwable {
logger.log(Level.FINE, "createIdentifier");
if(dvObject.getIdentifier() == null || dvObject.getIdentifier().isEmpty() ){
dvObject = generateIdentifier(dvObject);
}
String identifier = getIdentifier(dvObject);
Map<String, String> metadata = getMetadataForCreateIndicator(dvObject);
String objMetadata = getMetadataFromDvObject(identifier, metadata, dvObject);
Map<String, String> dcMetadata;
dcMetadata = new HashMap<>();
dcMetadata.put("datacite", objMetadata);
dcMetadata.put("datacite.resourcetype", "Dataset");
dcMetadata.put("_status", "reserved");
try {
String retString = ezidService.createIdentifier(identifier, asHashMap(dcMetadata));
logger.log(Level.FINE, "create DOI identifier retString : {0}", retString);
return retString;
} catch (EZIDException e) {
logger.log(Level.WARNING, "Identifier not created: create failed");
logger.log(Level.WARNING, "String {0}", e.toString());
logger.log(Level.WARNING, "localized message {0}", e.getLocalizedMessage());
logger.log(Level.WARNING, "cause", e.getCause());
logger.log(Level.WARNING, "message {0}", e.getMessage());
logger.log(Level.WARNING, "identifier: ", identifier);
throw e;
}
}
/**
* Returns a HashMap with the same values as {@code map}. This can be either
* {@code map} itself, or a new instance with the same values.
*
* This is needed as some of the internal APIs here require HashMap, but we
* don't want the external APIs to use an implementation class.
* @param <T>
* @param map
* @return A HashMap with the same values as {@code map}
*/
private <T> HashMap<T,T> asHashMap(Map<T,T> map) {
return (map instanceof HashMap) ? (HashMap)map : new HashMap<>(map);
}
@Override
protected String getProviderKeyName() {
return "EZID";
}
}