org.lable.rfc3881.auditlogger.api.Principal Maven / Gradle / Ivy
/*
* Copyright © 2015 Lable ([email protected])
*
* 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 org.lable.rfc3881.auditlogger.api;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.lable.codesystem.codereference.CodeReference;
import org.lable.codesystem.codereference.Identifiable;
import org.lable.codesystem.codereference.Referenceable;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import static org.lable.rfc3881.auditlogger.api.util.ParameterValidation.parameterMayNotBeNull;
/**
* Security identity of a user or automated process. This includes the relevant security roles for the action that
* was performed.
*/
@JsonFilter("logFilter")
public class Principal implements EntryPart, Identifiable, Serializable {
private static final long serialVersionUID = -7367595173448586271L;
/* Required fields. */
/**
* Unique identifier for the user actively participating in the event.
*
* IETF/RFC 3881 §5.2.1. User ID.
*/
final String userId;
/* Optional fields. */
/**
* Alternative unique identifiers for the user.
*
* IETF/RFC 3881 §5.2.2. Alternative User ID.
*/
final List alternateUserId;
/**
* The human-meaningful name for the user.
*
* IETF/RFC 3881 §5.2.3. User Name.
*/
final String name;
/**
* Specification of the role(s) the user plays when performing the event, as assigned in role-based access
* control security.
*
* IETF/RFC 3881 §5.2.5. Role ID Code.
*/
final List relevantRoles;
/**
* Mark this log entry part as complete or in need of further refinement further down the processing chain.
*/
final boolean complete;
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param alternateUserId Synonymous user IDs.
* @param name Human readable name.
* @param complete Mark this data as complete, or in need of further refinement.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId,
List alternateUserId,
String name,
boolean complete,
List relevantRoles) {
parameterMayNotBeNull("userId", userId);
this.userId = userId;
this.alternateUserId = alternateUserId == null ? Collections.emptyList() : alternateUserId;
this.name = name;
this.complete = complete;
this.relevantRoles = relevantRoles == null ? Collections.emptyList() : relevantRoles.stream()
.map(Referenceable::toCodeReference)
.collect(Collectors.toList());
}
@JsonCreator
private static Principal json(@JsonProperty("userId") String userId,
@JsonProperty("alternateUserId") List alternateUserId,
@JsonProperty("name") String name,
@JsonProperty("complete") Boolean complete,
@JsonProperty("relevantRoles") List relevantRoles) {
complete = complete == null || complete;
return new Principal(userId, alternateUserId, name, complete, relevantRoles);
}
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param alternateUserId Synonymous user IDs.
* @param name Human readable name.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId,
List alternateUserId,
String name,
List relevantRoles) {
this(userId, alternateUserId, name, true, relevantRoles);
}
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId, Referenceable... relevantRoles) {
this(userId, Collections.emptyList(), null, true, relevantRoles);
}
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param alternateUserId Synonymous user IDs.
* @param name Human readable name.
* @param complete Mark this data as complete, or in need of further refinement.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId,
List alternateUserId,
String name,
boolean complete,
Referenceable... relevantRoles) {
this(userId, alternateUserId, name, complete, Arrays.asList(relevantRoles));
}
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param alternateUserId Synonymous user IDs.
* @param name Human readable name.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId,
List alternateUserId,
String name,
Referenceable... relevantRoles) {
this(userId, alternateUserId, name, true, Arrays.asList(relevantRoles));
}
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param alternateUserId Synonymous user ID.
* @param name Human readable name.
* @param complete Mark this data as complete, or in need of further refinement.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId,
String alternateUserId,
String name,
boolean complete,
Referenceable... relevantRoles) {
this(userId, Collections.singletonList(alternateUserId), name, complete, relevantRoles);
}
/**
* Define a principal.
*
* @param userId Unique user ID.
* @param alternateUserId Synonymous user ID.
* @param name Human readable name.
* @param relevantRoles List of roles relevant for the action performed.
*/
public Principal(String userId,
String alternateUserId,
String name,
Referenceable... relevantRoles) {
this(userId, Collections.singletonList(alternateUserId), name, true, relevantRoles);
}
public String getUserId() {
return userId;
}
public List getRelevantRoles() {
return relevantRoles;
}
public String getName() {
return name;
}
public List getAlternateUserId() {
return alternateUserId;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isComplete() {
return complete;
}
/**
* {@inheritDoc}
*/
@Override
public List identifyingStack() {
return Collections.singletonList(getUserId());
}
@Override
public boolean equals(Object other) {
if (this == other) return true;
if (other == null || getClass() != other.getClass()) return false;
Principal that = (Principal) other;
return Objects.equals(this.userId, that.userId) &&
Objects.equals(this.alternateUserId, that.alternateUserId) &&
Objects.equals(this.name, that.name) &&
this.complete == that.complete &&
Objects.equals(this.relevantRoles, that.relevantRoles);
}
@Override
public int hashCode() {
return Objects.hash(userId, alternateUserId, name, complete, relevantRoles);
}
@Override
public String toString() {
return "ID: " + getUserId() +
(getName() == null || getName().isEmpty() ? "" : "\nName: " + getName()) +
(getAlternateUserId().isEmpty()
? ""
: "\nAlt ID: " + String.join("; ", getAlternateUserId())) +
"\nRoles: " + (getRelevantRoles() == null ? "[]" : getRelevantRoles()) +
(complete ? "" : "\nINCOMPLETE");
}
}