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.tools.xjc.runtime;
038:
039: import java.util.ArrayList;
040: import java.util.List;
041: import java.util.Map;
042: import java.util.StringTokenizer;
043:
044: import javax.xml.bind.JAXBContext;
045: import javax.xml.bind.JAXBException;
046:
047: /**
048: * This class implements the actual logic of {@link JAXBContext#newInstance}.
049: *
050: * <p>
051: * This class works as a facade and all the actual work is delegated to
052: * a JAXB provider that happens to be in the runtime (not necessarily the JAXB RI.)
053: * This allows the generated code to be run with any JAXB provider.
054: *
055: * <p>
056: * This code is only used when XJC generates interfaces/implementations.
057: *
058: * <p>
059: * The trick to make this work is two ObjectFactory classes that we generate
060: * in the interface/implementation mode.
061: *
062: * <p>
063: * The public ObjectFactory follows the spec, and this is the one that's exposed
064: * to users. The public ObjectFactory refers to interfaces, so they aren't
065: * directly usable by a JAXB 2.0 implementation.
066: *
067: * <p>
068: * The private one lives in the impl package, and this one is indistinguishable
069: * from the ObjectFactory that we generate for the value class generation mode.
070: * This private ObjectFactory refers to implementation classes, which are
071: * also indistinguishable from value classes that JAXB generates.
072: *
073: * <p>
074: * All in all, the private ObjectFactory plus implementation classes give
075: * a JAXB provider an illusion that they are dealing with value classes
076: * that happens to implement some interfaces.
077: *
078: * <p>
079: * In this way, the JAXB RI can provide the portability even for the
080: * interface/implementation generation mode.
081: *
082: * @since 2.0
083: * @author Kohsuke Kawaguchi
084: */
085: public class JAXBContextFactory {
086: private static final String DOT_OBJECT_FACTORY = ".ObjectFactory";
087: private static final String IMPL_DOT_OBJECT_FACTORY = ".impl.ObjectFactory";
088:
089: /**
090: * The JAXB API will invoke this method via reflection
091: */
092: public static JAXBContext createContext(Class[] classes,
093: Map properties) throws JAXBException {
094: Class[] r = new Class[classes.length];
095: boolean modified = false;
096:
097: // find any reference to our 'public' ObjectFactory and
098: // replace that to our 'private' ObjectFactory.
099: for (int i = 0; i < r.length; i++) {
100: Class c = classes[i];
101: String name = c.getName();
102: if (name.endsWith(DOT_OBJECT_FACTORY)
103: && !name.endsWith(IMPL_DOT_OBJECT_FACTORY)) {
104: // we never generate into the root package, so no need to worry about FQCN "ObjectFactory"
105:
106: // if we find one, tell the real JAXB provider to
107: // load foo.bar.impl.ObjectFactory
108: name = name.substring(0, name.length()
109: - DOT_OBJECT_FACTORY.length())
110: + IMPL_DOT_OBJECT_FACTORY;
111:
112: try {
113: c = c.getClassLoader().loadClass(name);
114: } catch (ClassNotFoundException e) {
115: throw new JAXBException(e);
116: }
117:
118: modified = true;
119: }
120:
121: r[i] = c;
122: }
123:
124: if (!modified) {
125: // if the class list doesn't contain any of our classes,
126: // this ContextFactory shouldn't have been called in the first place
127: // if we simply continue, we'll just end up with the infinite recursion.
128:
129: // the only case that I can think of where this could happen is
130: // when the user puts additional classes into the JAXB-generated
131: // package and pass them to JAXBContext.newInstance().
132: // Under normal use, this shouldn't happen.
133:
134: // anyway, bail out now.
135: // if you hit this problem and wondering how to get around the problem,
136: // subscribe and send a note to users@jaxb.dev.java.net (http://jaxb.dev.java.net/)
137: throw new JAXBException(
138: "Unable to find a JAXB implementation to delegate");
139: }
140:
141: // delegate to the JAXB provider in the system
142: return JAXBContext.newInstance(r, properties);
143: }
144:
145: /**
146: * The JAXB API will invoke this method via reflection
147: */
148: public static JAXBContext createContext(String contextPath,
149: ClassLoader classLoader, Map properties)
150: throws JAXBException {
151:
152: List<Class> classes = new ArrayList<Class>();
153: StringTokenizer tokens = new StringTokenizer(contextPath, ":");
154:
155: // each package should be pointing to a JAXB RI generated
156: // content interface package.
157: //
158: // translate them into a list of private ObjectFactories.
159: try {
160: while (tokens.hasMoreTokens()) {
161: String pkg = tokens.nextToken();
162: classes.add(classLoader.loadClass(pkg
163: + IMPL_DOT_OBJECT_FACTORY));
164: }
165: } catch (ClassNotFoundException e) {
166: throw new JAXBException(e);
167: }
168:
169: // delegate to the JAXB provider in the system
170: return JAXBContext.newInstance(classes
171: .toArray(new Class[classes.size()]), properties);
172: }
173: }
|