org.opencastproject.security.api.AccessControlList Maven / Gradle / Ivy
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community 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://opensource.org/licenses/ecl2.txt
*
* 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.opencastproject.security.api;
import java.util.AbstractMap.SimpleEntry;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
/**
* A list of {@link AccessControlEntry}s.
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "acl", namespace = "http://org.opencastproject.security", propOrder = { "entries" })
@XmlRootElement(name = "acl", namespace = "http://org.opencastproject.security")
public final class AccessControlList {
/** The list of access control entries */
@XmlElement(name = "ace")
private List entries;
/**
* No-arg constructor needed by JAXB
*/
public AccessControlList() {
this.entries = new ArrayList<>();
}
public AccessControlList(AccessControlEntry... entries) {
this.entries = new ArrayList<>(Arrays.asList(entries));
}
public AccessControlList(List entries) {
this.entries = new ArrayList<>(entries);
}
/**
* @return the entries
*/
public List getEntries() {
return entries;
}
public boolean isValid() {
return entries.stream().allMatch(AccessControlEntry::isValid);
}
/**
* {@inheritDoc}
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return entries.toString();
}
/**
* Merge this access control list with another one based on roles specified within. In case both lists specify
* rules for a specific role, the set of rules from the access control list passed as argument to this method will
* take precedence over the internal set of rules.
*
* Example:
*
* ROLE_USER1 ROLE_USER2 ROLE_USER3
* read write read write read write
* this ok ok ok ok
* argument ok ok
* result ok ok ok ok
*
*
* @param acl
* Access control list to merge with
* @return Merged access control list
*/
public AccessControlList merge(AccessControlList acl) {
HashSet roles = new HashSet<>();
ArrayList newEntries = new ArrayList<>(acl.getEntries());
// Get list of new roles
for (AccessControlEntry entry : newEntries) {
roles.add(entry.getRole());
}
// Apply old rules if no new rules for a role exist
for (AccessControlEntry entry : this.entries) {
if (!roles.contains(entry.getRole())) {
newEntries.add(entry);
}
}
this.entries = newEntries;
return this;
}
/**
* Merge this access control list with another one based on actions specified within. In case both lists specify
* rules for a specific action, the rules from the access control list passed as argument to this method will take
* precedence over the internal rules.
*
* Example:
*
* ROLE_USER1 ROLE_USER2 ROLE_USER3
* read write read write read write
* this ok ok ok ok
* argument ok ok
* result ok ok ok ok ok
*
*
* @param acl
* Access control list to merge with
* @return Merged access control list
*/
public AccessControlList mergeActions(AccessControlList acl) {
HashMap, AccessControlEntry> rules = new HashMap<>();
SimpleEntry key;
for (AccessControlEntry entry : this.entries) {
key = new SimpleEntry<>(entry.getRole(), entry.getAction());
rules.put(key, entry);
}
for (AccessControlEntry entry : acl.getEntries()) {
key = new SimpleEntry<>(entry.getRole(), entry.getAction());
rules.put(key, entry);
}
this.entries = new ArrayList<>(rules.values());
return this;
}
@Override
public boolean equals(Object o) {
if (o instanceof AccessControlList) {
return entries.equals(((AccessControlList) o).entries);
}
return false;
}
@Override
public int hashCode() {
return Objects.hash(entries);
}
}