/*
* Copyright (c) 2005, 2006, 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.addressing;
import com.sun.istack.internal.NotNull;
import com.sun.xml.internal.ws.api.PropertySet;
import com.sun.xml.internal.ws.api.SOAPVersion;
import com.sun.xml.internal.ws.api.addressing.AddressingVersion;
import com.sun.xml.internal.ws.api.addressing.WSEndpointReference;
import com.sun.xml.internal.ws.api.message.Header;
import com.sun.xml.internal.ws.api.message.Message;
import com.sun.xml.internal.ws.api.message.Packet;
import com.sun.xml.internal.ws.developer.JAXWSProperties;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
/**
* Provides access to the Addressing headers.
*
* @author Kohsuke Kawaguchi
* @author Rama Pulavarthi
* @since 2.1.3
*/
public class WsaPropertyBag extends PropertySet {
private final @NotNull AddressingVersion addressingVersion;
private final @NotNull SOAPVersion soapVersion;
/**
* We can't store {@link Message} here as those may get replaced as
* the packet travels through the pipeline.
*/
private final @NotNull Packet packet;
WsaPropertyBag(AddressingVersion addressingVersion, SOAPVersion soapVersion, Packet packet) {
this.addressingVersion = addressingVersion;
this.soapVersion = soapVersion;
this.packet = packet;
}
/**
* Gets the <tt>wsa:To</tt> header.
*
* @return
* null if the incoming SOAP message didn't have the header.
*/
@Property(JAXWSProperties.ADDRESSING_TO)
public String getTo() throws XMLStreamException {
Header h = packet.getMessage().getHeaders().get(addressingVersion.toTag, false);
if (h == null) return null;
return h.getStringContent();
}
/**
* Gets the <tt>wsa:From</tt> header.
*
* @return
* null if the incoming SOAP message didn't have the header.
*/
@Property(JAXWSProperties.ADDRESSING_FROM)
public WSEndpointReference getFrom() throws XMLStreamException {
return getEPR(addressingVersion.fromTag);
}
/**
* Gets the <tt>wsa:Action</tt> header content as String.
*
* @return
* null if the incoming SOAP message didn't have the header.
*/
@Property(JAXWSProperties.ADDRESSING_ACTION)
public String getAction() {
Header h = packet.getMessage().getHeaders().get(addressingVersion.actionTag, false);
if(h==null) return null;
return h.getStringContent();
}
/**
* Gets the <tt>wsa:MessageID</tt> header content as String.
*
* @return
* null if the incoming SOAP message didn't have the header.
*/
// WsaServerTube.REQUEST_MESSAGE_ID is exposed for backward compatibility with 2.1
@Property({JAXWSProperties.ADDRESSING_MESSAGEID,WsaServerTube.REQUEST_MESSAGE_ID})
public String getMessageID() {
return packet.getMessage().getHeaders().getMessageID(addressingVersion,soapVersion);
}
private WSEndpointReference getEPR(QName tag) throws XMLStreamException {
Header h = packet.getMessage().getHeaders().get(tag, false);
if(h==null) return null;
return h.readAsEPR(addressingVersion);
}
protected PropertyMap getPropertyMap() {
return model;
}
private static final PropertyMap model;
static {
model = parse(WsaPropertyBag.class);
}
}