com.sun.jersey.api.wadl.config.WadlGeneratorLoader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation
Show all versions of ehcache Show documentation
Ehcache is an open source, standards-based cache used to boost performance,
offload the database and simplify scalability. Ehcache is robust, proven and full-featured and
this has made it the most widely-used Java-based cache.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.jersey.api.wadl.config;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map.Entry;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.sun.jersey.server.wadl.WadlGenerator;
import com.sun.jersey.server.wadl.generators.WadlGeneratorJAXBGrammarGenerator;
/**
* Loads {@link WadlGenerator}s from a provided list of {@link WadlGeneratorDescription}s.
* The properties of the {@link WadlGeneratorDescription}s can refer to {@link WadlGenerator} properties
* of these types:
*
*
* - exact match: if the WadlGenerator property is of type
org.example.Foo and the
* property value provided by the {@link WadlGeneratorDescription} is of type org.example.Foo
*
* - java.io.InputStream: The {@link InputStream} can e.g. represent a file. The stream is loaded from the
* property value (provided by the {@link WadlGeneratorDescription}) via
* {@link ClassLoader#getResourceAsStream(String)}. It will be closed after {@link WadlGenerator#init()} was called.
*
*
* - Types that provide a constructor for the provided type (mostly java.lang.String)
*
* - Deprecated, will be removed in future versions from the {@link WadlGeneratorLoader}:
* java.lang.File: The property value can contain the prefix classpath: to denote, that the
* path to the file is relative to the classpath. In this case, the property value is stripped by
* the prefix classpath: and the java.lang.File is created via
* new File( generator.getClass().getResource( strippedFilename ).toURI() )
*
*
*
* @author Martin Grotzke
* @version $Id: WadlGeneratorLoader.java 5797 2012-10-24 13:18:31Z japod $
*/
class WadlGeneratorLoader {
private static final Logger LOGGER = Logger.getLogger(WadlGeneratorLoader.class.getName());
static WadlGenerator loadWadlGenerators(
List wadlGenerators) throws Exception {
WadlGenerator wadlGenerator = new WadlGeneratorJAXBGrammarGenerator();
if (wadlGenerators != null && !wadlGenerators.isEmpty()) {
for (WadlGenerator generator : wadlGenerators) {
generator.setWadlGeneratorDelegate(wadlGenerator);
wadlGenerator = generator;
}
}
wadlGenerator.init();
return wadlGenerator;
}
static WadlGenerator loadWadlGeneratorDescriptions(WadlGeneratorDescription... wadlGeneratorDescriptions) throws Exception {
final List list = wadlGeneratorDescriptions != null ? Arrays.asList(wadlGeneratorDescriptions) : null;
return loadWadlGeneratorDescriptions(list);
}
static WadlGenerator loadWadlGeneratorDescriptions(List wadlGeneratorDescriptions) throws Exception {
WadlGenerator wadlGenerator = new WadlGeneratorJAXBGrammarGenerator();
final CallbackList callbacks = new CallbackList();
try {
if (wadlGeneratorDescriptions != null && !wadlGeneratorDescriptions.isEmpty()) {
for (WadlGeneratorDescription wadlGeneratorDescription : wadlGeneratorDescriptions) {
final WadlGeneratorControl control = loadWadlGenerator(wadlGeneratorDescription, wadlGenerator);
wadlGenerator = control.wadlGenerator;
callbacks.add(control.callback);
}
}
wadlGenerator.init();
} finally {
callbacks.callback();
}
return wadlGenerator;
}
private static WadlGeneratorControl loadWadlGenerator(
WadlGeneratorDescription wadlGeneratorDescription,
com.sun.jersey.server.wadl.WadlGenerator wadlGeneratorDelegate) throws Exception {
LOGGER.info("Loading wadlGenerator " + wadlGeneratorDescription.getGeneratorClass().getName());
final WadlGenerator generator = wadlGeneratorDescription.getGeneratorClass().newInstance();
generator.setWadlGeneratorDelegate(wadlGeneratorDelegate);
CallbackList callbacks = null;
if (wadlGeneratorDescription.getProperties() != null
&& !wadlGeneratorDescription.getProperties().isEmpty()) {
callbacks = new CallbackList();
for (Entry entry : wadlGeneratorDescription.getProperties().entrySet()) {
final Callback callback = setProperty(generator, entry.getKey().toString(), entry.getValue());
callbacks.add(callback);
}
}
return new WadlGeneratorControl(generator, callbacks);
}
/**
* Set the object (generator) property with the given name to the specified value.
* @param generator the object, on which the property shall be set
* @param propertyName the name of the property, that shall be set
* @param propertyValue the value to populate the property with
* @return a {@link Callback} object that must be called later, or null if no callback is required.
* @throws Exception if s.th. goes wrong
*/
private static Callback setProperty(final Object generator, final String propertyName, final Object propertyValue)
throws Exception {
Callback result = null;
final String methodName = "set" + propertyName.substring(0, 1).toUpperCase() + propertyName.substring(1);
final Method setterMethod = getMethodByName(methodName, generator.getClass());
if (setterMethod.getParameterTypes().length != 1) {
throw new RuntimeException("Method " + methodName + " is not a setter, it does not expect exactly one parameter, but " + setterMethod.getParameterTypes().length);
}
final Class paramClazz = setterMethod.getParameterTypes()[0];
if (paramClazz.isAssignableFrom(propertyValue.getClass())) {
setterMethod.invoke(generator, propertyValue);
} else if (File.class.equals(paramClazz) && propertyValue instanceof String) {
/* This is now deprecated and can be removed in future versions.
* It's being replaced by the InputStream support, which must be used in
* a JEE environment instead of files.
*/
LOGGER.warning("Configuring the " + setterMethod.getDeclaringClass().getSimpleName()
+ " with the file based property " + propertyName + " is deprecated and will be removed"
+ " in future versions of jersey! You should use the InputStream based property instead.");
final String filename = propertyValue.toString();
if (filename.startsWith("classpath:")) {
final String strippedFilename = filename.substring("classpath:".length());
final URL resource = generator.getClass().getResource(strippedFilename);
if (resource == null) {
throw new RuntimeException("The file '" + strippedFilename + "' does not exist in the classpath."
+ " It's loaded by the generator class, so if you use a relative filename it's relative to"
+ " the generator class, otherwise you might want to load it via an absolute classpath reference like"
+ " classpath:/somefile.xml");
}
final File file = new File(resource.toURI());
setterMethod.invoke(generator, file);
} else {
setterMethod.invoke(generator, new File(filename));
}
} else if (InputStream.class.equals(paramClazz) && propertyValue instanceof String) {
final String resource = propertyValue.toString();
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if (loader == null) {
loader = WadlGeneratorLoader.class.getClassLoader();
}
final InputStream is = loader.getResourceAsStream(resource);
if (is == null) {
String message = "The resource '" + resource + "' does not exist.";
throw new RuntimeException(message);
}
result = new Callback() {
@Override
public void callback() {
try {
is.close();
} catch (IOException e) {
LOGGER.log(Level.WARNING, "Could not close InputStream from resource " + resource, e);
}
}
};
/* if the method invocation fails we need to close the input stream
* by ourselves...
*/
try {
setterMethod.invoke(generator, is);
} catch (Exception e) {
is.close();
throw e;
}
} else {
/* does the param class provide a constructor for string?
*/
final Constructor paramTypeConstructor = paramClazz.getConstructor(propertyValue.getClass());
if (paramTypeConstructor != null) {
final Object typedPropertyValue = paramTypeConstructor.newInstance(propertyValue);
setterMethod.invoke(generator, typedPropertyValue);
} else {
throw new RuntimeException("The property '" + propertyName + "' could not be set"
+ " because the expected parameter is neither of type " + propertyValue.getClass()
+ " nor of any type that provides a constructor expecting a " + propertyValue.getClass() + "."
+ " The expected parameter is of type " + paramClazz.getName());
}
}
return result;
}
private static Method getMethodByName(final String methodName, final Class clazz) {
for (Method method : clazz.getMethods()) {
if (method.getName().equals(methodName)) {
return method;
}
}
throw new RuntimeException("Method '" + methodName + "' not found for class " + clazz.getName());
}
private static class WadlGeneratorControl {
WadlGenerator wadlGenerator;
Callback callback;
/**
* The constructor.
* @param wadlGenerator the generator, must not be null
* @param callback the callback, can be null
*/
public WadlGeneratorControl(WadlGenerator wadlGenerator,
Callback callback) {
this.wadlGenerator = wadlGenerator;
this.callback = callback;
}
}
private static interface Callback {
void callback();
}
private static class CallbackList extends ArrayList implements Callback {
private static final long serialVersionUID = 1L;
/**
* Callback all registered {@link Callback} items.
*/
@Override
public void callback() {
for (Callback callback : this) {
callback.callback();
}
}
/**
* Appends the specified element to the end of the list, if the element is not null.
*
* @param e the element to append, can be null.
* @return true if the element was appended to the list, otherwise null.
*/
@Override
public boolean add(Callback e) {
return e != null ? super.add(e) : false;
}
}
}