001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.invocation;
023:
024: import java.util.Map;
025: import java.util.HashMap;
026:
027: import org.jboss.invocation.Invoker;
028:
029: /**
030: * The Invocation Context
031: *
032: * <p>Describes the context in which this Invocation is being executed in
033: * the interceptors
034: *
035: * <p>The heart of it is the payload map that can contain anything we then
036: * put readers on them. The first "reader" is this "Invocation" object that
037: * can interpret the data in it.
038: *
039: * <p>Essentially we can carry ANYTHING from the client to the server, we
040: * keep a series of redifined variables and method calls to get at the
041: * pointers. But really it is just a repository of objects.
042: *
043: * @author <a href="mailto:marc@jboss.org">Marc Fleury</a>
044: * @version $Revision: 57209 $
045: */
046: public class InvocationContext implements java.io.Serializable {
047: /** Serial Version Identifier. @since 1.5 */
048: private static final long serialVersionUID = 7679468692447241311L;
049:
050: // Context is a map
051: public Map context;
052:
053: /**
054: * Exposed for externalization only.
055: */
056: public InvocationContext() {
057: context = new HashMap();
058: }
059:
060: /**
061: * Invocation creation
062: */
063: public InvocationContext(final Map context) {
064: this .context = context;
065: }
066:
067: //
068: // The generic getter and setter is really all that one needs to talk to
069: // this object. We introduce typed getters and setters for convenience
070: // and code readability in the codebase
071: //
072:
073: /**
074: * The generic store of variables
075: */
076: public void setValue(Object key, Object value) {
077: context.put(key, value);
078: }
079:
080: /**
081: * Get a value from the stores.
082: */
083: public Object getValue(Object key) {
084: return context.get(key);
085: }
086:
087: /**
088: * A container for server side association.
089: */
090: public void setObjectName(Object objectName) {
091: context.put(InvocationKey.OBJECT_NAME, objectName);
092: }
093:
094: public Object getObjectName() {
095: return context.get(InvocationKey.OBJECT_NAME);
096: }
097:
098: /**
099: * Return the invocation target ID. Can be used to identify a cached object.
100: */
101: public void setCacheId(Object id) {
102: context.put(InvocationKey.CACHE_ID, id);
103: }
104:
105: public Object getCacheId() {
106: return context.get(InvocationKey.CACHE_ID);
107: }
108:
109: public void setInvoker(Invoker invoker) {
110: context.put(InvocationKey.INVOKER, invoker);
111: }
112:
113: public Invoker getInvoker() {
114: return (Invoker) context.get(InvocationKey.INVOKER);
115: }
116:
117: public void setInvokerProxyBinding(String binding) {
118: context.put(InvocationKey.INVOKER_PROXY_BINDING, binding);
119: }
120:
121: public String getInvokerProxyBinding() {
122: return (String) context
123: .get(InvocationKey.INVOKER_PROXY_BINDING);
124: }
125: }
|