org.lockss.ws.control.AuControlServiceImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of laaws-soap-service Show documentation
Show all versions of laaws-soap-service Show documentation
LOCKSS SOAP Compatibility Service
/*
Copyright (c) 2015-2020 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.
*/
package org.lockss.ws.control;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.lockss.log.L4JLogger;
import org.lockss.util.rest.RestUtil;
import org.lockss.util.rest.config.RestConfigClient;
import org.lockss.util.rest.exception.LockssRestHttpException;
import org.lockss.util.rest.mdx.MetadataUpdateSpec;
import org.lockss.util.rest.poller.PollDesc;
import org.lockss.util.rest.poller.RestPollerClient;
import org.lockss.ws.BaseServiceImpl;
import org.lockss.ws.entities.CheckSubstanceResult;
import org.lockss.ws.entities.LockssWebServicesFault;
import org.lockss.ws.entities.RequestCrawlResult;
import org.lockss.ws.entities.RequestDeepCrawlResult;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.lockss.ws.entities.RequestAuControlResult;
/**
* The AU Control SOAP web service implementation.
*/
@Service
public class AuControlServiceImpl extends BaseServiceImpl
implements AuControlService {
static final String MISSING_AU_ID_ERROR_MESSAGE = "Missing auId";
static final String NO_SUBSTANCE_ERROR_MESSAGE =
"No substance patterns defined for plugin";
static final String NO_SUCH_AU_ERROR_MESSAGE = "No such Archival Unit";
static final String UNEXPECTED_SUBSTANCE_CHECKER_ERROR_MESSAGE =
"Error in SubstanceChecker; see log";
static final String USE_FORCE_MESSAGE =
"Use the 'force' parameter to override.";
static final String DISABLED_METADATA_PROCESSING_ERROR_MESSAGE =
"Metadata processing is not enabled";
static final String DISABLE_METADATA_INDEXING_ERROR_MESSAGE =
"Cannot disable AU metadata indexing";
static final String ACTION_ENABLE_METADATA_INDEXING = "Enable Indexing";
static final String ENABLE_METADATA_INDEXING_ERROR_MESSAGE =
"Cannot enable AU metadata indexing";
private final static L4JLogger log = L4JLogger.getLogger();
/**
* Provides an indication of whether an Archival Unit has substance.
*
* @param auId A String with the identifier (auid) of the archival unit.
* @return a CheckSubstanceResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
public CheckSubstanceResult checkSubstanceById(String auId)
throws LockssWebServicesFault {
log.debug2("auId = {}", auId);
try {
// Make the REST call to disable metadata indexing for the Archival Unit.
CheckSubstanceResult response = new RestConfigClient(
env.getProperty(CONFIG_SVC_URL_KEY),
getSoapRequestAuthorizationHeader()).putAuSubstanceCheck(auId);
log.debug2("response = {}", response);
return response;
} catch (Exception e) {
throw new LockssWebServicesFault(e);
}
}
/**
* Provides an indication of whether the archival units defined by a list with
* their identifiers have substance.
*
* @param auIds A {@code List} with the identifiers (auids) of the
* archival units.
* @return a {@code List} with the results of the
* operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List checkSubstanceByIdList(List auIds)
throws LockssWebServicesFault {
log.debug2("auIds = {}", auIds);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
results.add(checkSubstanceById(auId));
}
log.debug2("results = {}", results);
return results;
}
/**
* Requests the crawl of an archival unit.
*
* @param auId A String with the identifier (auid) of the archival unit.
* @param priority An Integer with the priority of the crawl request.
* @param force A boolean with true if the request is to be
* made even in the presence of some anomalies,
* false otherwise.
* @return a RequestCrawlResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public RequestCrawlResult requestCrawlById(String auId, Integer priority,
boolean force) throws LockssWebServicesFault {
log.debug2("auId = {}, priority = {}, force = {}", auId, priority, force);
try {
// TODO: REPLACE THIS BLOCK WITH THE ACTUAL IMPLEMENTATION.
RequestCrawlResult result =
new RequestCrawlResult(auId, true, "No delay", "It worked!");
// TODO: END OF BLOCK TO BE REPLACED.
log.debug2("result = {}", result);
return result;
} catch (Exception e) {
throw new LockssWebServicesFault(e);
}
}
/**
* Requests the crawl of the archival units defined by a list with their
* identifiers.
*
* @param auIds A {@code List} with the identifiers (auids) of the
* archival units.
* @param priority An Integer with the priority of the crawl request.
* @param force A boolean with true if the request is to be
* made even in the presence of some anomalies,
* false otherwise.
* @return a {@code List} with the results of the
* operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List requestCrawlByIdList(List auIds,
Integer priority, boolean force) throws LockssWebServicesFault {
log.debug2("auIds = {}, priority = {}, force = {}", auIds, priority, force);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
// Perform the request.
results.add(requestCrawlById(auId, priority, force));
}
log.debug2("results = {}", results);
return results;
}
/**
* Requests the deep crawl of an archival unit.
*
* @param auId A String with the identifier (auid) of the archival
* unit.
* @param refetchDepth An int with the depth of the crawl request.
* @param priority An Integer with the priority of the crawl request.
* @param force A boolean with true if the request is to
* be made even in the presence of some anomalies,
* false otherwise.
* @return a RequestDeepCrawlResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public RequestDeepCrawlResult requestDeepCrawlById(String auId,
int refetchDepth, Integer priority, boolean force)
throws LockssWebServicesFault {
log.debug2("auId = {}, refetchDepth = {}, priority = {}, force = {}", auId,
refetchDepth, priority, force);
try {
// TODO: REPLACE THIS BLOCK WITH THE ACTUAL IMPLEMENTATION.
RequestDeepCrawlResult result =
new RequestDeepCrawlResult(auId, 1, true, "No delay", "It worked!");
// TODO: END OF BLOCK TO BE REPLACED.
log.debug2("result = {}", result);
return result;
} catch (Exception e) {
throw new LockssWebServicesFault(e);
}
}
/**
* Requests the deep crawl of the archival units defined by a list with their
* identifiers.
*
* @param auIds A {@code List} with the identifiers (auids) of
* the archival units.
* @param refetchDepth An int with the depth of the crawl request.
* @param priority An Integer with the priority of the crawl request.
* @param force A boolean with true if the request is to
* be made even in the presence of some anomalies,
* false otherwise.
* @return a {@code List} with the results of the
* operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List requestDeepCrawlByIdList(
List auIds, int refetchDepth, Integer priority, boolean force)
throws LockssWebServicesFault {
log.debug2("auIds = {}, refetchDepth = {}, priority = {}, force = {}",
auIds, refetchDepth, priority, force);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
// Perform the request.
results.add(requestDeepCrawlById(auId, refetchDepth, priority, force));
}
log.debug2("results = {}", results);
return results;
}
/**
* Requests the polling of an archival unit.
*
* @param auId A String with the identifier (auid) of the archival unit.
* @return a RequestPollResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public RequestAuControlResult requestPollById(String auId)
throws LockssWebServicesFault {
log.debug2("auId = {}", auId);
RequestAuControlResult result = null;
// Handle a missing auId.
// TODO: Replace with StringUtil method once StringUtil has been
// moved from the lockss-core project to the lockss-util project.
if (isNullString(auId)) {
result =
new RequestAuControlResult(auId, false, MISSING_AU_ID_ERROR_MESSAGE);
log.debug2("result = {}", result);
return result;
}
String message = null;
try {
// The description of the poll to be called.
PollDesc pollDescription = new PollDesc();
pollDescription.setAuId(auId);
log.trace("pollDescription = {}", pollDescription);
// Make the REST call to request the poll.
String response =
new RestPollerClient(env.getProperty(POLLER_SVC_URL_KEY),
getSoapRequestAuthorizationHeader()).callPoll(pollDescription);
log.trace("response = {}", response);
result = new RequestAuControlResult(response, true, null);
} catch (LockssRestHttpException lrhe) {
message = lrhe.getMessage();
log.trace("message = {}", message);
// Handle a missing Archival Unit.
if (lrhe.getHttpStatus().equals(HttpStatus.NOT_FOUND)) {
message = NO_SUCH_AU_ERROR_MESSAGE;
} else if (lrhe.getCause() != null) {
message = lrhe.getCause().getMessage();
}
result = new RequestAuControlResult(auId, false, message);
} catch (Exception e) {
if (e.getCause() != null) {
message = e.getCause().getMessage();
} else {
message = e.getMessage();
}
result = new RequestAuControlResult(auId, false, message);
}
log.debug2("result = {}", result);
return result;
}
/**
* Requests the polling of the archival units defined by a list with their
* identifiers.
*
* @param auIds A {@code List} with the identifiers (auids) of the
* archival units.
* @return a {@code List} with the results of the
* operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List requestPollByIdList(List auIds)
throws LockssWebServicesFault {
log.debug2("auIds = {}", auIds);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
// Perform the request.
results.add(requestPollById(auId));
}
log.debug2("results = {}", results);
return results;
}
/**
* Requests the metadata indexing of an archival unit.
*
* @param auId A String with the identifier (auid) of the archival unit.
* @param force A boolean with true if the request is to be made
* even in the presence of some anomalies, false
* otherwise.
* @return a RequestAuControlResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public RequestAuControlResult requestMdIndexingById(String auId,
boolean force) throws LockssWebServicesFault {
log.debug2("auId = {}, force = {}", auId, force);
RequestAuControlResult result = null;
try {
// Prepare the query parameters.
Map queryParams = new HashMap<>(1);
queryParams.put("force", String.valueOf(force));
log.trace("queryParams = {}", queryParams);
// Prepare the request body.
MetadataUpdateSpec metadataUpdateSpec = new MetadataUpdateSpec();
metadataUpdateSpec.setAuid(auId);
metadataUpdateSpec.setUpdateType("full_extraction");
// Make the REST call.
ResponseEntity response = callRestServiceEndpoint(
env.getProperty(MDX_SVC_URL_KEY), "/mdupdates", null, queryParams,
HttpMethod.POST, metadataUpdateSpec,
"Can't request metadata indexing");
HttpStatus statusCode = response.getStatusCode();
log.trace("statusCode = {}", statusCode);
if (RestUtil.isSuccess(statusCode)) {
result = new RequestAuControlResult(auId, true, null);
} else {
result = new RequestAuControlResult(auId, false, statusCode.toString());
}
log.debug2("result = {}", result);
return result;
} catch (Exception e) {
throw new LockssWebServicesFault(e);
}
}
/**
* Requests the metadata indexing of the archival units defined by a list with
* their identifiers.
*
* @param auIds A List with the identifiers (auids) of the archival
* units.
* @param force A boolean with true if the request is to be made
* even in the presence of some anomalies, false
* otherwise.
* @return a List with the results of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List requestMdIndexingByIdList(
List auIds, boolean force) throws LockssWebServicesFault {
log.debug2("auIds = {}, force = {}", auIds, force);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
// Perform the request.
results.add(requestMdIndexingById(auId, force));
}
log.debug2("results = {}", results);
return results;
}
/**
* Disables the metadata indexing of an archival unit.
*
* @param auId A String with the identifier (auid) of the archival unit.
* @return a RequestAuControlResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public RequestAuControlResult disableMdIndexingById(String auId)
throws LockssWebServicesFault {
log.debug2("auId = {}", auId);
try {
// Make the REST call to disable metadata indexing for the Archival Unit.
String response = new RestConfigClient(
env.getProperty(CONFIG_SVC_URL_KEY),
getSoapRequestAuthorizationHeader())
.patchArchivalUnitState(auId,
"{\"isMetadataExtractionEnabled\":false}", null);
log.debug2("response = {}", response);
RequestAuControlResult result =
new RequestAuControlResult(auId, true, null);
log.debug2("result = {}", result);
return result;
} catch (Exception e) {
throw new LockssWebServicesFault(e);
}
}
/**
* Disables the metadata indexing of the archival units defined by a list with
* their identifiers.
*
* @param auIds A List with the identifiers (auids) of the archival
* units.
* @return a List with the results of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List disableMdIndexingByIdList(
List auIds) throws LockssWebServicesFault {
log.debug2("auIds = {}", auIds);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
// Perform the request.
results.add(disableMdIndexingById(auId));
}
log.debug2("results = {}", results);
return results;
}
/**
* Enables the metadata indexing of an archival unit.
*
* @param auId A String with the identifier (auid) of the archival unit.
* @return a RequestAuControlResult with the result of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public RequestAuControlResult enableMdIndexingById(String auId)
throws LockssWebServicesFault {
log.debug2("auId = {}", auId);
try {
// Make the REST call to disable metadata indexing for the Archival Unit.
String response = new RestConfigClient(
env.getProperty(CONFIG_SVC_URL_KEY),
getSoapRequestAuthorizationHeader())
.patchArchivalUnitState(auId,
"{\"isMetadataExtractionEnabled\":true}", null);
log.debug2("response = {}", response);
RequestAuControlResult result =
new RequestAuControlResult(auId, true, null);
log.debug2("result = {}", result);
return result;
} catch (Exception e) {
throw new LockssWebServicesFault(e);
}
}
/**
* Enables the metadata indexing of the archival units defined by a list with
* their identifiers.
*
* @param auIds A List with the identifiers (auids) of the archival
* units.
* @return a List with the results of the operation.
* @throws LockssWebServicesFault if there are problems.
*/
@Override
public List enableMdIndexingByIdList(
List auIds) throws LockssWebServicesFault {
log.debug2("auIds = {}", auIds);
List results =
new ArrayList(auIds.size());
// Loop through all the Archival Unit identifiers.
for (String auId : auIds) {
// Perform the request.
results.add(enableMdIndexingById(auId));
}
log.debug2("results = {}", results);
return results;
}
}