org.efaps.db.Delete 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: 6544 $
* Last Changed: $Date: 2011-05-12 23:58:38 -0500 (Thu, 12 May 2011) $
* Last Changed By: $Author: [email protected] $
*/
package org.efaps.db;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import org.efaps.admin.access.AccessTypeEnums;
import org.efaps.admin.datamodel.SQLTable;
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.db.store.Resource;
import org.efaps.db.transaction.ConnectionResource;
import org.efaps.db.wrapper.SQLDelete;
import org.efaps.db.wrapper.SQLDelete.DeleteDefintion;
import org.efaps.util.EFapsException;
/**
* The class is used as interface to the eFaps kernel to delete one object.
*
* @author The eFaps Team
* @version $Id: Delete.java 6544 2011-05-13 04:58:38Z [email protected] $
*/
public class Delete
{
/**
* The instance variable stores the instance for which this update is made.
*
* @see #getInstance()
*/
private final Instance instance;
/**
* @param _instance Instance to be deleted
*/
public Delete(final Instance _instance)
{
this.instance = _instance;
}
/**
* @param _type type of the Instance to be deleted
* @param _id id of the Instance to be deleted
*/
public Delete(final Type _type,
final String _id)
{
this.instance = Instance.get(_type, _id);
}
/**
* @param _type type of the Instance to be deleted
* @param _id id of the Instance to be deleted
*/
public Delete(final Type _type, final long _id)
{
this.instance = Instance.get(_type, _id);
}
/**
* @param _oid oid of the Instance to be deleted
*/
public Delete(final String _oid)
{
this.instance = Instance.get(_oid);
}
/**
* First it is checked if the user has access to delete the eFaps object
* defined in {@link #instance}. If no access, an exception is thrown. If
* the context user has access. the delete is made with
* {@link #executeWithoutAccessCheck}.
*
* @throws EFapsException if the current context user has no delete access
* on given eFaps object.
* @see #executeWithoutAccessCheck()
*/
public void execute()
throws EFapsException
{
final boolean hasAccess = this.instance.getType().hasAccess(this.instance,
AccessTypeEnums.DELETE.getAccessType());
if (!hasAccess) {
throw new EFapsException(getClass(), "execute.NoAccess", this.instance);
}
executeWithoutAccessCheck();
}
/**
* Executes the delete without checking the access rights (but with
* triggers).
*
* - executes the pre delete trigger (if exists)
* - executes the delete trigger (if exists)
* - executes if no delete trigger exists or the delete trigger is not
* executed the update ({@see #executeWithoutTrigger})
* - executes the post delete trigger (if exists)
*
*
* @throws EFapsException thrown from {@link #executeWithoutTrigger} or
* when the status is invalid
* @see #executeWithoutTrigger()
*/
public void executeWithoutAccessCheck()
throws EFapsException
{
executeEvents(EventType.DELETE_PRE);
if (!executeEvents(EventType.DELETE_OVERRIDE)) {
executeWithoutTrigger();
}
executeEvents(EventType.DELETE_POST);
}
/**
* The executes is done without calling triggers and check of access
* rights. The method executes the delete. For the object, a delete is made
* in all SQL tables from the type (if the SQL table is not read only!). If
* a store is defined for the type, the checked in file is also deleted
* (with the help of the store resource implementation; if the store
* resource implementation has not implemented the delete, the file is not
* deleted!).
* It is not checked if the current context user has access to delete
* the eFaps object defined in {@link #instance}.
*
* @see SQLTable#isReadOnly()
* @throws EFapsException on error
*/
public void executeWithoutTrigger()
throws EFapsException
{
final Context context = Context.getThreadContext();
ConnectionResource con = null;
try {
con = context.getConnectionResource();
try {
GeneralInstance.delete(getInstance(), con.getConnection());
final List defs = new ArrayList();
final SQLTable mainTable = getInstance().getType().getMainTable();
for (final SQLTable curTable : getInstance().getType().getTables()) {
if ((curTable != mainTable) && !curTable.isReadOnly()) {
defs.add(new DeleteDefintion(curTable.getSqlTable(),
curTable.getSqlColId(), getInstance().getId()));
}
}
defs.add(new DeleteDefintion(mainTable.getSqlTable(), mainTable.getSqlColId(), getInstance().getId()));
final SQLDelete delete = Context.getDbType().newDelete(defs.toArray(new DeleteDefintion[defs.size()]));
delete.execute(con.getConnection());
} catch (final SQLException e) {
throw new EFapsException(getClass(),
"executeWithoutAccessCheck.SQLException", e, this.instance);
}
con.commit();
} finally {
if ((con != null) && con.isOpened()) {
con.abort();
}
}
Resource storeRsrc = null;
try {
if (getInstance().getType().hasStore()) {
storeRsrc = context.getStoreResource(getInstance());
storeRsrc.delete();
storeRsrc.commit();
}
} finally {
if ((storeRsrc != null) && storeRsrc.isOpened()) {
storeRsrc.abort();
}
}
}
/**
* This is the getter method for instance variable {@link #instance}.
*
* @return value of instance variable {@link #instance}
* @see #instance
*/
public Instance getInstance()
{
return this.instance;
}
/**
* The method gets all events for the given EventType and executes them in
* the given order. If no events are defined, nothing is done. The method
* return true if a event was found, otherwise false.
*
* @param _eventtype event type to execute
* @return true if a trigger was found and executed, otherwise
* false
* @throws EFapsException on error
*/
private boolean executeEvents(final EventType _eventtype)
throws EFapsException
{
final boolean ret;
final List triggers = getInstance().getType().getEvents(_eventtype);
if (triggers == null) {
ret = false;
} else {
final Parameter parameter = new Parameter();
parameter.put(ParameterValues.INSTANCE, getInstance());
for (final EventDefinition evenDef : triggers) {
evenDef.execute(parameter);
}
ret = true;
}
return ret;
}
}