org.glassfish.jersey.server.wadl.WadlGenerator Maven / Gradle / Ivy
/*
* 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;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import jakarta.ws.rs.core.MediaType;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.annotation.XmlRegistry;
import javax.xml.namespace.QName;
import org.glassfish.jersey.server.model.Parameter;
import org.glassfish.jersey.server.wadl.internal.ApplicationDescription;
import com.sun.research.ws.wadl.Application;
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;
/**
* A WadlGenerator creates artifacts related to wadl. This is designed as an interface,
* so that several implementations can decorate existing ones. One decorator could e.g. add
* references to definitions within some xsd for existing representations.
* Created on: Jun 16, 2008
*
* @author Martin Grotzke (martin.grotzke at freiheit.com)
*/
public interface WadlGenerator {
/**
* Sets the delegate that is decorated by this wadl generator. Is invoked directly after
* this generator is instantiated before {@link #init()} or any setter method is invoked.
* @param delegate the wadl generator to decorate
*/
void setWadlGeneratorDelegate(WadlGenerator delegate);
/**
* Invoked before all methods related to wadl-building are invoked. This method is used in a
* decorator like manner, and therefore has to invoke {@code this.delegate.init()}.
*
* @throws IllegalStateException
* @throws JAXBException
*/
void init() throws Exception;
/**
* The jaxb context path that is used when the generated wadl application is marshalled
* to a file.
*
* This method is used in a decorator like manner.
* The result return the path (or a colon-separated list of package names) containing
* jaxb-beans that are added to wadl elements by this WadlGenerator, additionally to
* the context path of the decorated WadlGenerator (set by {@link #setWadlGeneratorDelegate(WadlGenerator)}.
* If you do not use custom jaxb beans, then simply return {@code _delegate.getRequiredJaxbContextPath()},
* otherwise return the delegate's #getRequiredJaxbContextPath() together with
* your required context path (separated by a colon):
* _delegate.getRequiredJaxbContextPath() == null
? ${yourContextPath}
: _delegate.getRequiredJaxbContextPath() + ":" + ${yourContextPath};
*
* If you add the path for your custom jaxb beans, don't forget to add an
* ObjectFactory (annotated with {@link XmlRegistry}) to this package.
* @return simply the {@code getRequiredJaxbContextPath()} of the delegate or the
* {@code getRequiredJaxbContextPath() + ":" + ${yourContextPath}}.
*/
String getRequiredJaxbContextPath();
// ================ methods for building the wadl application =============
Application createApplication();
Resources createResources();
Resource createResource(org.glassfish.jersey.server.model.Resource r,
String path);
com.sun.research.ws.wadl.Method createMethod(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m);
Request createRequest(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m);
Representation createRequestRepresentation(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m,
MediaType mediaType);
List createResponses(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m);
Param createParam(org.glassfish.jersey.server.model.Resource r,
org.glassfish.jersey.server.model.ResourceMethod m,
Parameter p);
// ================ methods for post build actions =======================
/**
* Call back interface that the created external grammar can use
* to allow other parts of the code to attach the correct grammar information.
*/
interface Resolver {
/**
* Resolve a Class type to a QName.
*
* @param type The type of the class.
* @return The schema type of the class if defined, null if not.
*/
QName resolve(Class type);
}
/**
* And internal storage object to store the grammar definitions and
* any type resolvers that are created along the way.
*/
class ExternalGrammarDefinition {
// final public field to make a property was thinking about encapsulation
// but decided code much simpler without
public final Map
map = new HashMap();
private List typeResolvers = new ArrayList();
public void addResolver(Resolver resolver) {
assert !typeResolvers.contains(resolver) : "Already in list";
typeResolvers.add(resolver);
}
/**
* @param type the class to map
* @return The resolved qualified name if one is defined.
*/
public QName resolve(Class type) {
QName name = null;
found:
for (Resolver resolver : typeResolvers) {
name = resolver.resolve(type);
if (name != null) {
break found;
}
}
return name;
}
}
/**
* Perform any post create functions such as generating grammars.
* @return A map of extra files to the content of those file encoded in UTF-8
*/
ExternalGrammarDefinition createExternalGrammar();
/**
* Process the elements in the WADL definition to attach schema types
* as required.
* @param description The root description used to resolve these entries
*/
void attachTypes(ApplicationDescription description);
}