1 /**
2 * This file Copyright (c) 2003-2010 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;
35
36 import info.magnolia.context.Context;
37 import info.magnolia.context.ContextDecorator;
38
39 import java.util.Map;
40
41 import openwfe.org.engine.workitem.Attribute;
42 import openwfe.org.engine.workitem.AttributeException;
43 import openwfe.org.engine.workitem.AttributeUtils;
44 import openwfe.org.engine.workitem.WorkItem;
45
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48
49
50 /**
51 * This context wrapps a workitem and delegates the most of the methods to the inner context.
52 * @author Philipp Bracher
53 * @version $Revision: 32667 $ ($Author: gjoseph $)
54 */
55 public class WorkItemContext extends ContextDecorator {
56 private static final Logger log = LoggerFactory.getLogger(WorkItemContext.class);
57
58 /**
59 * The wrapped workitem
60 */
61 private WorkItem workItem;
62
63 /**
64 *
65 */
66 public WorkItemContext(Context ctx, WorkItem workItem) {
67 super(ctx);
68 this.workItem = workItem;
69 }
70
71 /**
72 * Use work item if request scope
73 */
74 public Object getAttribute(String name, int scope) {
75 if (scope == Context.LOCAL_SCOPE) {
76 Attribute attr = this.workItem.getAttribute(name);
77 if (attr != null) {
78 Object obj = AttributeUtils.owfe2java(attr);
79 if (obj != null) {
80 return obj;
81 }
82 }
83 }
84 return super.getAttribute(name, scope);
85 }
86
87 /**
88 * Use work item if request scope
89 */
90 public Map<String, Object> getAttributes(int scope) {
91 if (scope == Context.LOCAL_SCOPE) {
92 return AttributeUtils.map2java(this.workItem.getAttributes());
93 }
94 return super.getAttributes(scope);
95 }
96
97 /**
98 * Use work item if request scope
99 */
100 public void setAttribute(String name, Object value, int scope) {
101 if (scope == Context.LOCAL_SCOPE) {
102 Attribute attr = AttributeUtils.java2owfe(value);
103 try {
104 if (this.workItem.containsAttribute(name)) {
105 log.debug("Attribute {} already set in WorkItem, will overwrite it with value {}", name, attr.toString());
106 this.workItem.setAttribute(name, attr);
107 } else {
108 this.workItem.addAttribute(name, attr);
109 }
110 }
111 catch (AttributeException e) {
112 log.error("can't set value {}", name, e);
113 }
114 } else {
115 super.setAttribute(name, value, scope);
116 }
117 }
118
119 /**
120 * Use work item if request scope
121 */
122 public void removeAttribute(String name, int scope) {
123 if (scope == Context.LOCAL_SCOPE) {
124 this.workItem.removeAttribute(name);
125 } else {
126 super.removeAttribute(name, scope);
127 }
128 }
129
130 /**
131 * @return Returns the workItem.
132 */
133 public WorkItem getWorkItem() {
134 return this.workItem;
135 }
136
137 /**
138 * @param workItem The workItem to set.
139 */
140 public void setWorkItem(WorkItem workItem) {
141 this.workItem = workItem;
142 }
143
144 }