1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2005 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: MarshalledInvocation.java,v 1.2 2005/07/22 23:40:36 tanderson Exp $
44 */
45
46 package org.exolab.jms.net.connector;
47
48 import java.io.IOException;
49 import java.rmi.MarshalledObject;
50
51 import EDU.oswego.cs.dl.util.concurrent.Latch;
52
53
54 /***
55 * An <code>Invocation</code> where the {@link Request} is wrapped
56 * in an {@link MarshalledObject}.
57 *
58 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
59 * @version $Revision: 1.2 $ $Date: 2005/07/22 23:40:36 $
60 */
61 public class MarshalledInvocation implements Invocation {
62
63 /***
64 * The marshalled {@link Request} instance.
65 */
66 private final MarshalledObject _request;
67
68 /***
69 * The result of the invocation.
70 */
71 private Response _response;
72
73 /***
74 * The caller performing the invocation.
75 */
76 private final Caller _caller;
77
78 /***
79 * Latch to force clients to wait until the invocation is complete.
80 */
81 private final Latch _latch = new Latch();
82
83
84 /***
85 * Construct a new <code>MarshalledInvocation</code>.
86 *
87 * @param request the marshalled {@link Request} instance
88 * @param caller the caller performing the invocation
89 */
90 public MarshalledInvocation(MarshalledObject request, Caller caller) {
91 _request = request;
92 _caller = caller;
93 }
94
95 /***
96 * Returns the request.
97 *
98 * @return the request
99 * @throws Throwable for any error
100 */
101 public Request getRequest() throws Throwable {
102 return (Request) _request.get();
103 }
104
105 /***
106 * Returns the caller performing the invocation.
107 *
108 * @return the caller
109 */
110 public Caller getCaller() {
111 return _caller;
112 }
113
114 /***
115 * Sets the result of the invocation.
116 *
117 * @param response the result
118 */
119 public void setResponse(Response response) {
120 _response = response;
121 _latch.release();
122 }
123
124 /***
125 * Returns the result of the invocation.
126 *
127 * @return the result of the invocation.
128 * @throws InterruptedException if interrupted
129 */
130 public Response getResponse() throws InterruptedException {
131 _latch.acquire();
132 return _response;
133 }
134
135 /***
136 * Returns the result of the invocation, wrapped in a {@link
137 * MarshalledObject}.
138 *
139 * @return the result of the invocation.
140 * @throws IOException if the response can't be marshalld
141 * @throws InterruptedException if interrupted
142 */
143 public MarshalledObject getMarshalledResponse()
144 throws IOException, InterruptedException {
145 return new MarshalledObject(getResponse());
146 }
147
148 }