001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.util.exception;
038:
039: import com.sun.istack.NotNull;
040: import com.sun.xml.ws.resources.UtilMessages;
041: import org.xml.sax.Locator;
042: import org.xml.sax.helpers.LocatorImpl;
043:
044: import javax.xml.stream.Location;
045: import javax.xml.stream.XMLStreamReader;
046: import javax.xml.ws.WebServiceException;
047: import java.util.Arrays;
048: import java.util.List;
049:
050: /**
051: * {@link WebServiceException} with source location informaiton.
052: *
053: * <p>
054: * This exception should be used wherever the location information is available,
055: * so that the location information is carried forward to users (to assist
056: * error diagnostics.)
057: *
058: * @author Kohsuke Kawaguchi
059: */
060: public class LocatableWebServiceException extends WebServiceException {
061: /**
062: * Locations related to error.
063: */
064: private final Locator[] location;
065:
066: public LocatableWebServiceException(String message,
067: Locator... location) {
068: this (message, null, location);
069: }
070:
071: public LocatableWebServiceException(String message,
072: Throwable cause, Locator... location) {
073: super (appendLocationInfo(message, location), cause);
074: this .location = location;
075: }
076:
077: public LocatableWebServiceException(Throwable cause,
078: Locator... location) {
079: this (cause.toString(), cause, location);
080: }
081:
082: public LocatableWebServiceException(String message,
083: XMLStreamReader locationSource) {
084: this (message, toLocation(locationSource));
085: }
086:
087: public LocatableWebServiceException(String message,
088: Throwable cause, XMLStreamReader locationSource) {
089: this (message, cause, toLocation(locationSource));
090: }
091:
092: public LocatableWebServiceException(Throwable cause,
093: XMLStreamReader locationSource) {
094: this (cause, toLocation(locationSource));
095: }
096:
097: /**
098: * Locations related to this exception.
099: *
100: * @return
101: * Can be empty but never null.
102: */
103: public @NotNull
104: List<Locator> getLocation() {
105: return Arrays.asList(location);
106: }
107:
108: private static String appendLocationInfo(String message,
109: Locator[] location) {
110: StringBuilder buf = new StringBuilder(message);
111: for (Locator loc : location)
112: buf.append('\n').append(
113: UtilMessages.UTIL_LOCATION(loc.getLineNumber(), loc
114: .getSystemId()));
115: return buf.toString();
116: }
117:
118: private static Locator toLocation(XMLStreamReader xsr) {
119: LocatorImpl loc = new LocatorImpl();
120: Location in = xsr.getLocation();
121: loc.setSystemId(in.getSystemId());
122: loc.setPublicId(in.getPublicId());
123: loc.setLineNumber(in.getLineNumber());
124: loc.setColumnNumber(in.getColumnNumber());
125: return loc;
126: }
127: }
|