org.glassfish.jersey.server.wadl.internal.WadlGeneratorImpl 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, 2020 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;
import java.util.ArrayList;
import java.util.List;
import jakarta.ws.rs.core.MediaType;
import javax.xml.namespace.QName;
import org.glassfish.jersey.server.model.Parameter;
import org.glassfish.jersey.server.model.ResourceMethod;
import org.glassfish.jersey.server.wadl.WadlGenerator;
import com.sun.research.ws.wadl.Application;
import com.sun.research.ws.wadl.Param;
import com.sun.research.ws.wadl.ParamStyle;
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 WadlGenerator creates the basic wadl artifacts.
* Created on: Jun 16, 2008
*
* @author Martin Grotzke (martin.grotzke at freiheit.com)
* @author Miroslav Fuksa
*/
public class WadlGeneratorImpl implements WadlGenerator {
@Override
public String getRequiredJaxbContextPath() {
final String name = Application.class.getName();
return name.substring(0, name.lastIndexOf('.'));
}
@Override
public void init() {
}
@Override
public void setWadlGeneratorDelegate(WadlGenerator delegate) {
throw new UnsupportedOperationException("No delegate supported.");
}
@Override
public Resources createResources() {
return new Resources();
}
@Override
public Application createApplication() {
return new Application();
}
@Override
public com.sun.research.ws.wadl.Method createMethod(
org.glassfish.jersey.server.model.Resource r, final ResourceMethod m) {
com.sun.research.ws.wadl.Method wadlMethod =
new com.sun.research.ws.wadl.Method();
wadlMethod.setName(m.getHttpMethod());
wadlMethod.setId(m.getInvocable().getDefinitionMethod().getName());
if (m.isExtended()) {
wadlMethod.getAny().add(WadlApplicationContextImpl.EXTENDED_ELEMENT);
}
return wadlMethod;
}
@Override
public Representation createRequestRepresentation(org.glassfish.jersey.server.model.Resource r,
ResourceMethod m, MediaType mediaType) {
Representation wadlRepresentation = new Representation();
wadlRepresentation.setMediaType(mediaType.toString());
return wadlRepresentation;
}
@Override
public Request createRequest(org.glassfish.jersey.server.model.Resource r, ResourceMethod m) {
return new Request();
}
@Override
public Param createParam(org.glassfish.jersey.server.model.Resource r, ResourceMethod m, final Parameter p) {
if (p.getSource() == Parameter.Source.UNKNOWN) {
return null;
}
Param wadlParam = new Param();
wadlParam.setName(p.getSourceName());
switch (p.getSource()) {
case FORM:
wadlParam.setStyle(ParamStyle.QUERY);
break;
case QUERY:
wadlParam.setStyle(ParamStyle.QUERY);
break;
case MATRIX:
wadlParam.setStyle(ParamStyle.MATRIX);
break;
case PATH:
wadlParam.setStyle(ParamStyle.TEMPLATE);
break;
case HEADER:
wadlParam.setStyle(ParamStyle.HEADER);
break;
case COOKIE:
// Generates name="Cookie" path=""
wadlParam.setStyle(ParamStyle.HEADER);
wadlParam.setName("Cookie");
wadlParam.setPath(p.getSourceName());
break;
default:
break;
}
if (p.hasDefaultValue()) {
wadlParam.setDefault(p.getDefaultValue());
}
Class pClass = p.getRawType();
if (pClass.isArray()) {
wadlParam.setRepeating(true);
pClass = pClass.getComponentType();
}
if (pClass.equals(int.class) || pClass.equals(Integer.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "int", "xs"));
} else if (pClass.equals(boolean.class) || pClass.equals(Boolean.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "boolean", "xs"));
} else if (pClass.equals(long.class) || pClass.equals(Long.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "long", "xs"));
} else if (pClass.equals(short.class) || pClass.equals(Short.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "short", "xs"));
} else if (pClass.equals(byte.class) || pClass.equals(Byte.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "byte", "xs"));
} else if (pClass.equals(float.class) || pClass.equals(Float.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "float", "xs"));
} else if (pClass.equals(double.class) || pClass.equals(Double.class)) {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "double", "xs"));
} else {
wadlParam.setType(new QName("http://www.w3.org/2001/XMLSchema", "string", "xs"));
}
return wadlParam;
}
@Override
public Resource createResource(org.glassfish.jersey.server.model.Resource resource, String path) {
Resource wadlResource = new Resource();
if (path != null) {
wadlResource.setPath(path);
} else if (resource.getPath() != null) {
wadlResource.setPath(resource.getPath());
}
if (resource.isExtended()) {
wadlResource.getAny().add(WadlApplicationContextImpl.EXTENDED_ELEMENT);
}
return wadlResource;
}
@Override
public List createResponses(org.glassfish.jersey.server.model.Resource r, ResourceMethod m) {
final Response response = new Response();
// add mediaType="*/*" in case that no mediaType was specified
if (hasEmptyProducibleMediaTypeSet(m)) {
Representation wadlRepresentation = createResponseRepresentation(r, m, MediaType.WILDCARD_TYPE);
response.getRepresentation().add(wadlRepresentation);
} else {
for (MediaType mediaType : m.getProducedTypes()) {
Representation wadlRepresentation = createResponseRepresentation(r, m, mediaType);
response.getRepresentation().add(wadlRepresentation);
}
}
List responses = new ArrayList();
responses.add(response);
return responses;
}
private boolean hasEmptyProducibleMediaTypeSet(final ResourceMethod method) {
return method.getProducedTypes().isEmpty();
}
public Representation createResponseRepresentation(org.glassfish.jersey.server.model.Resource r, ResourceMethod m,
MediaType mediaType) {
Representation wadlRepresentation = new Representation();
wadlRepresentation.setMediaType(mediaType.toString());
return wadlRepresentation;
}
// ================ methods for post build actions =======================
@Override
public ExternalGrammarDefinition createExternalGrammar() {
// Return an empty list to add to
return new ExternalGrammarDefinition();
}
@Override
public void attachTypes(ApplicationDescription egd) {
}
}