ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.addressing.model;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: import com.sun.xml.internal.ws.api.message.Packet;
ohair@286: import com.sun.xml.internal.ws.resources.AddressingMessages;
ohair@286: 
ohair@286: import javax.xml.ws.WebServiceException;
ohair@286: import javax.xml.namespace.QName;
ohair@286: 
ohair@286: /**
ohair@286:  * This exception signals that a particular WS-Addressing header is missing in a SOAP message.
ohair@286:  *
ohair@286:  * @author Rama Pulavarthi
ohair@286:  */
ohair@286: public class MissingAddressingHeaderException extends WebServiceException {
ohair@286:     private final QName name;
ohair@286:     private transient final Packet packet;
ohair@286: 
ohair@286:     /**
ohair@286:      *
ohair@286:      * @param name QName of the missing WS-Addressing Header
ohair@286:      */
ohair@286:     public MissingAddressingHeaderException(@NotNull QName name) {
ohair@286:         this(name,null);
ohair@286:     }
ohair@286: 
ohair@286:     public MissingAddressingHeaderException(@NotNull QName name, @Nullable Packet p) {
ohair@286:         super(AddressingMessages.MISSING_HEADER_EXCEPTION(name));
ohair@286:         this.name = name;
ohair@286:         this.packet = p;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the QName of the missing WS-Addressing Header.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      never null.
ohair@286:      */
ohair@286:     public QName getMissingHeaderQName() {
ohair@286:         return name;
ohair@286:     }
ohair@286: 
ohair@286:     /**
ohair@286:      * The {@link Packet} in which a header was missing.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * This object can be used to deep-inspect the problematic SOAP message.
ohair@286:      */
ohair@286:     public Packet getPacket() {
ohair@286:         return packet;
ohair@286:     }
ohair@286: }