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.util.exception;
aoqi@0: 
aoqi@0: import com.sun.istack.internal.NotNull;
aoqi@0: import com.sun.xml.internal.ws.resources.UtilMessages;
aoqi@0: import org.xml.sax.Locator;
aoqi@0: import org.xml.sax.helpers.LocatorImpl;
aoqi@0: 
aoqi@0: import javax.xml.stream.Location;
aoqi@0: import javax.xml.stream.XMLStreamReader;
aoqi@0: import javax.xml.ws.WebServiceException;
aoqi@0: import java.util.Arrays;
aoqi@0: import java.util.List;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * {@link WebServiceException} with source location informaiton.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This exception should be used wherever the location information is available,
aoqi@0:  * so that the location information is carried forward to users (to assist
aoqi@0:  * error diagnostics.)
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public class LocatableWebServiceException extends WebServiceException {
aoqi@0:     /**
aoqi@0:      * Locations related to error.
aoqi@0:      */
aoqi@0:     private final Locator[] location;
aoqi@0: 
aoqi@0:     public LocatableWebServiceException(String message, Locator... location) {
aoqi@0:         this(message,null,location);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public LocatableWebServiceException(String message, Throwable cause, Locator... location) {
aoqi@0:         super(appendLocationInfo(message,location), cause);
aoqi@0:         this.location = location;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public LocatableWebServiceException(Throwable cause, Locator... location) {
aoqi@0:         this(cause.toString(),cause,location);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public LocatableWebServiceException(String message, XMLStreamReader locationSource) {
aoqi@0:         this(message,toLocation(locationSource));
aoqi@0:     }
aoqi@0: 
aoqi@0:     public LocatableWebServiceException(String message, Throwable cause, XMLStreamReader locationSource) {
aoqi@0:         this(message,cause,toLocation(locationSource));
aoqi@0:     }
aoqi@0: 
aoqi@0:     public LocatableWebServiceException(Throwable cause, XMLStreamReader locationSource) {
aoqi@0:         this(cause,toLocation(locationSource));
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Locations related to this exception.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      Can be empty but never null.
aoqi@0:      */
aoqi@0:     public @NotNull List<Locator> getLocation() {
aoqi@0:         return Arrays.asList(location);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static String appendLocationInfo(String message, Locator[] location) {
aoqi@0:         StringBuilder buf = new StringBuilder(message);
aoqi@0:         for( Locator loc : location )
aoqi@0:             buf.append('\n').append(UtilMessages.UTIL_LOCATION( loc.getLineNumber(), loc.getSystemId() ));
aoqi@0:         return buf.toString();
aoqi@0:     }
aoqi@0: 
aoqi@0:     private static Locator toLocation(XMLStreamReader xsr) {
aoqi@0:         LocatorImpl loc = new LocatorImpl();
aoqi@0:         Location in = xsr.getLocation();
aoqi@0:         loc.setSystemId(in.getSystemId());
aoqi@0:         loc.setPublicId(in.getPublicId());
aoqi@0:         loc.setLineNumber(in.getLineNumber());
aoqi@0:         loc.setColumnNumber(in.getColumnNumber());
aoqi@0:         return loc;
aoqi@0:     }
aoqi@0: }