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.fault;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.bind.marshaller.NamespacePrefixMapper;
aoqi@0: import com.sun.xml.internal.ws.developer.ServerSideException;
aoqi@0: import org.w3c.dom.Element;
aoqi@0: import org.w3c.dom.Node;
aoqi@0: 
aoqi@0: import javax.xml.bind.JAXBContext;
aoqi@0: import javax.xml.bind.JAXBException;
aoqi@0: import javax.xml.bind.Marshaller;
aoqi@0: import javax.xml.bind.PropertyException;
aoqi@0: import javax.xml.bind.annotation.XmlAttribute;
aoqi@0: import javax.xml.bind.annotation.XmlElement;
aoqi@0: import javax.xml.bind.annotation.XmlElementWrapper;
aoqi@0: import javax.xml.bind.annotation.XmlRootElement;
aoqi@0: import java.util.ArrayList;
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * JAXB-bound bean that captures the exception and its call stack.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This is used to capture the stack trace of the server side error and
aoqi@0:  * send that over to the client.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: @XmlRootElement(namespace=ExceptionBean.NS,name=ExceptionBean.LOCAL_NAME)
aoqi@0: final class ExceptionBean {
aoqi@0:     /**
aoqi@0:      * Converts the given {@link Throwable} into an XML representation
aoqi@0:      * and put that as a DOM tree under the given node.
aoqi@0:      */
aoqi@0:     public static void marshal( Throwable t, Node parent ) throws JAXBException {
aoqi@0:         Marshaller m = JAXB_CONTEXT.createMarshaller();
aoqi@0:         try {
aoqi@0:                 m.setProperty("com.sun.xml.internal.bind.namespacePrefixMapper",nsp);
aoqi@0:         } catch (PropertyException pe) {}
aoqi@0:         m.marshal(new ExceptionBean(t), parent );
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Does the reverse operation of {@link #marshal(Throwable, Node)}. Constructs an
aoqi@0:      * {@link Exception} object from the XML.
aoqi@0:      */
aoqi@0:     public static ServerSideException unmarshal( Node xml ) throws JAXBException {
aoqi@0:         ExceptionBean e = (ExceptionBean) JAXB_CONTEXT.createUnmarshaller().unmarshal(xml);
aoqi@0:         return e.toException();
aoqi@0:     }
aoqi@0: 
aoqi@0:     @XmlAttribute(name="class")
aoqi@0:     public String className;
aoqi@0:     @XmlElement
aoqi@0:     public String message;
aoqi@0:     @XmlElementWrapper(namespace=NS,name="stackTrace")
aoqi@0:     @XmlElement(namespace=NS,name="frame")
aoqi@0:     public List<StackFrame> stackTrace = new ArrayList<StackFrame>();
aoqi@0:     @XmlElement(namespace=NS,name="cause")
aoqi@0:     public ExceptionBean cause;
aoqi@0: 
aoqi@0:     // so that people noticed this fragment can turn it off
aoqi@0:     @XmlAttribute
aoqi@0:     public String note = "To disable this feature, set "+SOAPFaultBuilder.CAPTURE_STACK_TRACE_PROPERTY+" system property to false";
aoqi@0: 
aoqi@0:     ExceptionBean() {// for JAXB
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates an {@link ExceptionBean} tree that represents the given {@link Throwable}.
aoqi@0:      */
aoqi@0:     private ExceptionBean(Throwable t) {
aoqi@0:         this.className = t.getClass().getName();
aoqi@0:         this.message = t.getMessage();
aoqi@0: 
aoqi@0:         for (StackTraceElement f : t.getStackTrace()) {
aoqi@0:             stackTrace.add(new StackFrame(f));
aoqi@0:         }
aoqi@0: 
aoqi@0:         Throwable cause = t.getCause();
aoqi@0:         if(t!=cause && cause!=null)
aoqi@0:             this.cause = new ExceptionBean(cause);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private ServerSideException toException() {
aoqi@0:         ServerSideException e = new ServerSideException(className,message);
aoqi@0:         if(stackTrace!=null) {
aoqi@0:             StackTraceElement[] ste = new StackTraceElement[stackTrace.size()];
aoqi@0:             for( int i=0; i<stackTrace.size(); i++ )
aoqi@0:                 ste[i] = stackTrace.get(i).toStackTraceElement();
aoqi@0:             e.setStackTrace(ste);
aoqi@0:         }
aoqi@0:         if(cause!=null)
aoqi@0:             e.initCause(cause.toException());
aoqi@0:         return e;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Captures one stack frame.
aoqi@0:      */
aoqi@0:     static final class StackFrame {
aoqi@0:         @XmlAttribute(name="class")
aoqi@0:         public String declaringClass;
aoqi@0:         @XmlAttribute(name="method")
aoqi@0:         public String methodName;
aoqi@0:         @XmlAttribute(name="file")
aoqi@0:         public String fileName;
aoqi@0:         @XmlAttribute(name="line")
aoqi@0:         public String lineNumber;
aoqi@0: 
aoqi@0:         StackFrame() {// for JAXB
aoqi@0:         }
aoqi@0: 
aoqi@0:         public StackFrame(StackTraceElement ste) {
aoqi@0:             this.declaringClass = ste.getClassName();
aoqi@0:             this.methodName = ste.getMethodName();
aoqi@0:             this.fileName = ste.getFileName();
aoqi@0:             this.lineNumber = box(ste.getLineNumber());
aoqi@0:         }
aoqi@0: 
aoqi@0:         private String box(int i) {
aoqi@0:             if(i>=0) return String.valueOf(i);
aoqi@0:             if(i==-2)   return "native";
aoqi@0:             return "unknown";
aoqi@0:         }
aoqi@0: 
aoqi@0:         private int unbox(String v) {
aoqi@0:             try {
aoqi@0:                 return Integer.parseInt(v);
aoqi@0:             } catch (NumberFormatException e) {
aoqi@0:                 if ("native".equals(v)) {
aoqi@0:                     return -2;
aoqi@0:                 }
aoqi@0:                 return -1;
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         private StackTraceElement toStackTraceElement() {
aoqi@0:             return new StackTraceElement(declaringClass,methodName,fileName,unbox(lineNumber));
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Checks if the given element is the XML representation of {@link ExceptionBean}.
aoqi@0:      */
aoqi@0:     public static boolean isStackTraceXml(Element n) {
aoqi@0:         return LOCAL_NAME.equals(n.getLocalName()) && NS.equals(n.getNamespaceURI());
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static final JAXBContext JAXB_CONTEXT;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Namespace URI.
aoqi@0:      */
aoqi@0:     /*package*/ static final String NS = "http://jax-ws.dev.java.net/";
aoqi@0: 
aoqi@0:     /*package*/ static final String LOCAL_NAME = "exception";
aoqi@0: 
aoqi@0:     static {
aoqi@0:         try {
aoqi@0:             JAXB_CONTEXT = JAXBContext.newInstance(ExceptionBean.class);
aoqi@0:         } catch (JAXBException e) {
aoqi@0:             // this must be a bug in our code
aoqi@0:             throw new Error(e);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static final NamespacePrefixMapper nsp = new NamespacePrefixMapper() {
aoqi@0:         public String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix) {
aoqi@0:             if (NS.equals(namespaceUri)) {
aoqi@0:                 return "";
aoqi@0:             }
aoqi@0:             return suggestion;
aoqi@0:         }
aoqi@0:     };
aoqi@0: }