001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: /*
038: * InboundMessageProcessor.java
039: *
040: * @author Mike Grogan
041: * Created on October 31, 2005, 8:21 AM
042: *
043: */
044:
045: package com.sun.xml.ws.rm.jaxws.runtime;
046:
047: import com.sun.xml.ws.api.message.Header;
048: import com.sun.xml.ws.rm.*;
049: import com.sun.xml.ws.rm.protocol.AbstractAckRequested;
050: import com.sun.xml.ws.rm.protocol.AbstractSequence;
051: import com.sun.xml.ws.rm.protocol.AbstractSequenceAcknowledgement;
052: import com.sun.xml.ws.rm.v200502.AckRequestedElement;
053:
054: import javax.xml.bind.JAXBException;
055: import javax.xml.bind.Marshaller;
056: import javax.xml.bind.Unmarshaller;
057:
058: /**
059: *
060: * InboundMessageProcessor examines the headers of inbound <code>Messages</code> and
061: * based on the sequence id's and types of the headers, dispatches them to
062: * appropriate <code>ClientInboundSequence</code> or <code>ClientOutboundSequence</code>
063: * methods.
064: */
065: public class InboundMessageProcessor {
066:
067: private RMProvider provider;
068:
069: public InboundMessageProcessor(RMProvider provider) {
070:
071: this .provider = provider;
072: }
073:
074: /**
075: * For each inbound <code>Message</code>, invokes protocol logic dictated by the contents of the
076: * WS-RM protocol headers on the message.
077: * <ul>
078: * <li><b>Sequence Header</b><br>Adds the message to the instance data of this incoming sequence according using the
079: * Sequence Identifier and Message Number in the header.</li>
080: * <li><b>SequenceAcknowledgement Header</b><br>Invokes the <code>handleAckResponse</code> method of the companion
081: * <code>ClientOutboundSequence</code> which marks acknowledged messages as delivered.</li>
082: * <li><b>AckRequested Header</b><br>Constructs a <code>SequenceAcknowledgementElement</code> reflecting the messages
083: * belonging to this sequence that have been received. Sets the resulting
084: *
085: * <code>SequenceAcknowledgementElement</code> in the state of the companion <code>ClientOutboundSequence</code>.</li>
086: * </ul>
087: * <br>
088: * @param message The inbound <code>Message</code>.
089: */
090:
091: public void processMessage(Message message, Marshaller marshaller,
092: Unmarshaller unmarshaller) throws RMException {
093:
094: try {
095:
096: /*
097: * Check for each RM header type and do the right thing in RMProvider
098: * depending on the type.
099: */
100:
101: InboundSequence inseq = null;
102:
103: Header header = message.getHeader("Sequence");
104: if (header != null) {
105:
106: //identify sequence and message number from data in header and add
107: //the message to the sequence at the specified index.
108: //TODO handle error condition seq == null
109: AbstractSequence el = (AbstractSequence) header
110: .readAsJAXB(unmarshaller);
111:
112: message.setSequenceElement(el);
113: String seqid = null;
114: int messageNumber;
115: if (el instanceof com.sun.xml.ws.rm.v200502.SequenceElement) {
116: seqid = ((com.sun.xml.ws.rm.v200502.SequenceElement) el)
117: .getId();
118:
119: //add message to ClientInboundSequence
120: messageNumber = ((com.sun.xml.ws.rm.v200502.SequenceElement) el)
121: .getNumber();
122: } else {
123: seqid = ((com.sun.xml.ws.rm.v200702.SequenceElement) el)
124: .getId();
125:
126: //add message to ClientInboundSequence
127: messageNumber = ((com.sun.xml.ws.rm.v200702.SequenceElement) el)
128: .getNumber();
129:
130: }
131:
132: if (messageNumber == Integer.MAX_VALUE) {
133: throw new MessageNumberRolloverException(
134: String
135: .format(
136: Constants.MESSAGE_NUMBER_ROLLOVER_TEXT,
137: messageNumber),
138: messageNumber);
139: }
140:
141: inseq = provider.getInboundSequence(seqid);
142:
143: if (inseq.isClosed()) {
144: throw new CloseSequenceException(String
145: .format(Constants.SEQUENCE_CLOSED_TEXT),
146: seqid);
147: }
148:
149: if (inseq != null) {
150: inseq.set(messageNumber, message);
151: } else {
152: throw new InvalidSequenceException(String.format(
153: Constants.UNKNOWN_SEQUENCE_TEXT, seqid),
154: seqid);
155: }
156:
157: }
158:
159: header = message.getHeader("SequenceAcknowledgement");
160: if (header != null) {
161:
162: //determine OutboundSequence id from data in header and update
163: //state of that sequence according to the acks and nacks in the element
164: AbstractSequenceAcknowledgement ackHeader = (AbstractSequenceAcknowledgement) (header
165: .readAsJAXB(unmarshaller));
166: String ackHeaderId = null;
167:
168: if (ackHeader instanceof com.sun.xml.ws.rm.v200502.SequenceAcknowledgementElement) {
169: ackHeaderId = ((com.sun.xml.ws.rm.v200502.SequenceAcknowledgementElement) ackHeader)
170: .getId();
171:
172: } else {
173: ackHeaderId = ((com.sun.xml.ws.rm.v200702.SequenceAcknowledgementElement) ackHeader)
174: .getId();
175:
176: }
177:
178: message.setSequenceAcknowledgementElement(ackHeader);
179:
180: OutboundSequence seq = provider
181: .getOutboundSequence(ackHeaderId);
182:
183: if (seq != null) {
184: seq.handleAckResponse(ackHeader);
185: }
186: }
187:
188: header = message.getHeader("AckRequested");
189: if (header != null) {
190:
191: //dispatch to InboundSequence to construct response.
192: //TODO handle error condition no such sequence
193: AbstractAckRequested el = (AbstractAckRequested) header
194: .readAsJAXB(unmarshaller);
195:
196: message.setAckRequestedElement(el);
197: String id = null;
198: InboundSequence seq = null;
199: if (el instanceof com.sun.xml.ws.rm.v200502.AckRequestedElement) {
200: id = ((com.sun.xml.ws.rm.v200502.AckRequestedElement) el)
201: .getId();
202: seq = provider.getInboundSequence(id);
203:
204: if (seq != null) {
205: seq.handleAckRequested(
206: (AckRequestedElement) el, marshaller);
207: }
208:
209: } else {
210: id = ((com.sun.xml.ws.rm.v200702.AckRequestedElement) el)
211: .getId();
212: seq = provider.getInboundSequence(id);
213:
214: if (seq != null) {
215: seq
216: .handleAckRequested(
217: (com.sun.xml.ws.rm.v200702.AckRequestedElement) el,
218: marshaller);
219: }
220:
221: }
222: ;
223:
224: } else {
225: //FIXME - We need to be checking whether this is a ServerInboundSequence
226: //in a port with a two-way operation. This is the case where MS
227: //puts a SequenceAcknowledgement on every message.
228:
229: //Need to check this with the latest CTP
230: //Currently with Dec CTP the client message
231: //does not have AckRequested element
232: // but they are expecting a SequenceAcknowledgement
233: //Hack for now
234:
235: if (inseq != null) {
236:
237: inseq.handleAckRequested(null, marshaller);
238: } else {
239: //we can get here if there is no sequence header. Perhaps this
240: //is a ClientInboundSequence where the OutboundSequence has no two-ways
241: }
242:
243: }
244:
245: } catch (JAXBException e) {
246: throw new RMException(e);
247: }
248: }
249:
250: }
|