Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.jackrabbit.oak.security.user;
import java.security.Principal;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.jcr.RepositoryException;
import javax.jcr.nodetype.ConstraintViolationException;
import com.google.common.base.Predicate;
import com.google.common.base.Strings;
import com.google.common.collect.Iterators;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import org.apache.jackrabbit.api.security.user.Authorizable;
import org.apache.jackrabbit.api.security.user.Group;
import org.apache.jackrabbit.api.security.user.UserManager;
import org.apache.jackrabbit.commons.iterator.RangeIteratorAdapter;
import org.apache.jackrabbit.oak.api.Tree;
import org.apache.jackrabbit.oak.spi.security.user.AuthorizableType;
import org.apache.jackrabbit.oak.spi.security.user.util.UserUtil;
import org.apache.jackrabbit.oak.spi.xml.ImportBehavior;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* GroupImpl...
*/
class GroupImpl extends AuthorizableImpl implements Group {
private static final Logger log = LoggerFactory.getLogger(GroupImpl.class);
GroupImpl(String id, Tree tree, UserManagerImpl userManager) throws RepositoryException {
super(id, tree, userManager);
}
//---------------------------------------------------< AuthorizableImpl >---
@Override
void checkValidTree(@Nonnull Tree tree) throws RepositoryException {
if (!UserUtil.isType(tree, AuthorizableType.GROUP)) {
throw new IllegalArgumentException("Invalid group node: node type rep:Group expected.");
}
}
//-------------------------------------------------------< Authorizable >---
@Override
public boolean isGroup() {
return true;
}
@Override
public Principal getPrincipal() throws RepositoryException {
return new GroupPrincipal(getPrincipalName(), getTree());
}
//--------------------------------------------------------------< Group >---
@Override
public Iterator getDeclaredMembers() throws RepositoryException {
return getMembers(false);
}
@Override
public Iterator getMembers() throws RepositoryException {
return getMembers(true);
}
@Override
public boolean isDeclaredMember(Authorizable authorizable) throws RepositoryException {
return isMember(authorizable, false);
}
@Override
public boolean isMember(Authorizable authorizable) throws RepositoryException {
return isMember(authorizable, true);
}
@Override
public boolean addMember(Authorizable authorizable) throws RepositoryException {
if (!isValidAuthorizableImpl(authorizable)) {
log.warn("Invalid Authorizable: {}", authorizable);
return false;
}
AuthorizableImpl authorizableImpl = ((AuthorizableImpl) authorizable);
if (isEveryone() || authorizableImpl.isEveryone()) {
return false;
}
String memberID = authorizable.getID();
if (authorizableImpl.isGroup()) {
if (getID().equals(memberID)) {
String msg = "Attempt to add a group as member of itself (" + getID() + ").";
log.debug(msg);
return false;
}
if (isCyclicMembership((Group) authorizable)) {
String msg = "Cyclic group membership detected for group " + getID() + " and member " + authorizable.getID();
throw new ConstraintViolationException(msg);
}
}
boolean success = getMembershipProvider().addMember(getTree(), authorizableImpl.getTree());
if (success) {
getUserManager().onGroupUpdate(this, false, authorizable);
}
return success;
}
@Override
public Set addMembers(@Nonnull String... memberIds) throws RepositoryException {
return updateMembers(false, memberIds);
}
@Override
public boolean removeMember(Authorizable authorizable) throws RepositoryException {
if (!isValidAuthorizableImpl(authorizable)) {
log.warn("Invalid Authorizable: {}", authorizable);
return false;
}
if (isEveryone()) {
return false;
} else {
Tree memberTree = ((AuthorizableImpl) authorizable).getTree();
boolean success = getMembershipProvider().removeMember(getTree(), memberTree);
if (success) {
getUserManager().onGroupUpdate(this, true, authorizable);
}
return success;
}
}
@Override
public Set removeMembers(@Nonnull String... memberIds) throws RepositoryException {
return updateMembers(true, memberIds);
}
//--------------------------------------------------------------------------
/**
* Internal implementation of {@link #getDeclaredMembers()} and {@link #getMembers()}.
*
* @param includeInherited Flag indicating if only the declared or all members
* should be returned.
* @return Iterator of authorizables being member of this group.
* @throws RepositoryException If an error occurs.
*/
private Iterator getMembers(boolean includeInherited) throws RepositoryException {
UserManagerImpl userMgr = getUserManager();
if (isEveryone()) {
String propName = getUserManager().getNamePathMapper().getJcrName((REP_PRINCIPAL_NAME));
return Iterators.filter(
userMgr.findAuthorizables(propName, null, UserManager.SEARCH_TYPE_AUTHORIZABLE),
new Predicate() {
@Override
public boolean apply(@Nullable Authorizable authorizable) {
if (authorizable == null) {
return false;
}
if (authorizable.isGroup()) {
try {
return !((GroupImpl) authorizable).isEveryone();
} catch (RepositoryException e) {
log.warn("Unable to evaluate if authorizable is the 'everyone' group.", e);
}
}
return true;
}
}
);
} else {
Iterator oakPaths = getMembershipProvider().getMembers(getTree(), includeInherited);
if (oakPaths.hasNext()) {
AuthorizableIterator iterator = AuthorizableIterator.create(oakPaths, userMgr, AuthorizableType.AUTHORIZABLE);
return new RangeIteratorAdapter(iterator, iterator.getSize());
} else {
return RangeIteratorAdapter.EMPTY;
}
}
}
/**
* Internal implementation of {@link #isDeclaredMember(Authorizable)} and {@link #isMember(Authorizable)}.
*
* @param authorizable The authorizable to test.
* @param includeInherited Flag indicating if only declared or all members
* should taken into account.
* @return {@code true} if the specified authorizable is member or declared
* member of this group; {@code false} otherwise.
* @throws RepositoryException If an error occurs.
*/
private boolean isMember(Authorizable authorizable, boolean includeInherited) throws RepositoryException {
if (!isValidAuthorizableImpl(authorizable)) {
return false;
}
if (getID().equals(authorizable.getID())) {
return false;
} else if (isEveryone()) {
return true;
} else if (((AuthorizableImpl) authorizable).isEveryone()) {
return false;
} else {
Tree authorizableTree = ((AuthorizableImpl) authorizable).getTree();
MembershipProvider mgr = getUserManager().getMembershipProvider();
if (includeInherited) {
return mgr.isMember(this.getTree(), authorizableTree);
} else {
return mgr.isDeclaredMember(this.getTree(), authorizableTree);
}
}
}
/**
* Internal method to add or remove members by ID.
*
* @param isRemove Boolean flag indicating if members should be added or removed.
* @param memberIds The {@code memberIds} to be added or removed.
* @return The sub-set of {@code memberIds} that could not be added/removed.
* @throws javax.jcr.nodetype.ConstraintViolationException If any of the specified
* IDs is empty string or null or if {@link org.apache.jackrabbit.oak.spi.xml.ImportBehavior#ABORT}
* is configured and an ID cannot be resolved to an existing (or accessible)
* authorizable.
* @throws javax.jcr.RepositoryException If another error occurs.
*/
private Set updateMembers(boolean isRemove, @Nonnull String... memberIds) throws RepositoryException {
Set failedIds = Sets.newHashSet(memberIds);
int importBehavior = UserUtil.getImportBehavior(getUserManager().getConfig());
if (isEveryone()) {
String msg = "Attempt to add or remove from everyone group.";
log.debug(msg);
return failedIds;
}
// calculate the contentID for each memberId and remember ids that cannot be processed
Map updateMap = Maps.newHashMapWithExpectedSize(memberIds.length);
MembershipProvider mp = getMembershipProvider();
for (String memberId : memberIds) {
if (Strings.isNullOrEmpty(memberId)) {
throw new ConstraintViolationException("MemberId must not be null or empty.");
}
if (getID().equals(memberId)) {
String msg = "Attempt to add or remove a group as member of itself (" + getID() + ").";
log.debug(msg);
continue;
}
if (ImportBehavior.BESTEFFORT != importBehavior) {
Authorizable member = getUserManager().getAuthorizable(memberId);
String msg = null;
if (member == null) {
msg = "Attempt to add or remove a non-existing member '" + memberId + "' with ImportBehavior = " + ImportBehavior.nameFromValue(importBehavior);
} else if (member.isGroup()) {
if (((AuthorizableImpl) member).isEveryone()) {
log.debug("Attempt to add everyone group as member.");
continue;
} else if (isCyclicMembership((Group) member)) {
msg = "Cyclic group membership detected for group " + getID() + " and member " + member.getID();
}
}
if (msg != null) {
if (ImportBehavior.ABORT == importBehavior) {
throw new ConstraintViolationException(msg);
} else {
// ImportBehavior.IGNORE is default in UserUtil.getImportBehavior
log.debug(msg);
continue;
}
}
}
// memberId can be processed -> remove from failedIds and generate contentID
failedIds.remove(memberId);
updateMap.put(mp.getContentID(memberId), memberId);
}
Set processedIds = Sets.newHashSet(updateMap.values());
if (!updateMap.isEmpty()) {
Set result;
if (isRemove) {
result = mp.removeMembers(getTree(), updateMap);
} else {
result = mp.addMembers(getTree(), updateMap);
}
failedIds.addAll(result);
processedIds.removeAll(result);
}
getUserManager().onGroupUpdate(this, isRemove, false, processedIds, failedIds);
return failedIds;
}
private boolean isCyclicMembership(@Nonnull Group member) throws RepositoryException {
return member.isMember(this);
}
/**
* Principal representation of this group instance.
*/
private final class GroupPrincipal extends AbstractGroupPrincipal {
private GroupPrincipal(String principalName, Tree groupTree) {
super(principalName, groupTree, GroupImpl.this.getUserManager().getNamePathMapper());
}
@Override
UserManager getUserManager() {
return GroupImpl.this.getUserManager();
}
@Override
boolean isEveryone() throws RepositoryException {
return GroupImpl.this.isEveryone();
}
@Override
boolean isMember(@Nonnull Authorizable authorizable) throws RepositoryException {
return GroupImpl.this.isMember(authorizable);
}
@Nonnull
@Override
Iterator getMembers() throws RepositoryException {
return GroupImpl.this.getMembers();
}
}
}
