org.efaps.admin.user.Role 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
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.
/*
* Copyright 2003 - 2012 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: 8229 $
* Last Changed: $Date: 2012-11-22 14:25:34 -0500 (Thu, 22 Nov 2012) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.admin.user;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Map;
import java.util.UUID;
import org.efaps.db.Context;
import org.efaps.db.transaction.ConnectionResource;
import org.efaps.db.wrapper.SQLSelect;
import org.efaps.util.EFapsException;
import org.efaps.util.cache.AbstractCache;
import org.efaps.util.cache.CacheReloadException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Class represents the instance of a role in eFaps.
*
* @author The eFaps Team
* @version $Id: Role.java 8229 2012-11-22 19:25:34Z [email protected] $
*/
public final class Role
extends AbstractUserObject
{
/**
* Needed for serialization.
*/
private static final long serialVersionUID = 1L;
/**
* Logging instance used in this class.
*/
private static final Logger LOG = LoggerFactory.getLogger(Role.class);
/**
* This is the SQL select statement to select all roles from the database.
*/
private static final SQLSelect SQL_SELECT = new SQLSelect().column("ID")
.column("UUID")
.column("NAME")
.column("STATUS")
.from("V_USERROLE");
/**
* Stores all instances of class {@link Role}.
*
* @see #getCache
*/
private static final RoleCache CACHE = new RoleCache();
/**
* Create a new role instance. The method is used from the static method
* {@link #initialize()} to read all roles from the database.
*
* @param _id id of the role
* @param _uuid uuid of the role
* @param _name name of the role
* @param _status status of the role
*/
private Role(final long _id,
final String _uuid,
final String _name,
final boolean _status)
{
super(_id, _uuid, _name, _status);
}
/**
* Checks, if the given person is assigned to this role.
*
* @param _person person to test
* @return true if the person is assigned to this role, otherwise
* false
* @see Person#isAssigned(Role)
*/
@Override
public boolean hasChildPerson(final Person _person)
{
return _person.isAssigned(this);
}
/**
* Method to initialize the Cache of this CacheObjectInterface.
*/
public static void initialize()
{
Role.CACHE.initialize(Role.class);
}
/**
* Returns for given parameter _id the instance of class
* {@link Role}.
*
* @param _id id to search in the cache
* @return instance of class {@link Role}
* @throws CacheReloadException on error
* @see #CACHE
*/
public static Role get(final long _id)
throws CacheReloadException
{
return Role.CACHE.get(_id);
}
/**
* Returns for given parameter _name the instance of class
* {@link Role}.
*
* @param _name name to search in the cache
* @return instance of class {@link Role}
* @throws CacheReloadException on error
* @see #CACHE
*/
public static Role get(final String _name)
throws CacheReloadException
{
return Role.CACHE.get(_name);
}
/**
* Returns for given parameter _uuid the instance of class
* {@link Role}.
*
* @param _uuid UUI to search for
* @return instance of class {@link Role}
* @throws CacheReloadException on error
* @see #CACHE
*/
public static Role get(final UUID _uuid)
throws CacheReloadException
{
return Role.CACHE.get(_uuid);
}
/**
* Returns for given parameter _jaasKey the instance of class
* {@link Role}. The parameter _jaasKey is the name of the
* role used in the given JAAS system for the role.
*
* @param _jaasSystem JAAS system for which the JAAS key is named
* @param _jaasKey key in the foreign JAAS system for which the role is
* searched
* @throws EFapsException on error
* @return instance of class {@link Role}, or null if role is
* not found
* @see #get(long)
*/
public static Role getWithJAASKey(final JAASSystem _jaasSystem,
final String _jaasKey)
throws EFapsException
{
long roleId = 0;
ConnectionResource rsrc = null;
try {
rsrc = Context.getThreadContext().getConnectionResource();
Statement stmt = null;
try {
final StringBuilder cmd = new StringBuilder()
.append("select ").append("ID ").append("from V_USERROLEJASSKEY ")
.append("where JAASKEY='").append(_jaasKey).append("' ")
.append("and JAASSYSID=").append(_jaasSystem.getId());
stmt = rsrc.getConnection().createStatement();
final ResultSet resultset = stmt.executeQuery(cmd.toString());
if (resultset.next()) {
roleId = resultset.getLong(1);
}
resultset.close();
} catch (final SQLException e) {
Role.LOG.warn("search for role for JAAS system '" + _jaasSystem.getName()
+ "' with key '" + _jaasKey + "' is not possible", e);
throw new EFapsException(Role.class, "getWithJAASKey.SQLException", e,
_jaasSystem.getName(), _jaasKey);
} finally {
try {
stmt.close();
} catch (final SQLException e) {
Role.LOG.warn("Catched SQLException in class " + Role.class);
}
}
rsrc.commit();
} finally {
if ((rsrc != null) && rsrc.isOpened()) {
rsrc.abort();
}
}
return Role.get(roleId);
}
/**
* Method to get the Cache for Roles.
*
* @return Cache
* @see #CACHE
*/
public static AbstractCache getCache()
{
return Role.CACHE;
}
/**
* Class used as the Cache for Roles.
*/
private static final class RoleCache
extends AbstractCache
{
/**
* Method to read the data into the cache.
*
* @param _cache4Id cache with id as key
* @param _cache4Name cache with name as key
* @param _cache4UUID cache with UUID as key
* @throws CacheReloadException on error during reading the date
*/
@Override
protected void readCache(final Map _cache4Id,
final Map _cache4Name,
final Map _cache4UUID)
throws CacheReloadException
{
ConnectionResource con = null;
try {
con = Context.getThreadContext().getConnectionResource();
Statement stmt = null;
try {
stmt = con.getConnection().createStatement();
final ResultSet resulset = stmt.executeQuery(Role.SQL_SELECT.getSQL());
while (resulset.next()) {
final long id = resulset.getLong(1);
final String uuid = resulset.getString(2);
final String name = resulset.getString(3).trim();
final boolean status = resulset.getBoolean(4);
Role.LOG.debug("read role '" + name + "' (id = " + id + ")");
final Role role = new Role(id, uuid, name, status);
_cache4Id.put(role.getId(), role);
_cache4Name.put(role.getName(), role);
_cache4UUID.put(role.getUUID(), role);
}
resulset.close();
} finally {
if (stmt != null) {
stmt.close();
}
}
con.commit();
} catch (final SQLException e) {
throw new CacheReloadException("could not read roles", e);
} catch (final EFapsException e) {
throw new CacheReloadException("could not read roles", e);
} finally {
if ((con != null) && con.isOpened()) {
try {
con.abort();
} catch (final EFapsException e) {
throw new CacheReloadException("could not read roles", e);
}
}
}
}
}
}