Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.webcohesion.enunciate.modules.java_json_client.JavaJSONClientModule Maven / Gradle / Ivy
/**
* Copyright © 2006-2016 Web Cohesion ([email protected] )
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.webcohesion.enunciate.modules.java_json_client;
import com.webcohesion.enunciate.Enunciate;
import com.webcohesion.enunciate.EnunciateContext;
import com.webcohesion.enunciate.EnunciateException;
import com.webcohesion.enunciate.api.DefaultRegistrationContext;
import com.webcohesion.enunciate.api.resources.MediaTypeDescriptor;
import com.webcohesion.enunciate.api.resources.Method;
import com.webcohesion.enunciate.api.resources.Resource;
import com.webcohesion.enunciate.api.resources.ResourceGroup;
import com.webcohesion.enunciate.artifacts.ArtifactType;
import com.webcohesion.enunciate.artifacts.ClientLibraryJavaArtifact;
import com.webcohesion.enunciate.artifacts.FileArtifact;
import com.webcohesion.enunciate.facets.FacetFilter;
import com.webcohesion.enunciate.javac.decorations.SourcePosition;
import com.webcohesion.enunciate.metadata.DocumentationExample;
import com.webcohesion.enunciate.module.*;
import com.webcohesion.enunciate.modules.jackson.EnunciateJacksonContext;
import com.webcohesion.enunciate.modules.jackson.JacksonModule;
import com.webcohesion.enunciate.modules.jackson.api.impl.SyntaxImpl;
import com.webcohesion.enunciate.modules.jackson.model.TypeDefinition;
import com.webcohesion.enunciate.modules.jackson.model.util.JacksonCodeErrors;
import com.webcohesion.enunciate.modules.jaxrs.JaxrsModule;
import com.webcohesion.enunciate.util.AntPatternMatcher;
import com.webcohesion.enunciate.util.freemarker.*;
import freemarker.cache.URLTemplateLoader;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import org.apache.commons.configuration2.HierarchicalConfiguration;
import javax.lang.model.element.TypeElement;
import javax.tools.JavaCompiler;
import javax.tools.JavaFileObject;
import javax.tools.ToolProvider;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.StringWriter;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.*;
/**
* @author Ryan Heaton
*/
public class JavaJSONClientModule extends BasicGeneratingModule implements ApiFeatureProviderModule, ProjectExtensionModule {
private static final String LIRBARY_DESCRIPTION_PROPERTY = "com.webcohesion.enunciate.modules.java_xml_client.EnunciateJavaJSONClientModule#LIRBARY_DESCRIPTION_PROPERTY";
JacksonModule jacksonModule;
JaxrsModule jaxrsModule;
/**
* @return "java-xml"
*/
@Override
public String getName() {
return "java-json-client";
}
@Override
public List getDependencySpecifications() {
return List.of(new DependencySpec() {
@Override
public boolean accept(EnunciateModule module) {
if (module instanceof JacksonModule) {
jacksonModule = (JacksonModule) module;
return true;
}
else if (module instanceof JaxrsModule) {
jaxrsModule = (JaxrsModule) module;
return true;
}
return module instanceof ApiRegistryProviderModule;
}
@Override
public boolean isFulfilled() {
return true;
}
@Override
public String toString() {
return "jackson, optional jaxrs";
}
});
}
@Override
public void call(EnunciateContext context) {
if (this.jacksonModule == null || this.jacksonModule.getJacksonContext() == null || this.jacksonModule.getJacksonContext().getTypeDefinitions().isEmpty()) {
info("No Jackson JSON data types: Java JSON client will not be generated.");
return;
}
detectAccessorNamingErrors();
File sourceDir = generateClientSources();
File compileDir = compileClientSources(sourceDir);
packageArtifacts(sourceDir, compileDir);
}
protected void detectAccessorNamingErrors() {
List namingConflicts = JacksonCodeErrors.findConflictingAccessorNamingErrors(this.jacksonModule.getJacksonContext());
if (namingConflicts != null && !namingConflicts.isEmpty()) {
error("Jackson naming conflicts have been found:");
for (String namingConflict : namingConflicts) {
error(namingConflict);
}
error("These naming conflicts are often between the field and it's associated property, in which case you need to use one or both of the following strategies to avoid the conflicts:");
error("1. Explicitly exclude one or the other.");
error("2. Put the annotations on the property instead of the field.");
throw new EnunciateException("Jackson naming conflicts detected.");
}
}
protected File generateClientSources() {
File sourceDir = getSourceDir();
sourceDir.mkdirs();
Map model = new HashMap<>();
Map conversions = getClientPackageConversions();
EnunciateJacksonContext jacksonContext = this.jacksonModule != null ? this.jacksonModule.getJacksonContext() : null;
JsonContext jsonContext = new JsonContext(jacksonContext);
model.put("packageFor", new ClientPackageForMethod(conversions, this.context));
model.put("classnameFor", new ClientClassnameForMethod(conversions, jsonContext));
model.put("simpleNameFor", new SimpleNameForMethod(new ClientClassnameForMethod(conversions, jsonContext, true), jsonContext));
model.put("file", new FileDirective(sourceDir, this.enunciate.getLogger()));
model.put("generatedCodeLicense", this.enunciate.getConfiguration().readGeneratedCodeLicenseFile());
model.put("annotationValue", new AnnotationValueMethod());
model.put("wrapRootValue", this.jacksonModule.isWrapRootValue());
Set facetIncludes = new TreeSet<>(this.enunciate.getConfiguration().getFacetIncludes());
facetIncludes.addAll(getFacetIncludes());
Set facetExcludes = new TreeSet<>(this.enunciate.getConfiguration().getFacetExcludes());
facetExcludes.addAll(getFacetExcludes());
FacetFilter facetFilter = new FacetFilter(facetIncludes, facetExcludes);
model.put("isFacetExcluded", new IsFacetExcludedMethod(facetFilter));
AntPatternMatcher matcher = new AntPatternMatcher();
matcher.setPathSeparator(".");
boolean upToDate = isUpToDateWithSources(sourceDir);
if (!upToDate) {
try {
debug("Generating the Java client classes...");
for (TypeDefinition typeDefinition : jacksonContext.getTypeDefinitions()) {
if (facetFilter.accept(typeDefinition)) {
if (useServerSide(typeDefinition, matcher)) {
copyServerSideType(sourceDir, typeDefinition);
}
else {
model.put("type", typeDefinition);
URL template = typeDefinition.isEnum() ? getTemplateURL("client-enum-type.fmt") : typeDefinition.isSimple() ? getTemplateURL("client-simple-type.fmt") : getTemplateURL("client-complex-type.fmt");
processTemplate(template, model);
}
}
}
}
catch (IOException | TemplateException e) {
throw new EnunciateException(e);
}
}
else {
info("Skipping generation of Java client sources as everything appears up-to-date...");
}
context.setProperty(LIRBARY_DESCRIPTION_PROPERTY, readLibraryDescription(model));
return sourceDir;
}
protected void copyServerSideType(File sourceDir, TypeElement type) throws IOException {
SourcePosition source = this.context.getProcessingEnvironment().findSourcePosition(type);
JavaFileObject sourceFile = source.getSourceFile();
File destFile = getServerSideDestFile(sourceDir, sourceFile, type);
FileWriter writer = new FileWriter(destFile);
debug("Writing server-side java type to %s.", destFile);
writer.write(sourceFile.getCharContent(false).toString());
writer.flush();
writer.close();
}
protected File getSourceDir() {
return new File(new File(this.enunciate.getBuildDir(), getName()), "src");
}
/**
* Processes the specified template with the given model.
*
* @param templateURL The template URL.
* @param model The root model.
*/
public String processTemplate(URL templateURL, Object model) throws IOException, TemplateException {
debug("Processing template %s.", templateURL);
Configuration configuration = new Configuration(FreemarkerUtil.VERSION);
configuration.setLocale(new Locale("en", "US"));
configuration.setTemplateLoader(new URLTemplateLoader() {
protected URL getURL(String name) {
try {
return new URL(name);
}
catch (MalformedURLException e) {
return null;
}
}
});
configuration.setTemplateExceptionHandler((templateException, environment, writer) -> {
throw templateException;
});
configuration.setLocalizedLookup(false);
configuration.setDefaultEncoding("UTF-8");
configuration.setObjectWrapper(new JavaJSONClientObjectWrapper());
Template template = configuration.getTemplate(templateURL.toString());
StringWriter unhandledOutput = new StringWriter();
template.process(model, unhandledOutput);
unhandledOutput.close();
return unhandledOutput.toString();
}
protected File getServerSideDestFile(File sourceDir, JavaFileObject sourceFile, TypeElement declaration) {
File destDir = sourceDir;
String packageName = this.context.getProcessingEnvironment().getElementUtils().getPackageOf(declaration).getQualifiedName().toString();
for (StringTokenizer packagePaths = new StringTokenizer(packageName, "."); packagePaths.hasMoreTokens();) {
String packagePath = packagePaths.nextToken();
destDir = new File(destDir, packagePath);
}
destDir.mkdirs();
String simpleFilename = sourceFile.toUri().toString();
simpleFilename = simpleFilename.substring(simpleFilename.lastIndexOf('/'));
return new File(destDir, simpleFilename);
}
/**
* Whether to use the server-side declaration for this declaration.
*
* @param declaration The declaration.
* @param matcher The matcher.
* @return Whether to use the server-side declaration for this declaration.
*/
protected boolean useServerSide(TypeElement declaration, AntPatternMatcher matcher) {
boolean useServerSide = false;
for (String pattern : getServerSideTypesToUse()) {
if (matcher.match(pattern, declaration.getQualifiedName().toString())) {
useServerSide = true;
break;
}
}
return useServerSide;
}
protected File compileClientSources(File sourceDir) {
File compileDir = getCompileDir();
compileDir.mkdirs();
//Compile the java files.
if (!isDisableCompile()) {
if (!isUpToDateWithSources(compileDir)) {
List sources = findJavaFiles(sourceDir);
if (sources != null && !sources.isEmpty()) {
String classpath = this.enunciate.writeClasspath(enunciate.getClasspath());
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
List options = Arrays.asList("-source", getJavacSource(), "-target", getJavacTarget(), "-encoding", "UTF-8", "-cp", classpath, "-d", compileDir.getAbsolutePath(), "-nowarn");
JavaCompiler.CompilationTask task = compiler.getTask(null, null, null, options, null, compiler.getStandardFileManager(null, null, null).getJavaFileObjectsFromFiles(sources));
if (!task.call()) {
throw new EnunciateException("Compile failed of Java JSON client-side classes.");
}
}
else {
debug("No Java JSON client classes to compile.");
}
}
else {
info("Skipping compilation of Java JSON client classes as everything appears up-to-date...");
}
}
return compileDir;
}
private List findJavaFiles(File sourceDir) {
final ArrayList javaFiles = new ArrayList<>();
this.enunciate.visitFiles(sourceDir, Enunciate.JAVA_FILTER, javaFiles::add);
return javaFiles;
}
protected File getCompileDir() {
return new File(new File(this.enunciate.getBuildDir(), getName()), "classes");
}
protected File getResourcesDir() {
return new File(new File(this.enunciate.getBuildDir(), getName()), "resources");
}
protected File packageArtifacts(File sourceDir, File compileDir) {
File packageDir = getPackageDir();
packageDir.mkdirs();
try {
String jarName = getJarName();
File clientJarFile = null;
if (!isDisableCompile()) {
clientJarFile = new File(packageDir, jarName);
if (!isUpToDateWithSources(clientJarFile)) {
if (isBundleSourcesWithClasses()) {
boolean anyFiles = this.enunciate.jar(clientJarFile, getManifest(), sourceDir, compileDir);
if (!anyFiles) {
clientJarFile = null;
}
}
else {
boolean anyFiles = this.enunciate.jar(clientJarFile, getManifest(), compileDir);
if (!anyFiles) {
clientJarFile = null;
}
}
}
else {
info("Skipping creation of Java client jar as everything appears up-to-date...");
}
}
File clientSourcesJarFile = null;
if (!isBundleSourcesWithClasses()) {
clientSourcesJarFile = new File(packageDir, jarName.replaceFirst("\\.jar", "-json-sources.jar"));
if (!isUpToDateWithSources(clientSourcesJarFile)) {
boolean anyFiles = this.enunciate.zip(clientSourcesJarFile, sourceDir);
if (!anyFiles) {
clientSourcesJarFile = null;
}
}
else {
info("Skipping creation of the Java client source jar as everything appears up-to-date...");
}
}
ClientLibraryJavaArtifact artifactBundle = new ClientLibraryJavaArtifact(getName(), "java.json.client.library", "Java JSON Client Library");
artifactBundle.setGroupId(getGroupId());
artifactBundle.setArtifactId(getArtifactId());
artifactBundle.setVersion(getVersion());
artifactBundle.setPlatform("Java (Version 5+)");
//read in the description from file:
artifactBundle.setDescription((String) context.getProperty(LIRBARY_DESCRIPTION_PROPERTY));
if (clientJarFile != null) {
FileArtifact binariesJar = new FileArtifact(getName(), "java.json.client.library.binaries", clientJarFile);
binariesJar.setDescription("The binaries for the Java JSON client library.");
binariesJar.setPublic(false);
binariesJar.setArtifactType(ArtifactType.binaries);
artifactBundle.addArtifact(binariesJar);
this.enunciate.addArtifact(binariesJar);
}
if (clientSourcesJarFile != null) {
FileArtifact sourcesJar = new FileArtifact(getName(), "java.json.client.library.sources", clientSourcesJarFile);
sourcesJar.setDescription("The sources for the Java JSON client library.");
sourcesJar.setPublic(false);
sourcesJar.setArtifactType(ArtifactType.sources);
artifactBundle.addArtifact(sourcesJar);
this.enunciate.addArtifact(sourcesJar);
}
if (clientJarFile != null || clientSourcesJarFile != null) {
this.enunciate.addArtifact(artifactBundle);
}
}
catch (IOException e) {
throw new EnunciateException(e);
}
return packageDir;
}
protected File getPackageDir() {
return new File(new File(this.enunciate.getBuildDir(), getName()), "build");
}
/**
* Reads a resource into string form.
*
* @return The string form of the resource.
*/
protected String readLibraryDescription(Map model) {
model.put("sample_resource", findExampleResourceMethod());
model.put("mediaTypeFor", new MediaTypeForMethod());
URL res = JavaJSONClientModule.class.getResource("library_description.fmt");
try {
return processTemplate(res, model);
}
catch (TemplateException | IOException e) {
throw new EnunciateException(e);
}
}
/**
* Finds an example resource method, according to the following preference order:
*
*
* The first method annotated with {@link DocumentationExample}.
* The first method with BOTH an output payload with a known XML element and an input payload with a known XML element.
* The first method with an output payload with a known XML element.
*
*
* @return An example resource method, or if no good examples were found.
*/
public Method findExampleResourceMethod() {
Method example = null;
if (this.jaxrsModule != null) {
List resourceGroups = this.jaxrsModule.getJaxrsContext().getResourceGroups(new DefaultRegistrationContext(context));
for (ResourceGroup resourceGroup : resourceGroups) {
List resources = resourceGroup.getResources();
for (Resource resource : resources) {
for (Method method : resource.getMethods()) {
if (hasXmlResponseEntity(method)) {
if (hasXmlRequestEntity(method)) {
//we'll prefer one with both an output AND an input.
return method;
}
else {
//we'll prefer the first one we find with an output.
example = example == null ? method : example;
}
}
}
}
}
}
return example;
}
private boolean hasXmlResponseEntity(Method method) {
if (method.getResponseEntity() != null) {
for (MediaTypeDescriptor mediaTypeDescriptor : method.getResponseEntity().getMediaTypes()) {
String syntax = mediaTypeDescriptor.getSyntax();
if (SyntaxImpl.SYNTAX_LABEL.equals(syntax)) {
return true;
}
}
}
return false;
}
private boolean hasXmlRequestEntity(Method method) {
if (method.getRequestEntity() != null) {
for (MediaTypeDescriptor mediaTypeDescriptor : method.getRequestEntity().getMediaTypes()) {
String syntax = mediaTypeDescriptor.getSyntax();
if (SyntaxImpl.SYNTAX_LABEL.equals(syntax)) {
return true;
}
}
}
return false;
}
protected URL getTemplateURL(String template) {
return JavaJSONClientModule.class.getResource(template);
}
public String getJarName() {
return this.config.getString("[@jarName]", getSlug() + "-json-client.jar");
}
public String getGroupId() {
return this.config.getString("[@groupId]", null);
}
public String getArtifactId() {
return this.config.getString("[@artifactId]", null);
}
public String getVersion() {
return this.config.getString("[@version]", null);
}
public String getJavacSource() {
return this.config.getString("[@javac-source]", "8");
}
public String getJavacTarget() {
return this.config.getString("[@javac-target]", "8");
}
public Map getClientPackageConversions() {
List conversionElements = this.config.configurationsAt("package-conversions.convert");
HashMap conversions = new HashMap<>();
conversions.put("java.lang.Exception", "client.java.lang.Exception");
conversions.put("java.util.Map.Entry", "java.util.Map.Entry");
for (HierarchicalConfiguration conversionElement : conversionElements) {
conversions.put(conversionElement.getString("[@from]"), conversionElement.getString("[@to]"));
}
return conversions;
}
public Set getServerSideTypesToUse() {
List typeElements = this.config.configurationsAt("server-side-type");
TreeSet types = new TreeSet<>();
for (HierarchicalConfiguration typeElement : typeElements) {
types.add(typeElement.getString("[@pattern]"));
}
return types;
}
public String getSlug() {
return this.config.getString("[@slug]", this.enunciate.getConfiguration().getSlug());
}
public boolean isBundleSourcesWithClasses() {
return this.config.getBoolean("[@bundleSourcesWithClasses]", false);
}
public List getProjectSources() {
return Collections.emptyList();
}
public List getProjectTestSources() {
return Collections.singletonList(getSourceDir());
}
public List getProjectResourceDirectories() {
return Collections.emptyList();
}
public List getProjectTestResourceDirectories() {
return Collections.singletonList(getResourcesDir());
}
/**
* Whether to disable the compilation of the java sources (default: false).
*
* @return Whether to disable the compilation of the java sources (default: false).
*/
public boolean isDisableCompile() {
return this.config.getBoolean("[@disableCompile]", this.jacksonModule == null || !this.jacksonModule.isJacksonDetected());
}
public Set getFacetIncludes() {
List includes = this.config.getList("facets.include[@name]");
Set facetIncludes = new TreeSet<>();
for (Object include : includes) {
facetIncludes.add(String.valueOf(include));
}
return facetIncludes;
}
public Set getFacetExcludes() {
List excludes = this.config.getList("facets.exclude[@name]");
Set facetExcludes = new TreeSet<>();
for (Object exclude : excludes) {
facetExcludes.add(String.valueOf(exclude));
}
return facetExcludes;
}
}
