org.efaps.admin.ui.AbstractUserInterfaceObject 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 - 2011 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: 6374 $
* Last Changed: $Date: 2011-03-25 11:07:42 -0500 (Fri, 25 Mar 2011) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.admin.ui;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import org.efaps.admin.AbstractAdminObject;
import org.efaps.admin.datamodel.Type;
import org.efaps.admin.event.EventDefinition;
import org.efaps.admin.event.EventType;
import org.efaps.admin.event.Parameter;
import org.efaps.admin.event.Parameter.ParameterValues;
import org.efaps.admin.event.Return;
import org.efaps.admin.event.Return.ReturnValues;
import org.efaps.admin.user.AbstractUserObject;
import org.efaps.admin.user.Company;
import org.efaps.ci.CIAdmin;
import org.efaps.db.Context;
import org.efaps.db.Instance;
import org.efaps.db.InstanceQuery;
import org.efaps.db.MultiPrintQuery;
import org.efaps.db.QueryBuilder;
import org.efaps.jaas.AppAccessHandler;
import org.efaps.util.EFapsException;
import org.efaps.util.cache.AbstractCache;
import org.efaps.util.cache.CacheReloadException;
/**
* This Class is the Abstract Class for all UserInterfaces in eFaps.
* In this Class only a few Methods are defined which are common to all Class
* inside the UserInterface Package. With this Class all
* UserInterfaceObjects can be initialized, the Access is checked
* and the Triggers for the UserInterfaceObjects are handled.
*
* @author The eFaps Team
* @version $Id: AbstractUserInterfaceObject.java 4820 2011-06-19 01:37:58Z
* jan.moxter $
*/
public abstract class AbstractUserInterfaceObject
extends AbstractAdminObject
{
/**
* This enum id used to define the different Modes a Target of a Command can
* have, like create, edit etc.
*/
public static enum TargetMode {
/** TargetMode for connect. */
CONNECT,
/** TargetMode for connect. */
CREATE,
/** TargetMode for create. */
EDIT,
/** TargetMode for print. */
PRINT,
/** TargetMode for edit. */
SEARCH,
/** TargetMode for unkown. */
UNKNOWN,
/** TargetMode for view. */
VIEW;
}
/**
* The instance variable is an Access HashSet to store all users (person,
* group or role) who have access to this user interface object.
*
* @see #getAccess
*/
private final Set access = new HashSet();
/**
* Constructor to set the id, the uuid and the name of the user interface
* object.
*
* @param _id id to set
* @param _uuid uuid to set (as String)
* @param _name name to set
*/
protected AbstractUserInterfaceObject(final long _id,
final String _uuid,
final String _name)
{
super(_id, _uuid, _name);
}
/**
* The instance method reads all needed information for this user interface
* object. Here, only the properties are read from the database
*
* @see #readFromDB4Properties
* @see #readFromDB4Links
* @see #readFromDB4Access
* @throws CacheReloadException on error during reload
*/
protected void readFromDB()
throws CacheReloadException
{
readFromDB4Properties();
readFromDB4Links();
readFromDB4Access();
}
/**
* The instance method reads the access for this user interface object.
* @throws CacheReloadException on error during reload
*/
private void readFromDB4Access()
throws CacheReloadException
{
Statement stmt = null;
try {
stmt = Context.getThreadContext().getConnection().createStatement();
final ResultSet resultset = stmt.executeQuery("select "
+ "T_UIACCESS.USERABSTRACT "
+ "from T_UIACCESS "
+ "where T_UIACCESS.UIABSTRACT=" + getId());
while (resultset.next()) {
final long userId = resultset.getLong(1);
final AbstractUserObject userObject = AbstractUserObject.getUserObject(userId);
if (userObject == null) {
throw new CacheReloadException("user " + userId + " does not exists!");
} else {
getAccess().add(userObject);
}
}
resultset.close();
} catch (final SQLException e) {
throw new CacheReloadException("could not read access for " + "'" + getName() + "'", e);
} catch (final EFapsException e) {
throw new CacheReloadException("could not read access for " + "'" + getName() + "'", e);
} finally {
if (stmt != null) {
try {
stmt.close();
} catch (final SQLException e) {
throw new CacheReloadException("could not read access for " + "'" + getName() + "'", e);
}
}
}
}
/**
* Check, if the user of the context has access to this user interface
* object.
* The Check is made in the following order:
*
* - If no access User or role is assigned to this user interface object,
* all user have access and the return is true => go on with Step 3
* - else check if the context person is assigned to one of the user
* objects.
* - if Step 1 or Step 2 have true and the context an Event of the
* Type
TriggerEvent.ACCESSCHECK, the return of the trigger
* initiated program is returned
*
*
* @param _targetMode targetmode of the access
* @param _instance the field will represent, e.g. on edit mode
* @return true if context user has access, otherwise false is
* returned
* @throws EFapsException on error
*/
public boolean hasAccess(final TargetMode _targetMode,
final Instance _instance)
throws EFapsException
{
return hasAccess(_targetMode, _instance, null);
}
/**
* Check, if the user of the context has access to this user interface
* object.
* The Check is made in the following order:
*
* - If no access User or role is assigned to this user interface object,
* all user have access and the return is true => go on with Step 3
* - else check if the context person is assigned to one of the user
* objects.
* - if Step 1 or Step 2 have true and the context an Event of the
* Type
TriggerEvent.ACCESSCHECK, the return of the trigger
* initiated program is returned
*
*
* @param _targetMode targetmode of the access
* @param _instance the field will represent, e.g. on edit mode
* @param _callCmd the cmd that called this UI-Object
* @return true if context user has access, otherwise false is
* returned
* @throws EFapsException on error
*/
public boolean hasAccess(final TargetMode _targetMode,
final Instance _instance,
final AbstractCommand _callCmd)
throws EFapsException
{
boolean ret = false;
if (getAccess().isEmpty() && !AppAccessHandler.excludeMode()) {
ret = true;
} else {
// first must be checked for the company
boolean company = false;
boolean checked = false;
for (final AbstractUserObject userObject : getAccess()) {
if (userObject instanceof Company) {
checked = true;
if (userObject.isAssigned()) {
company = true;
break;
}
}
}
// second it must be checked for the others, if no companies had to
// be checked or
// if the check on companies was positiv
if ((!company && !checked) || (company && checked)) {
for (final AbstractUserObject userObject : getAccess()) {
if (!(userObject instanceof Company)) {
if (userObject.isAssigned()) {
ret = true;
break;
}
}
}
}
}
if ((ret || AppAccessHandler.excludeMode()) && super.hasEvents(EventType.UI_ACCESSCHECK)) {
ret = false;
final List events = super.getEvents(EventType.UI_ACCESSCHECK);
final Parameter parameter = new Parameter();
parameter.put(ParameterValues.UIOBJECT, this);
parameter.put(ParameterValues.ACCESSMODE, _targetMode);
parameter.put(ParameterValues.INSTANCE, _instance);
parameter.put(ParameterValues.CALL_CMD, _callCmd);
for (final EventDefinition event : events) {
final Return retIn = event.execute(parameter);
ret = retIn.get(ReturnValues.TRUE) != null;
}
}
return ret;
}
/**
* Getter method for the HashSet instance variable {@link #access}.
*
* @return value of the HashSet instance variable {@link #access}
* @see #access
*/
protected Set getAccess()
{
return this.access;
}
/**
* Method to initialize the Cache of this CacheObjectInterface.
*
* @throws CacheReloadException on error
*/
public static void initialize()
throws CacheReloadException
{
Image.getCache().initialize(AbstractUserInterfaceObject.class);
Command.getCache().initialize(AbstractUserInterfaceObject.class);
Menu.getCache().initialize(AbstractUserInterfaceObject.class);
Search.getCache().initialize(AbstractUserInterfaceObject.class);
Form.getCache().initialize(AbstractUserInterfaceObject.class);
Table.getCache().initialize(AbstractUserInterfaceObject.class);
Image.getCache().readFromDB();
Command.getCache().readFromDB();
Menu.getCache().readFromDB();
Search.getCache().readFromDB();
Form.getCache().readFromDB();
Table.getCache().readFromDB();
}
/**
* Inner Class to store the UserInterfaces in a Cache.
*
* @param
*/
protected abstract static class AbstractUserInterfaceObjectCache
extends AbstractCache
{
/**
* Stores the caller class.
*/
private final Class callerClass;
/**
* Constructor.
*
* @param _callerClass callerClass
*/
protected AbstractUserInterfaceObjectCache(final Class _callerClass)
{
this.callerClass = _callerClass;
}
/**
* All cached user interface objects are read into the cache.
*
* @throws CacheReloadException
*
* @throws CacheReloadException on error during reload
*/
protected void readFromDB()
throws CacheReloadException
{
for (final T uiObj : getCache4Id().values()) {
uiObj.readFromDB();
}
}
/**
* @return type to be used
* @throws EFapsException on error
*/
protected abstract Type getType()
throws EFapsException;
/**
* {@inheritDoc}
*/
@Override
protected void readCache(final Map _cache4Id,
final Map _cache4Name,
final Map _cache4UUID)
throws CacheReloadException
{
final Class uiObjClass = this.callerClass;
try {
if (getType() != null) {
final QueryBuilder queryBldr = new QueryBuilder(getType());
final InstanceQuery query = queryBldr.getQuery();
query.setIncludeChildTypes(false);
final List instances = query.execute();
final MultiPrintQuery multi = new MultiPrintQuery(instances);
multi.addAttribute(CIAdmin.Abstract.Name,
CIAdmin.Abstract.UUID);
multi.executeWithoutAccessCheck();
while (multi.next()) {
final long id = multi.getCurrentInstance().getId();
final String name = multi. getAttribute(CIAdmin.Abstract.Name);
final String uuid = multi. getAttribute(CIAdmin.Abstract.UUID);
final Constructor uiObj = uiObjClass.getConstructor(Long.class, String.class,
String.class);
final T uiObj2 = uiObj.newInstance(id, uuid, name);
_cache4Id.put(uiObj2.getId(), uiObj2);
_cache4Name.put(uiObj2.getName(), uiObj2);
_cache4UUID.put(uiObj2.getUUID(), uiObj2);
}
}
} catch (final NoSuchMethodException e) {
throw new CacheReloadException("class '" + uiObjClass.getName()
+ "' does not implement contructor (Long, String, String)", e);
} catch (final InstantiationException e) {
throw new CacheReloadException("could not instantiate class '" + uiObjClass.getName() + "'", e);
} catch (final IllegalAccessException e) {
throw new CacheReloadException("could not access class '" + uiObjClass.getName() + "'", e);
} catch (final InvocationTargetException e) {
throw new CacheReloadException("could not invoce constructor of class '" + uiObjClass.getName() + "'",
e);
} catch (final EFapsException e) {
throw new CacheReloadException("could not initialise cache", e);
}
}
}
}