org.efaps.bpm.identity.UserGroupCallbackImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

The newest version!

/*
 * Copyright 2003 - 2013 The eFaps Team
 *
 * 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.
 *
 * Revision:        $Rev$
 * Last Changed:    $Date$
 * Last Changed By: $Author$
 */


package org.efaps.bpm.identity;

import java.util.ArrayList;
import java.util.List;
import java.util.UUID;

import org.efaps.admin.EFapsSystemConfiguration;
import org.efaps.admin.KernelSettings;
import org.efaps.admin.user.Person;
import org.efaps.admin.user.Role;
import org.efaps.util.EFapsException;
import org.kie.api.task.UserGroupCallback;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * TODO comment!
 *
 * @author The eFaps Team
 * @version $Id$
 */
public class UserGroupCallbackImpl
    implements UserGroupCallback
{

    /**
     * Logging instance used in this class.
     */
    private static final Logger LOG = LoggerFactory.getLogger(UserGroupCallbackImpl.class);


    /**
     * Default Constructor.
     */
    public UserGroupCallbackImpl()
    {
        try {
            if (!EFapsSystemConfiguration.get().getAttributeValueAsBoolean(KernelSettings.REQUIRE_PERSON_UUID)) {
                UserGroupCallbackImpl.LOG.warn("BPM is activated but the UUID for Persons is not required. "
                                + "That might leed to serious problems in the future!!!!!!");
            }
        } catch (final EFapsException e) {
            UserGroupCallbackImpl.LOG.error("Could not read SystemConfiguration.", e);
        }
    }

    /**
     * Resolves existence of user id.
     *
     * By default, jBPM registers a special user with userId "Administrator" as the
     * administrator of each task. You should therefore make sure that you always
     * define at least a user "Administrator" when registering the list of valid
     * users at the task service.
     *
     * @param _userId    the user id assigned to the task
     * @return true if userId exists, false otherwise.
     */
    @Override
    public boolean existsUser(final String _userId)
    {
        UserGroupCallbackImpl.LOG.debug("checking for existence of User: '{}'", _userId);
        boolean ret = false;
        if ("Administrator".equals(_userId)) {
            ret = true;
        } else {
            try {
                final Person pers = org.efaps.admin.user.Person.get(UUID.fromString(_userId));
                ret = pers != null;
            } catch (final EFapsException e) {
                UserGroupCallbackImpl.LOG.error("error while checkin for existence of User: '{}'", _userId);
            }
        }
        UserGroupCallbackImpl.LOG.debug("result for existence check for User: '{}' is: {}", _userId, ret);
        return ret;
    }

    /**
     * Resolves existence of group id.
     *
     * @param _groupId   the group id assigned to the task
     * @return true if groupId exists, false otherwise.
     */
    @Override
    public boolean existsGroup(final String _groupId)
    {
        UserGroupCallbackImpl.LOG.debug("checking for existence of Group: {}", _groupId);
        boolean ret = false;
        if ("Administrators".equals(_groupId)) {
            ret = true;
        } else {
            try {
                final Role role = org.efaps.admin.user.Role.get(UUID.fromString(_groupId));
                ret = role != null;
            } catch (final EFapsException e) {
                UserGroupCallbackImpl.LOG.error("error while checkin for existence of Group: '{}'", _groupId);
            }
        }
        UserGroupCallbackImpl.LOG.debug("result for existence check for Group: '{}' is: {}", _groupId, ret);
        return ret;
    }

    /**
     * Returns list of group ids for specified user id.
     *
     * @param _userId    the user id assigned to the task
     * @param _groupIds  list of group ids assigned to the task
     * @param _allExistingGroupIds   list of all currently known group ids
     * @return List of group ids.
     */
    @Override
    public List getGroupsForUser(final String _userId,
                                         final List _groupIds,
                                         final List _allExistingGroupIds)
    {
        UserGroupCallbackImpl.LOG.debug(
                        "getting Groups for User: '{}'. Assigned Groups: {}. Currently known Groups: {}.", _userId,
                        _groupIds, _allExistingGroupIds);
        final List ret = new ArrayList();
        try {
            final Person pers;
            if ("Administrator".equals(_userId)) {
                pers = org.efaps.admin.user.Person.get(_userId);
            } else {
                pers = org.efaps.admin.user.Person.get(UUID.fromString(_userId));
            }
            if (pers != null) {
                for (final Long roleId : pers.getRoles()) {
                    final Role role = org.efaps.admin.user.Role.get(roleId);
                    ret.add(role.getUUID().toString());
                }
            }
        } catch (final EFapsException e) {
            UserGroupCallbackImpl.LOG.error("error while checkin for existence of User: '{}'", _userId);
        }
        UserGroupCallbackImpl.LOG.debug("found Groups for User: '{}': {}", _userId, ret);
        return ret;
    }

}