org.glassfish.jersey.server.wadl.internal.generators.WadlGeneratorApplicationDoc Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-server Show documentation
Show all versions of jersey-server Show documentation
Jersey core server implementation
/*
* 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.internal.generators;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.List;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.inject.Provider;
import javax.xml.parsers.SAXParserFactory;
import org.glassfish.jersey.server.model.Parameter;
import org.glassfish.jersey.server.wadl.WadlGenerator;
import org.glassfish.jersey.server.wadl.internal.ApplicationDescription;
import org.glassfish.jersey.server.wadl.internal.WadlUtils;
import com.sun.research.ws.wadl.Application;
import com.sun.research.ws.wadl.Method;
import com.sun.research.ws.wadl.Param;
import com.sun.research.ws.wadl.Representation;
import com.sun.research.ws.wadl.Request;
import com.sun.research.ws.wadl.Resource;
import com.sun.research.ws.wadl.Resources;
import com.sun.research.ws.wadl.Response;
/**
* This {@link org.glassfish.jersey.server.wadl.WadlGenerator} adds all doc elements provided by {@link ApplicationDocs#getDocs()}
* to the generated wadl-file.
*
* The {@link ApplicationDocs} content can either be provided via a {@link File} reference
* ({@link #setApplicationDocsFile(File)}) or
* via an {@link InputStream} ({@link #setApplicationDocsStream(InputStream)}).
*
*
* The {@link File} should be used when using the maven-wadl-plugin for generating wadl offline,
* the {@link InputStream} should be used when the extended wadl is generated by jersey at runtime, e.g.
* using the {@link org.glassfish.jersey.server.wadl.config.WadlGeneratorConfig} for configuration.
*
*
* Created on: Jun 16, 2008
*
* @author Martin Grotzke (martin.grotzke at freiheit.com)
*/
public class WadlGeneratorApplicationDoc implements WadlGenerator {
private WadlGenerator _delegate;
private File _applicationDocsFile;
private InputStream _applicationDocsStream;
private ApplicationDocs _applicationDocs;
@Context
private Provider saxFactoryProvider;
public void setWadlGeneratorDelegate(WadlGenerator delegate) {
_delegate = delegate;
}
public String getRequiredJaxbContextPath() {
return _delegate.getRequiredJaxbContextPath();
}
public void setApplicationDocsFile(File applicationDocsFile) {
if (_applicationDocsStream != null) {
throw new IllegalStateException("The applicationDocsStream property is already set,"
+ " therefore you cannot set the applicationDocsFile property. Only one of both can be set at a time.");
}
_applicationDocsFile = applicationDocsFile;
}
public void setApplicationDocsStream(InputStream applicationDocsStream) {
if (_applicationDocsFile != null) {
throw new IllegalStateException("The applicationDocsFile property is already set,"
+ " therefore you cannot set the applicationDocsStream property. Only one of both can be set at a time.");
}
_applicationDocsStream = applicationDocsStream;
}
public void init() throws Exception {
if (_applicationDocsFile == null && _applicationDocsStream == null) {
throw new IllegalStateException("Neither the applicationDocsFile nor the applicationDocsStream"
+ " is set, one of both is required.");
}
_delegate.init();
InputStream inputStream;
if (_applicationDocsFile != null) {
inputStream = new FileInputStream(_applicationDocsFile);
} else {
inputStream = _applicationDocsStream;
}
_applicationDocs = WadlUtils.unmarshall(inputStream, saxFactoryProvider.get(), ApplicationDocs.class);
}
/**
* @return the application
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createApplication()
*/
public Application createApplication() {
final Application result = _delegate.createApplication();
if (_applicationDocs != null && _applicationDocs.getDocs() != null
&& !_applicationDocs.getDocs().isEmpty()) {
result.getDoc().addAll(_applicationDocs.getDocs());
}
return result;
}
/**
* @param r
* @param m
* @return the method
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createMethod(org.glassfish.jersey.server.model.Resource,
* org.glassfish.jersey.server.model.ResourceMethod)
*/
public Method createMethod(org.glassfish.jersey.server.model.Resource r, org.glassfish.jersey.server.model.ResourceMethod m) {
return _delegate.createMethod(r, m);
}
/**
* @param r
* @param m
* @param mediaType
* @return representation type
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createRequestRepresentation(org.glassfish.jersey.server.model.Resource,
* org.glassfish.jersey.server.model.ResourceMethod, javax.ws.rs.core.MediaType)
*/
public Representation createRequestRepresentation(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m,
MediaType mediaType) {
return _delegate.createRequestRepresentation(r, m, mediaType);
}
/**
* @param r
* @param m
* @return request
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createRequest(org.glassfish.jersey.server.model.Resource,
* org.glassfish.jersey.server.model.ResourceMethod)
*/
public Request createRequest(org.glassfish.jersey.server.model.Resource r, org.glassfish.jersey.server.model.ResourceMethod
m) {
return _delegate.createRequest(r, m);
}
/**
* @param r
* @param m
* @param p
* @return parameter
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createParam(org.glassfish.jersey.server.model.Resource,
* org.glassfish.jersey.server.model.ResourceMethod, org.glassfish.jersey.server.model.Parameter)
*/
public Param createParam(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m,
Parameter p) {
return _delegate.createParam(r, m, p);
}
/**
* @param r
* @param path
* @return resource
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createResource(org.glassfish.jersey.server.model.Resource, String)
*/
public Resource createResource(org.glassfish.jersey.server.model.Resource r, String path) {
return _delegate.createResource(r, path);
}
/**
* @param r
* @param m
* @return response
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createResponses(org.glassfish.jersey.server.model.Resource,
* org.glassfish.jersey.server.model.ResourceMethod)
*/
public List createResponses(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m) {
return _delegate.createResponses(r, m);
}
/**
* @return resources
* @see org.glassfish.jersey.server.wadl.WadlGenerator#createResources()
*/
public Resources createResources() {
return _delegate.createResources();
}
// ================ methods for post build actions =======================
@Override
public ExternalGrammarDefinition createExternalGrammar() {
return _delegate.createExternalGrammar();
}
@Override
public void attachTypes(ApplicationDescription egd) {
_delegate.attachTypes(egd);
}
}