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: package com.sun.xml.ws.client;
037:
038: import com.sun.xml.ws.api.message.Packet;
039: import com.sun.xml.ws.api.message.AttachmentSet;
040: import com.sun.xml.ws.api.message.Attachment;
041:
042: import javax.xml.ws.handler.MessageContext;
043: import javax.activation.DataHandler;
044: import java.util.AbstractMap;
045: import java.util.Collections;
046: import java.util.HashMap;
047: import java.util.Map;
048: import java.util.Set;
049:
050: /**
051: * Implements "response context" on top of {@link Packet}.
052: *
053: * <p>
054: * This class creates a read-only {@link Map} view that
055: * gets exposed to client applications after an invocation
056: * is complete.
057: *
058: * <p>
059: * The design goal of this class is to make it efficient
060: * to create a new {@link ResponseContext}, at the expense
061: * of making some {@link Map} operations slower. This is
062: * justified because the response context is mostly just
063: * used to query a few known values, and operations like
064: * enumeration isn't likely.
065: *
066: * <p>
067: * Some of the {@link Map} methods requre this class to
068: * build the complete {@link Set} of properties, but we
069: * try to avoid that as much as possible.
070: *
071: *
072: * <pre>
073: * TODO: are we exposing all strongly-typed fields, or
074: * do they have appliation/handler scope notion?
075: * </pre>
076: *
077: * @author Kohsuke Kawaguchi
078: */
079: @SuppressWarnings({"SuspiciousMethodCalls"})
080: // IDE doesn't like me calling Map methods with key typed as Object
081: public class ResponseContext extends AbstractMap<String, Object> {
082: private final Packet packet;
083:
084: /**
085: * Lazily computed.
086: */
087: private Set<Map.Entry<String, Object>> entrySet;
088:
089: /**
090: * @param packet
091: * The {@link Packet} to wrap.
092: */
093: public ResponseContext(Packet packet) {
094: this .packet = packet;
095: }
096:
097: public boolean containsKey(Object key) {
098: if (packet.supports(key))
099: return packet.containsKey(key); // strongly typed
100:
101: if (packet.invocationProperties.containsKey(key))
102: // if handler-scope, hide it
103: return !packet.getHandlerScopePropertyNames(true).contains(
104: key);
105:
106: return false;
107: }
108:
109: public Object get(Object key) {
110: if (packet.supports(key))
111: return packet.get(key); // strongly typed
112:
113: if (packet.getHandlerScopePropertyNames(true).contains(key))
114: return null; // no such application-scope property
115:
116: Object value = packet.invocationProperties.get(key);
117:
118: //add the attachments from the Message to the corresponding attachment property
119: if (key.equals(MessageContext.INBOUND_MESSAGE_ATTACHMENTS)) {
120: Map<String, DataHandler> atts = (Map<String, DataHandler>) value;
121: if (atts == null)
122: atts = new HashMap<String, DataHandler>();
123: AttachmentSet attSet = packet.getMessage().getAttachments();
124: for (Attachment att : attSet) {
125: atts.put(att.getContentId(), att.asDataHandler());
126: }
127: return atts;
128: }
129: return value;
130: }
131:
132: public Object put(String key, Object value) {
133: // response context is read-only
134: throw new UnsupportedOperationException();
135: }
136:
137: public Object remove(Object key) {
138: // response context is read-only
139: throw new UnsupportedOperationException();
140: }
141:
142: public void putAll(Map<? extends String, ? extends Object> t) {
143: // response context is read-only
144: throw new UnsupportedOperationException();
145: }
146:
147: public void clear() {
148: // response context is read-only
149: throw new UnsupportedOperationException();
150: }
151:
152: public Set<Entry<String, Object>> entrySet() {
153: if (entrySet == null) {
154: // this is where the worst case happens. we have to clone the whole properties
155: // to get this view.
156:
157: // use TreeSet so that toString() sort them nicely. It's easier for apps.
158: Map<String, Object> r = new HashMap<String, Object>();
159:
160: // export application-scope properties
161: r.putAll(packet.invocationProperties);
162:
163: // hide handler-scope properties
164: r.keySet().removeAll(
165: packet.getHandlerScopePropertyNames(true));
166:
167: // and all strongly typed ones
168: r.putAll(packet.createMapView());
169:
170: entrySet = Collections.unmodifiableSet(r.entrySet());
171: }
172:
173: return entrySet;
174: }
175:
176: }
|