org.efaps.admin.access.AccessSet 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: 7483 $
* Last Changed: $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.admin.access;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import org.efaps.admin.AbstractAdminObject;
import org.efaps.admin.datamodel.Status;
import org.efaps.admin.datamodel.Type;
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;
/**
* @author The eFaps Team
* @version $Id: AccessSet.java 7483 2012-05-11 16:57:38Z [email protected] $
*/
public final class AccessSet
extends AbstractAdminObject
{
/**
* Logging instance used in this class.
*/
private static final Logger LOG = LoggerFactory.getLogger(AccessSet.class);
/**
* This is the sql select statement to select all access types from the
* database.
*
* @see #init4ReadAllAccessSets
*/
private static final SQLSelect SQL_SELECT = new SQLSelect()
.column("ID")
.column("UUID")
.column("NAME")
.from("T_ACCESSSET");
/**
* This is the sql select statement to select the links from all access sets
* to all access types in the database.
*
* @see #init4ReadLinks2AccessTypes
*/
private static final SQLSelect SQL_SET2TYPE = new SQLSelect()
.column("ACCESSSET")
.column("ACCESSTYPE")
.from("T_ACCESSSET2TYPE");
/**
* This is the sql select statement to select the links from all access sets
* to all data model types in the database.
*
* @see #init4ReadLinks2DMTypes
*/
private static final SQLSelect SQL_SET2DMTYPE = new SQLSelect()
.column("ACCESSSET")
.column("DMTYPE")
.from("T_ACCESSSET2DMTYPE");
/**
* This is the sql select statement to select the links from all access sets
* to all stati in the database.
*
* @see #init4ReadLinks2DMTypes
*/
private static final SQLSelect SQL_SET2STATUS = new SQLSelect()
.column("ACCESSSET")
.column("ACCESSSTATUS")
.from("T_ACCESSSET2STATUS");
/**
* Cache for AccesSets.
*/
private static final AccessSetCache CACHE = new AccessSetCache();
/**
* All related access types of this access set are referenced in this
* instance variable.
*
* @see #getAccessTypes
*/
private final Set accessTypes = new HashSet();
/**
* All related data models types of this access set are referenced in this
* instance variable.
*
* @see #getDataModelTypes
*/
private final Set dataModelTypes = new HashSet();
/**
* All related Status of this access set are referenced in this
* instance variable.
*/
private final Set stati = new HashSet();
/**
* This is the constructor.
*
* @param _id id of this access type
* @param _uuid universal unique identifier of this access type
* @param _name name of this access type
*/
private AccessSet(final long _id, final String _uuid, final String _name)
{
super(_id, _uuid, _name);
}
/**
* This is the getter method for instance variable {@link #accessTypes}.
*
* @return the value of the instance variable {@link #accessTypes}.
* @see #accessTypes
*/
public Set getAccessTypes()
{
return this.accessTypes;
}
/**
* This is the getter method for instance variable {@link #dataModelTypes}.
*
* @return the value of the instance variable {@link #dataModelTypes}.
* @see #dataModelTypes
*/
public Set getDataModelTypes()
{
return this.dataModelTypes;
}
/**
* Getter method for instance variable {@link #stati}.
*
* @return value of instance variable {@link #stati}
*/
public Set getStati()
{
return this.stati;
}
/**
* Method to initialize the Cache of this CacheObjectInterface.
*/
public static void initialize()
{
AccessSet.CACHE.initialize(AccessSet.class);
}
/**
* Returns for given identifier in _id the cached instance of class
* AccessSet.
* @param _id id the AccessSet is wanted for
* @return instance of class AccessSet
* @throws CacheReloadException
*/
public static AccessSet getAccessSet(final long _id)
{
return AccessSet.CACHE.get(_id);
}
/**
* Returns for given name in _name the cached instance of class
* AccessSet.
* @param _name name the AccessSet is wanted for
* @return instance of class AccessSet
* @throws CacheReloadException
*/
public static AccessSet getAccessSet(final String _name)
{
return AccessSet.CACHE.get(_name);
}
/**
* Returns for given universal unique identifier in _uuid the cached
* instance of class AccessSet.
* @param _uuid UUID the AccessSet is wanted for
* @return instance of class AccessSet
* @throws CacheReloadException
*/
public static AccessSet getAccessSet(final UUID _uuid)
{
return AccessSet.CACHE.get(_uuid);
}
/**
* Cahce for AccessSets.
*/
private static class AccessSetCache
extends AbstractCache
{
/**
* {@inheritDoc}
*/
@Override
protected void readCache(final Map _newCache4Id,
final Map _newCache4Name,
final Map _newCache4UUID)
throws CacheReloadException
{
ConnectionResource con = null;
try {
con = Context.getThreadContext().getConnectionResource();
AccessSet.AccessSetCache.init4ReadAllAccessSets(con, _newCache4Id, _newCache4Name, _newCache4UUID);
AccessSet.AccessSetCache.init4ReadLinks2AccessTypes(con, _newCache4Id);
AccessSet.AccessSetCache.init4ReadLinks2DMTypes(con, _newCache4Id);
AccessSet.AccessSetCache.init4ReadLinks2Status(con, _newCache4Id);
con.commit();
} catch (final EFapsException e) {
throw new CacheReloadException("could not create connection resource", e);
} finally {
if ((con != null) && con.isOpened()) {
try {
con.abort();
} catch (final EFapsException e) {
throw new CacheReloadException("could not abort transaction", e);
}
}
}
}
/**
* All access sets are read from the database.
* @param _con Connection to read from
* @param _cache4Id cache for id
* @param _cache4Name cache for name
* @param _cache4UUID cache for uuid
* @throws CacheReloadException on error
*/
private static void init4ReadAllAccessSets(final ConnectionResource _con,
final Map _cache4Id,
final Map _cache4Name,
final Map _cache4UUID)
throws CacheReloadException
{
Statement stmt = null;
try {
stmt = _con.getConnection().createStatement();
final ResultSet rs = stmt.executeQuery(AccessSet.SQL_SELECT.getSQL());
while (rs.next()) {
final long id = rs.getLong(1);
final String uuid = rs.getString(2);
final String name = rs.getString(3);
if (AccessSet.LOG.isDebugEnabled()) {
AccessSet.LOG.debug("read access set '" + name + "' " + "(id = " + id + ", uuid = " + uuid
+ ")");
}
final AccessSet accessSet = new AccessSet(id, uuid, name);
_cache4Id.put(accessSet.getId(), accessSet);
_cache4Name.put(accessSet.getName(), accessSet);
_cache4UUID.put(accessSet.getUUID(), accessSet);
}
} catch (final SQLException e) {
throw new CacheReloadException("could not read access set", e);
} finally {
if (stmt != null) {
try {
stmt.close();
} catch (final SQLException e) {
AccessSet.LOG.debug(AccessSet.class + " - SQLException");
}
}
}
}
/**
* All access set links to the access types are read from the database.
*
* @param _con connection resource
* @param _cache4Id cache for id
* @throws CacheReloadException on error
*/
private static void init4ReadLinks2AccessTypes(final ConnectionResource _con,
final Map _cache4Id)
throws CacheReloadException
{
Statement stmt = null;
try {
stmt = _con.getConnection().createStatement();
final ResultSet rs = stmt.executeQuery(AccessSet.SQL_SET2TYPE.getSQL());
while (rs.next()) {
final long accessSetId = rs.getLong(1);
final long accessTypeId = rs.getLong(2);
final AccessSet accessSet = _cache4Id.get(accessSetId);
final AccessType accessType = AccessType.getAccessType(accessTypeId);
if (accessSet == null) {
AccessSet.LOG.error("could not found access set with id " + "'" + accessSetId + "'");
} else if (accessType == null) {
AccessSet.LOG.error("could not found access type with id " + "'" + accessTypeId + "'");
} else {
AccessSet.LOG.debug("read link from " + "access set '" + accessSet.getName() + "' " + "(id = "
+ accessSet.getId() + ", " + "uuid = " + accessSet.getUUID() + ") to "
+ "access type '" + accessType.getName() + "' " + "(id = " + accessType.getId()
+ ", " + "uuid = " + accessType.getUUID() + ")");
accessSet.getAccessTypes().add(accessType);
}
}
rs.close();
} catch (final SQLException e) {
throw new CacheReloadException("could not read access links", e);
} finally {
if (stmt != null) {
try {
stmt.close();
} catch (final SQLException e) {
AccessSet.LOG.debug(AccessSet.class + " - SQLException");
}
}
}
}
/**
* All access set links to the data model types are read from the
* database.
*
* @param _con connection resource
* @param _cache4Id cache for id
* @throws CacheReloadException on error
*/
private static void init4ReadLinks2DMTypes(final ConnectionResource _con,
final Map _cache4Id)
throws CacheReloadException
{
Statement stmt = null;
try {
stmt = _con.getConnection().createStatement();
final ResultSet rs = stmt.executeQuery(AccessSet.SQL_SET2DMTYPE.getSQL());
while (rs.next()) {
final long accessSetId = rs.getLong(1);
final long dataModelTypeId = rs.getLong(2);
final AccessSet accessSet = _cache4Id.get(accessSetId);
final Type dataModelType = Type.get(dataModelTypeId);
if (accessSet == null) {
AccessSet.LOG.error("could not found access set with id " + "'" + accessSetId + "'");
} else if (dataModelType == null) {
AccessSet.LOG.error("could not found data model type with id " + "'" + dataModelTypeId + "'");
} else {
AccessSet.LOG.debug("read link from " + "access set '" + accessSet.getName() + "' " + "(id = "
+ accessSet.getId() + ", " + "uuid = " + accessSet.getUUID() + ") to "
+ "data model type '" + dataModelType.getName() + "' " + "(id = "
+ dataModelType.getId() + ", " + "uuid = " + dataModelType.getUUID() + ")");
accessSet.getDataModelTypes().add(dataModelType);
dataModelType.addAccessSet(accessSet);
}
}
rs.close();
} catch (final SQLException e) {
throw new CacheReloadException("could not read links to types", e);
} finally {
if (stmt != null) {
try {
stmt.close();
} catch (final SQLException e) {
AccessSet.LOG.debug(AccessSet.class + " - SQLException");
}
}
}
}
/**
* All access set links to the data model types are read from the
* database.
*
* @param _con connection resource
* @param _cache4Id cache for id
* @throws CacheReloadException on error
*/
private static void init4ReadLinks2Status(final ConnectionResource _con,
final Map _cache4Id)
throws CacheReloadException
{
Statement stmt = null;
try {
stmt = _con.getConnection().createStatement();
final ResultSet rs = stmt.executeQuery(AccessSet.SQL_SET2STATUS.getSQL());
while (rs.next()) {
final long accessSetId = rs.getLong(1);
final long statusId = rs.getLong(2);
final AccessSet accessSet = _cache4Id.get(accessSetId);
final Status status = Status.get(statusId);
if (accessSet == null) {
AccessSet.LOG.error("could not found access set with id " + "'" + accessSetId + "'");
} else if (status == null) {
AccessSet.LOG.error("could not found status with id " + "'" + statusId + "'");
} else {
AccessSet.LOG.debug("read link from " + "access set '" + accessSet.getName() + "' " + "(id = "
+ accessSet.getId() + ", " + "uuid = " + accessSet.getUUID() + ") to "
+ "Status '" + status.getKey() + "' " + "(id = "
+ status.getId() + ")");
accessSet.getStati().add(status);
}
}
rs.close();
} catch (final SQLException e) {
throw new CacheReloadException("could not read links to types", e);
} finally {
if (stmt != null) {
try {
stmt.close();
} catch (final SQLException e) {
AccessSet.LOG.debug(AccessSet.class + " - SQLException");
}
}
}
}
}
}