diff -r 88b85470e72c -r f50545b5e2f1 src/share/jaxws_classes/com/sun/xml/internal/ws/client/ResponseContext.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/client/ResponseContext.java Tue Mar 06 16:09:35 2012 -0800 @@ -0,0 +1,163 @@ +/* + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package com.sun.xml.internal.ws.client; + +import com.sun.xml.internal.ws.api.message.Packet; +import com.sun.xml.internal.ws.api.message.AttachmentSet; +import com.sun.xml.internal.ws.api.message.Attachment; + +import javax.xml.ws.handler.MessageContext; +import javax.activation.DataHandler; +import java.util.AbstractMap; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; + +/** + * Implements "response context" on top of {@link Packet}. + * + *

+ * This class creates a read-only {@link Map} view that + * gets exposed to client applications after an invocation + * is complete. + * + *

+ * The design goal of this class is to make it efficient + * to create a new {@link ResponseContext}, at the expense + * of making some {@link Map} operations slower. This is + * justified because the response context is mostly just + * used to query a few known values, and operations like + * enumeration isn't likely. + * + *

+ * Some of the {@link Map} methods requre this class to + * build the complete {@link Set} of properties, but we + * try to avoid that as much as possible. + * + * + *

+ * TODO: are we exposing all strongly-typed fields, or
+ * do they have appliation/handler scope notion?
+ * 
+ * + * @author Kohsuke Kawaguchi + */ +@SuppressWarnings({"SuspiciousMethodCalls"}) // IDE doesn't like me calling Map methods with key typed as Object +public class ResponseContext extends AbstractMap { + private final Packet packet; + + /** + * Lazily computed. + */ + private Set> entrySet; + + /** + * @param packet + * The {@link Packet} to wrap. + */ + public ResponseContext(Packet packet) { + this.packet = packet; + } + + public boolean containsKey(Object key) { + if(packet.supports(key)) + return packet.containsKey(key); // strongly typed + + if(packet.invocationProperties.containsKey(key)) + // if handler-scope, hide it + return !packet.getHandlerScopePropertyNames(true).contains(key); + + return false; + } + + public Object get(Object key) { + if(packet.supports(key)) + return packet.get(key); // strongly typed + + if(packet.getHandlerScopePropertyNames(true).contains(key)) + return null; // no such application-scope property + + Object value = packet.invocationProperties.get(key); + + //add the attachments from the Message to the corresponding attachment property + if(key.equals(MessageContext.INBOUND_MESSAGE_ATTACHMENTS)){ + Map atts = (Map) value; + if(atts == null) + atts = new HashMap(); + AttachmentSet attSet = packet.getMessage().getAttachments(); + for(Attachment att : attSet){ + atts.put(att.getContentId(), att.asDataHandler()); + } + return atts; + } + return value; + } + + public Object put(String key, Object value) { + // response context is read-only + throw new UnsupportedOperationException(); + } + + public Object remove(Object key) { + // response context is read-only + throw new UnsupportedOperationException(); + } + + public void putAll(Map t) { + // response context is read-only + throw new UnsupportedOperationException(); + } + + public void clear() { + // response context is read-only + throw new UnsupportedOperationException(); + } + + public Set> entrySet() { + if(entrySet==null) { + // this is where the worst case happens. we have to clone the whole properties + // to get this view. + + // use TreeSet so that toString() sort them nicely. It's easier for apps. + Map r = new HashMap(); + + // export application-scope properties + r.putAll(packet.invocationProperties); + + // hide handler-scope properties + r.keySet().removeAll(packet.getHandlerScopePropertyNames(true)); + + // and all strongly typed ones + r.putAll(packet.createMapView()); + + entrySet = Collections.unmodifiableSet(r.entrySet()); + } + + return entrySet; + } + +}