Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.bind.v2.runtime; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import java.util.HashMap; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import javax.xml.bind.ValidationEvent; |
aoqi@0 | 31 | import javax.xml.bind.ValidationEventHandler; |
aoqi@0 | 32 | import javax.xml.bind.ValidationEventLocator; |
aoqi@0 | 33 | import javax.xml.bind.annotation.adapters.XmlAdapter; |
aoqi@0 | 34 | import javax.xml.bind.helpers.ValidationEventImpl; |
aoqi@0 | 35 | |
aoqi@0 | 36 | import com.sun.xml.internal.bind.v2.ClassFactory; |
aoqi@0 | 37 | import com.sun.xml.internal.bind.v2.runtime.unmarshaller.UnmarshallingContext; |
aoqi@0 | 38 | |
aoqi@0 | 39 | import org.xml.sax.ErrorHandler; |
aoqi@0 | 40 | import org.xml.sax.SAXException; |
aoqi@0 | 41 | import org.xml.sax.SAXParseException; |
aoqi@0 | 42 | |
aoqi@0 | 43 | /** |
aoqi@0 | 44 | * Object that coordinates the marshalling/unmarshalling. |
aoqi@0 | 45 | * |
aoqi@0 | 46 | * <p> |
aoqi@0 | 47 | * This class takes care of the logic that allows code to obtain |
aoqi@0 | 48 | * {@link UnmarshallingContext} and {@link XMLSerializer} instances |
aoqi@0 | 49 | * during the unmarshalling/marshalling. |
aoqi@0 | 50 | * |
aoqi@0 | 51 | * <p> |
aoqi@0 | 52 | * This is done by using a {@link ThreadLocal}. Therefore one unmarshalling/marshalling |
aoqi@0 | 53 | * episode has to be done from the beginning till end by the same thread. |
aoqi@0 | 54 | * (Note that the same {@link Coordinator} can be then used by a different thread |
aoqi@0 | 55 | * for an entirely different episode.) |
aoqi@0 | 56 | * |
aoqi@0 | 57 | * This class also maintains the user-configured instances of {@link XmlAdapter}s. |
aoqi@0 | 58 | * |
aoqi@0 | 59 | * <p> |
aoqi@0 | 60 | * This class implements {@link ErrorHandler} and propages erros to this object |
aoqi@0 | 61 | * as the {@link ValidationEventHandler}, which will be implemented in a derived class. |
aoqi@0 | 62 | * |
aoqi@0 | 63 | * @author Kohsuke Kawaguchi |
aoqi@0 | 64 | */ |
aoqi@0 | 65 | public abstract class Coordinator implements ErrorHandler, ValidationEventHandler { |
aoqi@0 | 66 | |
aoqi@0 | 67 | private final HashMap<Class<? extends XmlAdapter>,XmlAdapter> adapters = |
aoqi@0 | 68 | new HashMap<Class<? extends XmlAdapter>,XmlAdapter>(); |
aoqi@0 | 69 | |
aoqi@0 | 70 | |
aoqi@0 | 71 | public final XmlAdapter putAdapter(Class<? extends XmlAdapter> c, XmlAdapter a) { |
aoqi@0 | 72 | if(a==null) |
aoqi@0 | 73 | return adapters.remove(c); |
aoqi@0 | 74 | else |
aoqi@0 | 75 | return adapters.put(c,a); |
aoqi@0 | 76 | } |
aoqi@0 | 77 | |
aoqi@0 | 78 | /** |
aoqi@0 | 79 | * Gets the instance of the adapter. |
aoqi@0 | 80 | * |
aoqi@0 | 81 | * @return |
aoqi@0 | 82 | * always non-null. |
aoqi@0 | 83 | */ |
aoqi@0 | 84 | public final <T extends XmlAdapter> T getAdapter(Class<T> key) { |
aoqi@0 | 85 | T v = key.cast(adapters.get(key)); |
aoqi@0 | 86 | if(v==null) { |
aoqi@0 | 87 | v = ClassFactory.create(key); |
aoqi@0 | 88 | putAdapter(key,v); |
aoqi@0 | 89 | } |
aoqi@0 | 90 | return v; |
aoqi@0 | 91 | } |
aoqi@0 | 92 | |
aoqi@0 | 93 | public <T extends XmlAdapter> boolean containsAdapter(Class<T> type) { |
aoqi@0 | 94 | return adapters.containsKey(type); |
aoqi@0 | 95 | } |
aoqi@0 | 96 | |
aoqi@0 | 97 | // this much is necessary to avoid calling get and set twice when we push. |
aoqi@0 | 98 | private static final ThreadLocal<Coordinator> activeTable = new ThreadLocal<Coordinator>(); |
aoqi@0 | 99 | |
aoqi@0 | 100 | /** |
aoqi@0 | 101 | * The {@link Coordinator} in charge before this {@link Coordinator}. |
aoqi@0 | 102 | */ |
aoqi@0 | 103 | private Coordinator old; |
aoqi@0 | 104 | |
aoqi@0 | 105 | /** |
aoqi@0 | 106 | * Called whenever an execution flow enters the realm of this {@link Coordinator}. |
aoqi@0 | 107 | */ |
aoqi@0 | 108 | protected final void pushCoordinator() { |
aoqi@0 | 109 | old = activeTable.get(); |
aoqi@0 | 110 | activeTable.set(this); |
aoqi@0 | 111 | } |
aoqi@0 | 112 | |
aoqi@0 | 113 | /** |
aoqi@0 | 114 | * Called whenever an execution flow exits the realm of this {@link Coordinator}. |
aoqi@0 | 115 | */ |
aoqi@0 | 116 | protected final void popCoordinator() { |
aoqi@0 | 117 | if (old != null) |
aoqi@0 | 118 | activeTable.set(old); |
aoqi@0 | 119 | else |
aoqi@0 | 120 | activeTable.remove(); |
aoqi@0 | 121 | old = null; // avoid memory leak |
aoqi@0 | 122 | } |
aoqi@0 | 123 | |
aoqi@0 | 124 | public static Coordinator _getInstance() { |
aoqi@0 | 125 | return activeTable.get(); |
aoqi@0 | 126 | } |
aoqi@0 | 127 | |
aoqi@0 | 128 | // |
aoqi@0 | 129 | // |
aoqi@0 | 130 | // ErrorHandler implementation |
aoqi@0 | 131 | // |
aoqi@0 | 132 | // |
aoqi@0 | 133 | /** |
aoqi@0 | 134 | * Gets the current location. Used for reporting the error source location. |
aoqi@0 | 135 | */ |
aoqi@0 | 136 | protected abstract ValidationEventLocator getLocation(); |
aoqi@0 | 137 | |
aoqi@0 | 138 | public final void error(SAXParseException exception) throws SAXException { |
aoqi@0 | 139 | propagateEvent( ValidationEvent.ERROR, exception ); |
aoqi@0 | 140 | } |
aoqi@0 | 141 | |
aoqi@0 | 142 | public final void warning(SAXParseException exception) throws SAXException { |
aoqi@0 | 143 | propagateEvent( ValidationEvent.WARNING, exception ); |
aoqi@0 | 144 | } |
aoqi@0 | 145 | |
aoqi@0 | 146 | public final void fatalError(SAXParseException exception) throws SAXException { |
aoqi@0 | 147 | propagateEvent( ValidationEvent.FATAL_ERROR, exception ); |
aoqi@0 | 148 | } |
aoqi@0 | 149 | |
aoqi@0 | 150 | private void propagateEvent( int severity, SAXParseException saxException ) |
aoqi@0 | 151 | throws SAXException { |
aoqi@0 | 152 | |
aoqi@0 | 153 | ValidationEventImpl ve = |
aoqi@0 | 154 | new ValidationEventImpl( severity, saxException.getMessage(), getLocation() ); |
aoqi@0 | 155 | |
aoqi@0 | 156 | Exception e = saxException.getException(); |
aoqi@0 | 157 | if( e != null ) { |
aoqi@0 | 158 | ve.setLinkedException( e ); |
aoqi@0 | 159 | } else { |
aoqi@0 | 160 | ve.setLinkedException( saxException ); |
aoqi@0 | 161 | } |
aoqi@0 | 162 | |
aoqi@0 | 163 | // call the client's event handler. If it returns false, then bail-out |
aoqi@0 | 164 | // and terminate the unmarshal operation. |
aoqi@0 | 165 | boolean result = handleEvent( ve ); |
aoqi@0 | 166 | if( ! result ) { |
aoqi@0 | 167 | // bail-out of the parse with a SAX exception, but convert it into |
aoqi@0 | 168 | // an UnmarshalException back in in the AbstractUnmarshaller |
aoqi@0 | 169 | throw saxException; |
aoqi@0 | 170 | } |
aoqi@0 | 171 | } |
aoqi@0 | 172 | } |