01: /*
02: * Copyright 2005 Joe Walker
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.directwebremoting.proxy.io;
17:
18: import org.directwebremoting.ScriptBuffer;
19: import org.directwebremoting.proxy.ScriptProxy;
20:
21: /**
22: * Context is a way for a {@link ScriptProxy} to return a value that can only be
23: * realized on the client.
24: * A {@link Context} allows a {@link ScriptProxy} to return something, and have
25: * server side code keep track of the things it is acting on.
26: * @author Joe Walker [joe at getahead dot ltd dot uk]
27: */
28: public class Context {
29: /**
30: * Create a new Context
31: * @param parent Our parent context, or null if we start from scratch
32: * @param extension A string to append to the parent context
33: */
34: public Context(Context parent, String extension,
35: ScriptProxy scriptProxy) {
36: this .parent = parent;
37: this .extension = extension;
38: this .scriptProxy = scriptProxy;
39: }
40:
41: /**
42: * Accessor for the string to append to the parent context to define us
43: * @return the extension
44: */
45: protected String getContextPath() {
46: String prefix = (parent == null) ? "" : parent.getContextPath();
47: return prefix + extension;
48: }
49:
50: /**
51: * Accessor for the current script proxy
52: * @return The current script proxy
53: */
54: protected ScriptProxy getScriptProxy() {
55: return scriptProxy;
56: }
57:
58: /**
59: * Accessor for the current InitScript
60: * @param initScript The new InitScript
61: */
62: protected void setInitScript(ScriptBuffer initScript) {
63: this .initScript = initScript;
64: }
65:
66: /**
67: * Accessor for the current InitScript
68: * @return The current InitScript
69: */
70: protected ScriptBuffer getInitScript() {
71: return initScript;
72: }
73:
74: /**
75: * A destination for the generated scripts
76: */
77: private ScriptProxy scriptProxy;
78:
79: /**
80: * When we're stand-alone, created from 'new' someone else want the start point
81: */
82: private ScriptBuffer initScript;
83:
84: /**
85: * Our parent context, or null if we start from scratch
86: */
87: private Context parent;
88:
89: /**
90: * A string to append to the parent context to get to where we are
91: */
92: private String extension;
93: }
|