View Javadoc

1   /**
2    * This file Copyright (c) 2003-2013 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.workflow.jcr;
35  
36  import info.magnolia.module.ModuleRegistry;
37  import info.magnolia.module.workflow.WorkflowConstants;
38  import info.magnolia.module.workflow.WorkflowModule;
39  import info.magnolia.objectfactory.Components;
40  
41  import java.util.Collections;
42  
43  import openwfe.org.ServiceException;
44  import openwfe.org.embed.impl.engine.PersistedEngine;
45  import openwfe.org.engine.Definitions;
46  import openwfe.org.engine.expool.ExpressionPool;
47  import openwfe.org.engine.participants.Participant;
48  import openwfe.org.engine.participants.ParticipantMap;
49  
50  import org.slf4j.Logger;
51  import org.slf4j.LoggerFactory;
52  
53  
54  /**
55   * Implement openwfe.org.embed.engine.Engine to use JCRWorkItemStore and JCRExpressionStore.
56   *
57   * @author jackie_juju@hotmail.com
58   */
59  public class JCRPersistedEngine extends PersistedEngine {
60      private final static Logger log = LoggerFactory.getLogger(JCRPersistedEngine.class.getName());
61  
62      private final JCRExpressionStore eStore;
63  
64      public JCRPersistedEngine() throws ServiceException {
65          this(WorkflowConstants.ENGINE_NAME, true);
66      }
67  
68      /**
69       * Instantiates a JCR persisted engine with the given name.
70       */
71      public JCRPersistedEngine(final String engineName, final boolean cached) throws ServiceException {
72          super(engineName, cached);
73          super.setDaemon(true);
74  
75          // create expression store and add it to context
76          WorkflowModule module = Components.getComponent(ModuleRegistry.class).getModuleInstance(WorkflowModule.class);
77          this.eStore = new JCRExpressionStore(module.isUseLifeTimeJCRSession(), module.isCleanup());
78  
79          this.eStore.init(Definitions.S_EXPRESSION_STORE, getContext(), Collections.EMPTY_MAP);
80  
81          getContext().add(this.eStore);
82      }
83  
84      // TODO : this doesn't seem to be used ... ?
85      public Participant getParticipant(String name) {
86          ParticipantMap pm = Definitions.getParticipantMap(getContext());
87          if (pm == null) {
88              log.error("get participant failed, the map retrieved was null for:" + name);
89              return null;
90          }
91          return pm.get(name);
92      }
93  
94      // TODO : this doesn't seem to be used ... ?
95      public JCRExpressionStore getExpStore() {
96          return this.eStore;
97      }
98  
99      // TODO : this is useless since engine.stop() already stops the expression pool, like the WFModule tries to do ... ?
100     @Override
101     public ExpressionPool getExpressionPool() {
102         return super.getExpressionPool();
103     }
104 
105 }