/*
* Copyright (c) 2010, 2019 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.server.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.Locale;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.jersey.internal.inject.InjectionManager;
import org.glassfish.jersey.internal.inject.Injections;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.server.wadl.WadlGenerator;
import org.glassfish.jersey.server.wadl.internal.generators.WadlGeneratorJAXBGrammarGenerator;
Loads WadlGenerator
s from a provided list of WadlGeneratorDescription
s.
The properties of the WadlGeneratorDescription
s can refer to WadlGenerator
properties of these types:
- exact match: if the WadlGenerator property is of type
org.example.Foo
and the property value provided by the WadlGeneratorDescription
is of type org.example.Foo
- java.io.InputStream: The
InputStream
can e.g. represent a file. The stream is loaded from the property value (provided by the WadlGeneratorDescription
) via ClassLoader.getResourceAsStream(String)
or via OSGi API means if OSGi runtime is detected. The stream will be closed after 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
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 (martin.grotzke at freiheit.com)
/**
* Loads {@link WadlGenerator}s from a provided list of {@link WadlGeneratorDescription}s.<br/>
* The properties of the {@link WadlGeneratorDescription}s can refer to {@link WadlGenerator} properties
* of these types:
* <ul>
*
* <li>exact match: if the WadlGenerator property is of type <code>org.example.Foo</code> and the
* property value provided by the {@link WadlGeneratorDescription} is of type <code>org.example.Foo</code></li>
*
* <li>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)} or via OSGi API means if OSGi runtime is detected.
* The stream will be closed after {@link WadlGenerator#init()} was called.
* </li>
*
* <li>Types that provide a constructor for the provided type (mostly java.lang.String)</li>
*
* <li><strong>Deprecated, will be removed in future versions from the {@link WadlGeneratorLoader}:</strong><br/>
* java.lang.File: The property value can contain the prefix <em>classpath:</em> to denote, that the
* path to the file is relative to the classpath. In this case, the property value is stripped by
* the prefix <em>classpath:</em> and the java.lang.File is created via
* <pre><code>new File( generator.getClass().getResource( strippedFilename ).toURI() )</code></pre></li>
*
* </ul>
*
* @author Martin Grotzke (martin.grotzke at freiheit.com)
*/
class WadlGeneratorLoader {
private static final Logger LOGGER = Logger.getLogger(WadlGeneratorLoader.class.getName());
static WadlGenerator loadWadlGenerators(
List<WadlGenerator> 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(InjectionManager injectionManager,
WadlGeneratorDescription... wadlGeneratorDescriptions) throws Exception {
final List<WadlGeneratorDescription> list = wadlGeneratorDescriptions != null
? Arrays.asList(wadlGeneratorDescriptions) : null;
return loadWadlGeneratorDescriptions(injectionManager, list);
}
static WadlGenerator loadWadlGeneratorDescriptions(InjectionManager injectionManager,
List<WadlGeneratorDescription> 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(injectionManager, wadlGeneratorDescription,
wadlGenerator);
wadlGenerator = control.wadlGenerator;
callbacks.add(control.callback);
}
}
wadlGenerator.init();
} finally {
callbacks.callback();
}
return wadlGenerator;
}
private static WadlGeneratorControl loadWadlGenerator(InjectionManager injectionManager,
WadlGeneratorDescription wadlGeneratorDescription,
WadlGenerator wadlGeneratorDelegate) throws Exception {
LOGGER.info("Loading wadlGenerator " + wadlGeneratorDescription.getGeneratorClass().getName());
final WadlGenerator generator = Injections.getOrCreate(injectionManager, wadlGeneratorDescription.getGeneratorClass());
generator.setWadlGeneratorDelegate(wadlGeneratorDelegate);
CallbackList callbacks = null;
if (wadlGeneratorDescription.getProperties() != null
&& !wadlGeneratorDescription.getProperties().isEmpty()) {
callbacks = new CallbackList();
final Properties wadlGeneratorProperties = wadlGeneratorDescription.getProperties();
Class<?> osgiConfiguratorClass = wadlGeneratorDescription.getConfiguratorClass();
for (Entry<Object, Object> entry : wadlGeneratorProperties.entrySet()) {
final Callback callback = setProperty(generator, entry.getKey().toString(), entry.getValue(),
osgiConfiguratorClass);
callbacks.add(callback);
}
}
return new WadlGeneratorControl(generator, callbacks);
}
Set the object (generator) property with the given name to the specified value.
Params: - generator – the object, on which the property shall be set
- propertyName – the name of the property, that shall be set
- propertyValue – the value to populate the property with
Throws: - Exception – if s.th. goes wrong
Returns: a Callback
object that must be called later, or null if no callback is required.
/**
* 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,
final Class<?> osgiConfigClass) throws Exception {
Callback result = null;
final String methodName = "set" + propertyName.substring(0, 1).toUpperCase(Locale.ROOT) + propertyName.substring(1);
final Method method = getMethodByName(methodName, generator.getClass());
if (method.getParameterTypes().length != 1) {
throw new RuntimeException(
"Method " + methodName + " is no setter, it does not expect exactly one parameter, but "
+ method.getParameterTypes().length);
}
final Class<?> paramClazz = method.getParameterTypes()[0];
if (paramClazz.isAssignableFrom(propertyValue.getClass())) {
method.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 " + method.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());
method.invoke(generator, file);
} else {
method.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 = ReflectionHelper.getResourceAsStream(loader, osgiConfigClass, resource);
if (is == null) {
String message = "The resource '" + resource + "' does not exist.";
throw new RuntimeException(message);
}
result = new Callback() {
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 {
method.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);
method.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.
Params: - wadlGenerator – the generator, must not be null
- callback – the callback, can be null
/**
* 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<Callback> implements Callback {
private static final long serialVersionUID = 1L;
Callback all registered Callback
items. /**
* Callback all registered {@link Callback} items.
*/
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.
Params: - e – the element to append, can be null.
Returns: true if the element was appended to the list, otherwise null.
/**
* 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;
}
}
}