1 /*
2 * Copyright 2007 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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
17 package org.springframework.ws.transport;
18
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.io.OutputStream;
22 import java.util.Iterator;
23
24 /**
25 * Abstract base class for {@link WebServiceConnection} implementations used for receiving requests.
26 *
27 * @author Arjen Poutsma
28 * @since 1.0.0
29 */
30 public abstract class AbstractReceiverConnection extends AbstractWebServiceConnection {
31
32 private TransportInputStream requestInputStream;
33
34 private TransportOutputStream responseOutputStream;
35
36 protected final TransportInputStream createTransportInputStream() throws IOException {
37 if (requestInputStream == null) {
38 requestInputStream = new RequestTransportInputStream();
39 }
40 return requestInputStream;
41 }
42
43 protected final TransportOutputStream createTransportOutputStream() throws IOException {
44 if (responseOutputStream == null) {
45 responseOutputStream = new ResponseTransportOutputStream();
46 }
47 return responseOutputStream;
48 }
49
50 /**
51 * Template method invoked from {@link #close()}. Default implementation is empty.
52 *
53 * @throws IOException if an I/O error occurs when closing this connection
54 */
55 protected void onClose() throws IOException {
56 }
57
58 /**
59 * Returns an iteration over all the header names this request contains. Returns an empty <code>Iterator</code> if
60 * there areno headers.
61 */
62 protected abstract Iterator getRequestHeaderNames() throws IOException;
63
64 /**
65 * Returns an iteration over all the string values of the specified header. Returns an empty <code>Iterator</code>
66 * if there are no headers of the specified name.
67 */
68 protected abstract Iterator getRequestHeaders(String name) throws IOException;
69
70 /** Returns the input stream to read the response from. */
71 protected abstract InputStream getRequestInputStream() throws IOException;
72
73 /**
74 * Adds a response header with the given name and value. This method can be called multiple times, to allow for
75 * headers with multiple values.
76 *
77 * @param name the name of the header
78 * @param value the value of the header
79 */
80 protected abstract void addResponseHeader(String name, String value) throws IOException;
81
82 /** Returns the output stream to write the request to. */
83 protected abstract OutputStream getResponseOutputStream() throws IOException;
84
85 /** Implementation of <code>TransportInputStream</code> for receiving-side connections. */
86 private class RequestTransportInputStream extends TransportInputStream {
87
88 protected InputStream createInputStream() throws IOException {
89 return getRequestInputStream();
90 }
91
92 public Iterator getHeaderNames() throws IOException {
93 return getRequestHeaderNames();
94 }
95
96 public Iterator getHeaders(String name) throws IOException {
97 return getRequestHeaders(name);
98 }
99
100 }
101
102 /** Implementation of <code>TransportOutputStream</code> for sending-side connections. */
103 private class ResponseTransportOutputStream extends TransportOutputStream {
104
105 public void addHeader(String name, String value) throws IOException {
106 addResponseHeader(name, value);
107 }
108
109 protected OutputStream createOutputStream() throws IOException {
110 return getResponseOutputStream();
111 }
112
113 }
114
115
116 }