org.glassfish.jersey.server.wadl.config.WadlGeneratorDescription Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation
Show all versions of jaxrs-ri Show documentation
A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle
(jaxrs-ri.jar).
Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and
contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external
RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source
bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external
RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI
sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from
the command line.
/*
* Copyright (c) 2010, 2018 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.InputStream;
import java.util.Properties;
import org.glassfish.jersey.server.wadl.WadlGenerator;
/**
* This is the model for the definition of wadl generators via configuration properties.
* The properties refer to the properties of the {@link WadlGenerator} implementation with
* the specified {@link WadlGeneratorDescription#getGeneratorClass()}. The {@link WadlGenerator} properties
* are populated with the provided properties like this:
*
* - The types match exactly:
if the WadlGenerator property is of type org.example.Foo
and the
* provided property value is of type org.example.Foo
* - Types that provide a constructor for the provided type (mostly java.lang.String)
* - The WadlGenerator property is of type {@link InputStream}: 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.
*
*
* - Deprecated, will be removed in future versions:
* The WadlGenerator property is of type {@link File} and the provided property value is a {@link String}:
* the provided 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 {@link File} is created via
* new File( generator.getClass().getResource( strippedFilename ).toURI() )
* Notice that the filename is loaded from the classpath in this case, e.g. classpath:test.xml
* refers to a file in the package of the class ({@link WadlGeneratorDescription#getGeneratorClass()}). The
* file reference classpath:/test.xml refers to a file that is in the root of the classpath.
*
*
*
*
* @author Martin Grotzke (martin.grotzke at freiheit.com)
*/
public class WadlGeneratorDescription {
private Class generatorClass;
private Properties properties;
private Class configuratorClass;
public WadlGeneratorDescription() {
}
public WadlGeneratorDescription(Class generatorClass, Properties properties) {
this.generatorClass = generatorClass;
this.properties = properties;
}
/**
* @return the generatorClass
*/
public Class getGeneratorClass() {
return generatorClass;
}
/**
* @param generatorClass the generatorClass to set
*/
public void setGeneratorClass(Class generatorClass) {
this.generatorClass = generatorClass;
}
/**
* @return the properties
*/
public Properties getProperties() {
return properties;
}
/**
* @param properties the properties to set
*/
public void setProperties(Properties properties) {
this.properties = properties;
}
/**
* Return {@link WadlGeneratorConfig} that was used to produce current description instance.
* The result could be null if the config was not set on this instance.
*
* @return config
*/
public Class getConfiguratorClass() {
return configuratorClass;
}
/**
* Set {@link WadlGeneratorConfig} class to be associated with current instance.
*
* @param configuratorClass
*/
void setConfiguratorClass(Class configuratorClass) {
this.configuratorClass = configuratorClass;
}
}