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

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

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

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

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