uk.gov.gchq.gaffer.named.operation.AddNamedOperation Maven / Gradle / Ivy
/*
* Copyright 2016-2020 Crown Copyright
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package uk.gov.gchq.gaffer.named.operation;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.databind.JsonNode;
import org.apache.commons.lang3.StringUtils;
import uk.gov.gchq.gaffer.access.predicate.AccessPredicate;
import uk.gov.gchq.gaffer.commonutil.CommonConstants;
import uk.gov.gchq.gaffer.commonutil.Required;
import uk.gov.gchq.gaffer.exception.SerialisationException;
import uk.gov.gchq.gaffer.jsonserialisation.JSONSerialiser;
import uk.gov.gchq.gaffer.operation.Operation;
import uk.gov.gchq.gaffer.operation.OperationChain;
import uk.gov.gchq.gaffer.operation.OperationChainDAO;
import uk.gov.gchq.gaffer.operation.Operations;
import uk.gov.gchq.koryphe.Since;
import uk.gov.gchq.koryphe.Summary;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static java.util.Objects.isNull;
import static java.util.Objects.nonNull;
/**
* A {@code AddNamedOperation} is an {@link Operation} for creating a new {@link NamedOperation}
* and adding it to a Gaffer graph.
*/
@JsonPropertyOrder(value = {"class", "operationName", "description", "score", "operations"}, alphabetic = true)
@Since("1.0.0")
@Summary("Adds a new named operation")
public class AddNamedOperation implements Operation, Operations {
@Required
private String operations;
private String operationName;
private List labels;
private String description;
private List readAccessRoles = new ArrayList<>();
private List writeAccessRoles = new ArrayList<>();
private boolean overwriteFlag = false;
private Map parameters;
private Map options;
private Integer score;
private AccessPredicate readAccessPredicate;
private AccessPredicate writeAccessPredicate;
private static final String CHARSET_NAME = CommonConstants.UTF_8;
public boolean isOverwriteFlag() {
return overwriteFlag;
}
public void setOverwriteFlag(final boolean overwriteFlag) {
this.overwriteFlag = overwriteFlag;
}
@JsonIgnore
public void setOperationChain(final String operationChain) {
this.operations = operationChain;
}
@JsonSetter("operationChain")
public void setOperationChain(final JsonNode opChainNode) {
this.operations = opChainNode.toString();
}
@JsonIgnore
public String getOperationChainAsString() {
return operations;
}
@JsonGetter("operationChain")
public JsonNode getOperationChainAsJsonNode() {
try {
return JSONSerialiser.getJsonNodeFromString(operations);
} catch (final SerialisationException se) {
throw new IllegalArgumentException(se.getMessage());
}
}
@JsonIgnore
public void setOperationChain(final OperationChain operationChain) {
try {
if (operationChain instanceof OperationChainDAO) {
this.operations = new String(JSONSerialiser.serialise(operationChain), Charset.forName(CHARSET_NAME));
} else {
final OperationChainDAO dao = new OperationChainDAO(operationChain.getOperations());
this.operations = new String(JSONSerialiser.serialise(dao), Charset.forName(CHARSET_NAME));
}
} catch (final SerialisationException se) {
throw new IllegalArgumentException(se.getMessage());
}
}
public String getOperationName() {
return operationName;
}
public void setOperationName(final String operationName) {
this.operationName = operationName;
}
public List getLabels() {
return labels;
}
public void setLabels(final List labels) {
this.labels = labels;
}
public List getReadAccessRoles() {
return readAccessRoles;
}
public void setReadAccessRoles(final List readAccessRoles) {
this.readAccessRoles = readAccessRoles;
}
public List getWriteAccessRoles() {
return writeAccessRoles;
}
public void setWriteAccessRoles(final List writeAccessRoles) {
this.writeAccessRoles = writeAccessRoles;
}
public String getDescription() {
return description;
}
public void setDescription(final String description) {
this.description = description;
}
public void setParameters(final Map parameters) {
this.parameters = parameters;
}
public Map getParameters() {
return parameters;
}
@Override
public AddNamedOperation shallowClone() {
return new AddNamedOperation.Builder()
.operationChain(operations)
.name(operationName)
.labels(labels)
.description(description)
.readAccessRoles(readAccessRoles.toArray(new String[readAccessRoles.size()]))
.writeAccessRoles(writeAccessRoles.toArray(new String[writeAccessRoles.size()]))
.overwrite(overwriteFlag)
.parameters(parameters)
.options(options)
.score(score)
.readAccessPredicate(readAccessPredicate)
.writeAccessPredicate(writeAccessPredicate)
.build();
}
@Override
public Map getOptions() {
return options;
}
@Override
public void setOptions(final Map options) {
this.options = options;
}
public Integer getScore() {
return score;
}
public void setScore(final Integer score) {
this.score = score;
}
public AccessPredicate getWriteAccessPredicate() {
return writeAccessPredicate;
}
public void setWriteAccessPredicate(final AccessPredicate writeAccessPredicate) {
this.writeAccessPredicate = writeAccessPredicate;
}
public AccessPredicate getReadAccessPredicate() {
return readAccessPredicate;
}
public void setReadAccessPredicate(final AccessPredicate readAccessPredicate) {
this.readAccessPredicate = readAccessPredicate;
}
/**
* @return a list of the operations in the operation chain resolved using the default parameters.
*/
@Override
@JsonIgnore
public Collection getOperations() {
return getOperationsWithDefaultParams();
}
@Override
public void updateOperations(final Collection operations) {
// ignore - Named operations will be updated when run instead
}
private Collection getOperationsWithDefaultParams() {
String opStringWithDefaults = operations;
if (null != parameters) {
for (final Map.Entry parameterDetailPair : parameters.entrySet()) {
String paramKey = parameterDetailPair.getKey();
try {
opStringWithDefaults = opStringWithDefaults.replace(buildParamNameString(paramKey),
new String(JSONSerialiser.serialise(parameterDetailPair.getValue().getDefaultValue(), CHARSET_NAME), CHARSET_NAME));
} catch (final SerialisationException | UnsupportedEncodingException e) {
throw new IllegalArgumentException(e.getMessage());
}
}
}
OperationChain opChain;
if (StringUtils.isEmpty(opStringWithDefaults)) {
opChain = null;
} else {
try {
opChain = JSONSerialiser.deserialise(opStringWithDefaults.getBytes(CHARSET_NAME), OperationChainDAO.class);
} catch (final Exception e) {
opChain = null;
}
}
final List operations = new ArrayList<>();
if (nonNull(opChain) && nonNull(opChain.getOperations())) {
operations.addAll(opChain.getOperations());
}
return operations;
}
private String buildParamNameString(final String paramKey) {
return "\"${" + paramKey + "}\"";
}
public static class Builder extends BaseBuilder {
public Builder() {
super(new AddNamedOperation());
}
public Builder operationChain(final String opChainString) {
_getOp().setOperationChain(opChainString);
return _self();
}
public Builder operationChain(final OperationChain opChain) {
_getOp().setOperationChain(opChain);
return _self();
}
public Builder name(final String name) {
_getOp().setOperationName(name);
return _self();
}
public Builder labels(final List labels) {
_getOp().setLabels(labels);
return _self();
}
public Builder description(final String description) {
_getOp().setDescription(description);
return _self();
}
public Builder readAccessRoles(final String... roles) {
Collections.addAll(_getOp().getReadAccessRoles(), roles);
return _self();
}
public Builder writeAccessRoles(final String... roles) {
Collections.addAll(_getOp().getWriteAccessRoles(), roles);
return _self();
}
public Builder parameters(final Map parameters) {
_getOp().setParameters(parameters);
return _self();
}
public Builder parameter(final String name, final ParameterDetail detail) {
Map parameters = _getOp().getParameters();
if (isNull(parameters)) {
parameters = new HashMap<>();
_getOp().setParameters(parameters);
}
parameters.put(name, detail);
return _self();
}
public Builder overwrite(final boolean overwriteFlag) {
_getOp().setOverwriteFlag(overwriteFlag);
return _self();
}
public Builder overwrite() {
return overwrite(true);
}
public Builder score(final Integer score) {
_getOp().setScore(score);
return _self();
}
public Builder readAccessPredicate(final AccessPredicate readAccessPredicate) {
_getOp().setReadAccessPredicate(readAccessPredicate);
return _self();
}
public Builder writeAccessPredicate(final AccessPredicate writeAccessPredicate) {
_getOp().setWriteAccessPredicate(writeAccessPredicate);
return _self();
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy