net.pincette.jes.util.Command Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pincette-jes-util Show documentation
Show all versions of pincette-jes-util Show documentation
Utilities to work with pincette-jes
package net.pincette.jes.util;
import static java.util.stream.Collectors.toSet;
import static java.util.stream.Stream.concat;
import static java.util.stream.Stream.of;
import static javax.json.Json.createObjectBuilder;
import static net.pincette.jes.util.Commands.PATCH;
import static net.pincette.jes.util.JsonFields.ACL;
import static net.pincette.jes.util.JsonFields.ACL_WRITE;
import static net.pincette.jes.util.JsonFields.COMMAND;
import static net.pincette.jes.util.JsonFields.CORR;
import static net.pincette.jes.util.JsonFields.ERROR;
import static net.pincette.jes.util.JsonFields.ID;
import static net.pincette.jes.util.JsonFields.JWT;
import static net.pincette.jes.util.JsonFields.OPS;
import static net.pincette.jes.util.JsonFields.TYPE;
import static net.pincette.jes.util.Util.getUsername;
import static net.pincette.json.JsonUtil.getArray;
import static net.pincette.json.JsonUtil.getBoolean;
import static net.pincette.util.Builder.create;
import static net.pincette.util.Collections.intersection;
import static net.pincette.util.Or.tryWith;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Stream;
import javax.json.JsonArray;
import javax.json.JsonObject;
import javax.json.JsonObjectBuilder;
import javax.json.JsonString;
import net.pincette.json.JsonUtil;
/**
* Some command utilities.
*
* @author Werner Donn\u00e9
* @since 1.0
*/
public class Command {
private Command() {}
/**
* Creates a command without data.
*
* @param type the aggregate type.
* @param id the ID of the aggregate instance.
* @param name the name of the command.
* @return The JSON representation of the command.
* @since 1.0
*/
public static JsonObject createCommand(final String type, final String id, final String name) {
return createCommandBuilder(type, id, name).build();
}
/**
* Creates a command builder without data. You can then add more fields to it.
*
* @param type the aggregate type.
* @param id the ID of the aggregate instance.
* @param name the name of the command.
* @return The JSON builder.
* @since 1.0
*/
public static JsonObjectBuilder createCommandBuilder(
final String type, final String id, final String name) {
return createObjectBuilder().add(TYPE, type).add(ID, id.toLowerCase()).add(COMMAND, name);
}
/**
* Creates a command which takes over the fields _type, _id and
* _jwt from json.
*
* @param json the aggregate or event.
* @param name the name of the command.
* @return The new command.
* @since 1.0
*/
public static JsonObject createCommandFor(final JsonObject json, final String name) {
return createCommandBuilderFor(json, name).build();
}
/**
* Creates a command builder which takes over the fields _type, _id and
*
* _jwt from json.
*
* @param json the aggregate or event.
* @param name the name of the command.
* @return The new command.
* @since 1.0
*/
public static JsonObjectBuilder createCommandBuilderFor(
final JsonObject json, final String name) {
return create(() -> createCommandBuilder(json.getString(TYPE), json.getString(ID), name))
.updateIf(
builder -> json.containsKey(JWT), builder -> builder.add(JWT, json.getJsonObject(JWT)))
.build();
}
private static Optional getAllowedRoles(
final JsonObject state, final JsonObject command) {
return tryWith(() -> getArray(state, "/" + ACL + "/" + command.getString(COMMAND)).orElse(null))
.or(() -> getArray(state, "/" + ACL + "/" + ACL_WRITE).orElse(null))
.get();
}
/**
* Checks if json is marked with an error, which means the field _error
* is set to true.
*
* @param json the given object, usually a command.
* @return The check report.
* @see JsonFields
* @since 1.0
*/
public static boolean hasError(final JsonObject json) {
return json != null && json.getBoolean(ERROR, false);
}
/**
* Checks whether or not the given command is allowed for the given aggregate, based on the _acl
* field in the aggregate.
*
* @param currentState the given aggregate.
* @param command the given command.
* @param breakingTheGlass when set this overrules the _acl field. This should only be used
* with auditing turned on.
* @return Whether the command can go through or not.
* @since 1.0.1
*/
public static boolean isAllowed(
final JsonObject currentState, final JsonObject command, final boolean breakingTheGlass) {
return getUsername(command)
.map(
user ->
user.equals("system")
|| !currentState.containsKey(ACL)
|| (breakingTheGlass
&& getBoolean(command, "/_jwt/breakingTheGlass").orElse(false))
|| getArray(command, "/_jwt/roles")
.map(Command::toStrings)
.map(roles -> concat(roles, of(user)).collect(toSet()))
.map(roles -> isAllowed(currentState, command, roles))
.orElse(false))
.orElse(false);
}
private static boolean isAllowed(
final JsonObject state, final JsonObject command, final Set roles) {
final Optional allowed = getAllowedRoles(state, command);
return !allowed.isPresent()
|| allowed
.map(Command::toStrings)
.map(principals -> principals.collect(toSet()))
.map(principals -> !intersection(principals, roles).isEmpty())
.orElse(false);
}
/**
* Checks if json is a command. This means it has the fields _id,
* _type and _command.
*
* @param json the given object.
* @return The check report.
* @see JsonFields
* @since 1.0
*/
public static boolean isCommand(final JsonObject json) {
return json != null
&& json.containsKey(ID)
&& json.containsKey(CORR)
&& json.containsKey(TYPE)
&& json.containsKey(COMMAND)
&& (PATCH.equals(json.getString(COMMAND)) || !json.containsKey(OPS));
}
/**
* Checks if the command has the name.
*
* @param command the given command.
* @param name the name to be checked.
* @return The check report.
* @since 1.0
*/
public static boolean isCommand(final JsonObject command, final String name) {
return isCommand(command) && name != null && name.equals(command.getString(COMMAND, ""));
}
private static Stream toStrings(final JsonArray array) {
return array.stream()
.filter(JsonUtil::isString)
.map(JsonUtil::asString)
.map(JsonString::getString);
}
}