org.milyn.persistence.EntityUpdater Maven / Gradle / Ivy
/*
Milyn - Copyright (C) 2006 - 2010
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License (version 2.1) as published by the Free Software
Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Lesser General Public License for more details:
http://www.gnu.org/licenses/lgpl.txt
*/
package org.milyn.persistence;
import java.io.IOException;
import java.util.Collections;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.milyn.SmooksException;
import org.milyn.cdr.SmooksConfigurationException;
import org.milyn.cdr.annotation.AppContext;
import org.milyn.cdr.annotation.ConfigParam;
import org.milyn.cdr.annotation.ConfigParam.Use;
import org.milyn.container.ApplicationContext;
import org.milyn.container.ExecutionContext;
import org.milyn.delivery.Fragment;
import org.milyn.delivery.annotation.Initialize;
import org.milyn.delivery.annotation.VisitAfterIf;
import org.milyn.delivery.annotation.VisitBeforeIf;
import org.milyn.delivery.dom.DOMElementVisitor;
import org.milyn.delivery.ordering.Consumer;
import org.milyn.delivery.ordering.Producer;
import org.milyn.delivery.sax.SAXElement;
import org.milyn.delivery.sax.SAXUtil;
import org.milyn.delivery.sax.SAXVisitAfter;
import org.milyn.delivery.sax.SAXVisitBefore;
import org.milyn.event.report.annotation.VisitAfterReport;
import org.milyn.event.report.annotation.VisitBeforeReport;
import org.milyn.javabean.context.BeanContext;
import org.milyn.javabean.context.BeanIdStore;
import org.milyn.javabean.repository.BeanId;
import org.milyn.persistence.util.PersistenceUtil;
import org.milyn.scribe.ObjectStore;
import org.milyn.scribe.invoker.DaoInvoker;
import org.milyn.scribe.invoker.DaoInvokerFactory;
import org.milyn.scribe.register.DaoRegister;
import org.milyn.util.CollectionsUtil;
import org.w3c.dom.Element;
import javax.xml.namespace.QName;
/**
* DAO Updater
*
* This DAO updater calls the update method of a DAO, using a entity bean from
* the bean context as parameter.
*
* Configuration
* Namespace: http://www.milyn.org/xsd/smooks/persistence-1.2.xsd
* Element: updater
* Attributes:
*
* - beanId : The id under which the entity bean is bound in the bean context. (required)
*
- updateOnElement : The element selector to select the element when the inserter should execute. (required)
*
- dao : The name of the DAO that will be used. If it is not set then the default DAO is used. (optional)
*
- name* : The name of the update method. Depending of the adapter this can mean different things.
* For instance when using annotated DAO's you can name the methods and target them with this property, but
* when using the Ibatis adapter you set the id of the Ibatis statement in this attribute. (optional)
*
- updatedBeanId : The bean id under which the updated bean will be stored. If not set then the object returned
* by the update method will not be stored in bean context. (optional)
*
- updateBefore : If the updater should execute on the 'before' event. (default: false)
*
*
* * This attribute is not supported by all scribe adapters.
*
* Configuration Example
*
* <?xml version="1.0"?>
* <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd"
* xmlns:dao="http://www.milyn.org/xsd/smooks/persistence-1.2.xsd">
*
* <dao:updater dao="dao" name="updateIt" beanId="toUpdate" updateOnElement="root" updateBeanId="updated" updateBefore="false" />
*
* </smooks-resource-list>
*
*
* @author [email protected]
*/
@VisitBeforeIf( condition = "parameters.containsKey('updateBefore') && parameters.updateBefore.value == 'true'")
@VisitAfterIf( condition = "!parameters.containsKey('updateBefore') || parameters.updateBefore.value != 'true'")
@VisitBeforeReport(summary = "Updating bean under beanId '${resource.parameters.beanId}'.", detailTemplate="reporting/EntityUpdater.html")
@VisitAfterReport(summary = "Updating bean under beanId '${resource.parameters.beanId}'.", detailTemplate="reporting/EntityUpdater.html")
public class EntityUpdater implements DOMElementVisitor, SAXVisitBefore, SAXVisitAfter, Producer, Consumer {
private static Log logger = LogFactory.getLog(EntityUpdater.class);
@ConfigParam(name = "beanId")
private String beanIdName;
@ConfigParam(name = "updatedBeanId", use = Use.OPTIONAL)
private String updatedBeanIdName;
@ConfigParam(name = "dao", use = Use.OPTIONAL)
private String daoName;
@ConfigParam(use = Use.OPTIONAL)
private String name;
@AppContext
private ApplicationContext appContext;
private ObjectStore objectStore;
private BeanId beanId;
private BeanId updatedBeanId;
@Initialize
public void initialize() throws SmooksConfigurationException {
BeanIdStore beanIdStore = appContext.getBeanIdStore();
beanId = beanIdStore.register(beanIdName);
if(updatedBeanIdName != null) {
updatedBeanId = beanIdStore.register(updatedBeanIdName);
}
objectStore = new ApplicationContextObjectStore(appContext);
}
/* (non-Javadoc)
* @see org.milyn.delivery.ordering.Producer#getProducts()
*/
public Set getProducts() {
if(updatedBeanIdName == null) {
return Collections.emptySet();
} else {
return CollectionsUtil.toSet(updatedBeanIdName);
}
}
/* (non-Javadoc)
* @see org.milyn.delivery.ordering.Consumer#consumes(java.lang.String)
*/
public boolean consumes(Object object) {
return object.equals(beanIdName);
}
public void visitBefore(final Element element, final ExecutionContext executionContext) throws SmooksException {
update(executionContext, new Fragment(element));
}
public void visitAfter(final Element element, final ExecutionContext executionContext) throws SmooksException {
update(executionContext, new Fragment(element));
}
public void visitBefore(final SAXElement element, final ExecutionContext executionContext) throws SmooksException, IOException {
update(executionContext, new Fragment(element));
}
public void visitAfter(final SAXElement element, final ExecutionContext executionContext) throws SmooksException, IOException {
update(executionContext, new Fragment(element));
}
/**
* @param executionContext
* @param source
* @return
*/
@SuppressWarnings("unchecked")
private void update(final ExecutionContext executionContext, Fragment source) {
if(logger.isDebugEnabled()) {
logger.debug("Updating bean under BeanId '" + beanIdName + "' with DAO '" + daoName + "'.");
}
BeanContext beanContext = executionContext.getBeanContext();
Object bean = beanContext.getBean(beanId);
final DaoRegister emr = PersistenceUtil.getDAORegister(executionContext);
Object dao = null;
try {
if(daoName == null) {
dao = emr.getDefaultDao();
} else {
dao = emr.getDao(daoName);
}
if(dao == null) {
throw new IllegalStateException("The DAO register returned null while getting the DAO '" + daoName + "'");
}
final DaoInvoker daoInvoker = DaoInvokerFactory.getInstance().create(dao, objectStore);
Object result = name == null ? daoInvoker.update(bean) : daoInvoker.update(name, bean) ;
if(updatedBeanId != null) {
if(result == null) {
result = bean;
}
beanContext.addBean(updatedBeanId, result, source);
} else if(result != null && bean != result) {
beanContext.changeBean(beanId, bean, source);
}
} finally {
if(dao != null) {
emr.returnDao(dao);
}
}
}
}