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.
package org.apache.fulcrum.security.model.turbine;
/*
* 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.
*/
import org.apache.fulcrum.security.ModelManager;
import org.apache.fulcrum.security.entity.Group;
import org.apache.fulcrum.security.entity.Permission;
import org.apache.fulcrum.security.entity.Role;
import org.apache.fulcrum.security.entity.User;
import org.apache.fulcrum.security.util.DataBackendException;
import org.apache.fulcrum.security.util.UnknownEntityException;
/**
* Describes all the relationships between entities in the "Turbine" model.
*
* @author Eric Pugh
* @version $Id: TurbineModelManager.java 1845858 2018-11-05 21:14:02Z painter $
*/
public interface TurbineModelManager extends ModelManager
{
/**
* attribute where global group name could be set
*/
String GLOBAL_GROUP_ATTR_NAME = "globalGroup";
/**
* The name of the global group, if no global group name is set in model manager
*/
public String GLOBAL_GROUP_NAME = "global";
/**
* may be used in implementations
*
*/
public enum Privilege {
GRANT, REVOKE, REPLACE_ROLE;
}
/**
* TODO
*
transactional revoke/grant = replace for global group/role?
*
may allow user - group assignments without role, i.e. with default role. Requires adding/defining default/zero role for group, you have then to the global role additionally a global group.
* This may be relevant, if just only one group is sufficient (or at least one).
*/
/**
* Provides a reference to the Group object that represents the global group.
*
* @return A Group object that represents the global group.
* @throws DataBackendException generic exception
*/
Group getGlobalGroup() throws DataBackendException;
/**
*
* @return the configured global group name, by default {@link #GLOBAL_GROUP_ATTR_NAME}
*/
public String getGlobalGroupName();
/**
* Replaces the assigned old Role to new role in the #global group for User user.
*
* @param user
* the User.
* @param oldRole
* the old Role
* @param newRole
* the new Role
* @throws DataBackendException generic exception
* @throws UnknownEntityException generic exception
*/
void replace(User user, Role oldRole, Role newRole) throws DataBackendException, UnknownEntityException;
/**
* Puts a permission in a role
*
* This method is used when adding a permission to a role
*
* @param role
* the Role.
* @param permission
* the Permission
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the account is not present.
*/
void grant(Role role, Permission permission) throws DataBackendException, UnknownEntityException;
/**
* Removes a permission from a role
*
* @param role
* the Role.
* @param permission
* the Permission
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the role or permission is not present.
*/
void revoke(Role role, Permission permission) throws DataBackendException, UnknownEntityException;
/**
* Revokes all roles from an User.
*
* This method is typically used when deleting an account.
*
* @param user
* the User.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the account is not present.
*/
void revokeAll(User user) throws DataBackendException, UnknownEntityException;
/**
* Revokes all permissions from a Role.
*
* This method is typically used when deleting a Role.
*
* @param role
* the Role
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the Role is not present.
*/
void revokeAll(Role role) throws DataBackendException, UnknownEntityException;
/**
* Revokes all roles and users from a Group.
*
* This method is typically used when deleting a Group.
*
* @param group
* the Group
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the Group is not present.
*/
void revokeAll(Group group) throws DataBackendException, UnknownEntityException;
/**
* Grant an User a Role in a Group.
*
* @param user
* the user.
* @param group
* the group.
* @param role
* the role.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if user account, group or role is not present.
*/
void grant(User user, Group group, Role role) throws DataBackendException, UnknownEntityException;
/**
* Revoke a Role in a Group from an User.
*
* @param user
* the user.
* @param group
* the group.
* @param role
* the role.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if user account, group or role is not present.
*/
void revoke(User user, Group group, Role role) throws DataBackendException, UnknownEntityException;
/**
* Revokes by default all permissions from a Role and if flag is set
* all groups and users for this role
*
* This method is used when deleting a Role.
*
* @param role
* the Role
* @param cascadeDelete
* if true removes all groups and user for this role.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the Role is not present.
*/
void revokeAll( Role role, boolean cascadeDelete )
throws DataBackendException, UnknownEntityException;
}
