org.glassfish.admin.rest.generator.TextClassWriter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.admin.rest.generator;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.List;
import java.util.logging.Level;
import org.glassfish.admin.rest.RestLogging;
import org.glassfish.admin.rest.utils.ResourceUtil;
import org.glassfish.hk2.api.ServiceLocator;
/**
* @author Mitesh Meswani
*/
public class TextClassWriter implements ClassWriter {
Writer writer;
ServiceLocator habitat;
/**
* @param className Name of class to be generated
* @param generationDir Absolute location where it needs to be generated
* @param baseClassName
* @param resourcePath
*/
public TextClassWriter(ServiceLocator habitat,File generationDir, String className, String baseClassName, String resourcePath) throws IOException {
this.habitat = habitat;
File file = new File(generationDir, className + ".java");
boolean success = file.createNewFile();
if (!success) {
RestLogging.restLogger.log(Level.FINE, "Error creating file: {0} in {1}",
new String[] { className+".java", generationDir.getAbsolutePath() });
}
FileWriter fstream = new FileWriter(file);
writer = new BufferedWriter(fstream);
writeCopyRightHeader();
writePackageHeader();
writeImportStatements();
if(resourcePath != null) {
writer.write("@Path(\"/" + resourcePath + "/\")\n");
}
writer.write("public class " + className + " extends " + baseClassName + " {\n\n");
}
private void writePackageHeader() throws IOException {
writer.write("package org.glassfish.admin.rest.resources.generated;\n");
}
private void writeCopyRightHeader() throws IOException {
writer.write("/*\n");
writer.write(" * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.\n");
writer.write(" *\n");
writer.write(" * Copyright (c) 2009-2013 Oracle and/or its affiliates. All rights reserved.\n");
writer.write(" *\n");
writer.write(" * The contents of this file are subject to the terms of either the GNU\n");
writer.write(" * General Public License Version 2 only (\"GPL\") or the Common Development\n");
writer.write(" * and Distribution License(\"CDDL\") (collectively, the \"License\"). You\n");
writer.write(" * may not use this file except in compliance with the License. You can\n");
writer.write(" * obtain a copy of the License at\n");
writer.write(" * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html\n");
writer.write(" * or packager/legal/LICENSE.txt. See the License for the specific\n");
writer.write(" * language governing permissions and limitations under the License.\n");
writer.write(" *\n");
writer.write(" * When distributing the software, include this License Header Notice in each\n");
writer.write(" * file and include the License file at packager/legal/LICENSE.txt.\n");
writer.write(" *\n");
writer.write(" * GPL Classpath Exception:\n");
writer.write(" * Oracle designates this particular file as subject to the \"Classpath\"\n");
writer.write(" * exception as provided by Oracle in the GPL Version 2 section of the License\n");
writer.write("* file that accompanied this code.\n");
writer.write(" *\n");
writer.write(" * Modifications:\n");
writer.write(" * If applicable, add the following below the License Header, with the fields\n");
writer.write(" * enclosed by brackets [] replaced by your own identifying information:\n");
writer.write(" * \"Portions Copyright [year] [name of copyright owner]\"\n");
writer.write(" *\n");
writer.write(" * Contributor(s):\n");
writer.write(" * If you wish your version of this file to be governed by only the CDDL or\n");
writer.write(" * only the GPL Version 2, indicate your decision by adding \"[Contributor]\n");
writer.write(" * elects to include this software in this distribution under the [CDDL or GPL\n");
writer.write(" * Version 2] license.\" If you don't indicate a single choice of license, a\n");
writer.write(" * recipient has the option to distribute your version of this file under\n");
writer.write(" * either the CDDL, the GPL Version 2 or to extend the choice of license to\n");
writer.write(" * its licensees as provided above. However, if you add GPL Version 2 code\n");
writer.write(" * and therefore, elected the GPL Version 2 license, then the option applies\n");
writer.write(" * only if the new code is made subject to such option by the copyright\n");
writer.write(" * holder.\n");
writer.write(" */\n");
writer.write("\n");
}
private void writeImportStatements() throws IOException {
writer.write("import jakarta.ws.rs.Path;\n");
writer.write("import jakarta.ws.rs.PathParam;\n");
writer.write("import org.glassfish.admin.rest.resources.*;\n");
writer.write("import org.glassfish.admin.rest.resources.custom.*;\n");
}
@Override
public void createCommandResourceConstructor(String commandResourceClassName, String commandName, String httpMethod, boolean linkedToParent,
CommandResourceMetaData.ParameterMetaData[] commandParams, String commandDisplayName, String commandAction) {
try {
writer.write(" public " + commandResourceClassName + "() {\n");
writer.write(" super(\n");
writer.write(" \"" + commandResourceClassName + "\",\n");
writer.write(" \"" + commandName + "\",\n");
writer.write(" \"" + httpMethod + "\",\n");
if (!httpMethod.equals("GET")) {
writer.write(" \"" + commandAction + "\",\n");
writer.write(" \"" + commandDisplayName + "\",\n");
}
writer.write(" " + linkedToParent + ");\n");
writer.write(" }\n");
if (commandParams != null) {
writer.write("@Override\n");
writer.write("protected java.util.HashMap getCommandParams() {\n");
writer.write("\tjava.util.HashMap hm = new java.util.HashMap();\n");
for (CommandResourceMetaData.ParameterMetaData commandParam : commandParams) {
writer.write("\thm.put(\"" + commandParam.name + "\",\"" + commandParam.value + "\");\n");
}
writer.write("\treturn hm;\n");
writer.write("}\n");
}
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetCommandResource(String commandResourceClassName, String resourcePath) {
//define method with @Path in resource- resourceName
try {
writer.write("@Path(\"" + resourcePath + "/\")\n");
writer.write("public " + commandResourceClassName + " get"
+ commandResourceClassName + "() {\n");
writer.write(commandResourceClassName + " resource = injector.inject(" + commandResourceClassName + ".class);\n");
writer.write("return resource;\n");
writer.write("}\n\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createCustomResourceMapping(String resourceClassName, String mappingPath) {
try {
writer.write("\n");
writer.write("\t@Path(\"" + mappingPath + "/\")\n");
writer.write("\tpublic " + resourceClassName + " get" + resourceClassName + "() {\n");
writer.write("\t\t" + resourceClassName + " resource = injector.inject(" + resourceClassName + ".class);\n");
writer.write("\t\tresource.setEntity(getEntity());\n");
writer.write("\t\treturn resource;\n");
writer.write("\t}\n\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetCommandResourcePaths(List commandMetaData) {
assert commandMetaData.size() > 0 : "It is assumed that this method is called only if commandMetaData.size() > 0";
try {
writer.write("@Override\n");
writer.write("public String[][] getCommandResourcesPaths() {\n");
StringBuilder commandResourcesPaths = new StringBuilder();
for (CommandResourceMetaData metaData : commandMetaData) {
if (ResourceUtil.commandIsPresent(habitat, metaData.command)){
if (commandResourcesPaths.length() > 0) {
commandResourcesPaths = commandResourcesPaths.append(", ");
}
commandResourcesPaths = commandResourcesPaths .append( "{")
.append('"').append(metaData.resourcePath).append("\", ")
.append('"').append(metaData.httpMethod).append("\", ")
.append('"').append(metaData.command).append("\"} ");
}
}
writer.write("return new String[][] {" + commandResourcesPaths + "};\n");
writer.write("}\n\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetDeleteCommand(String commandName) {
try {
writer.write("@Override\n");
writer.write("public String getDeleteCommand() {\n");
writer.write("\treturn \"" + commandName + "\";\n");
writer.write("}\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetPostCommand(String commandName) {
//TODO this method and createGetDeleteCommand method may be merged to single method createGetXXXCommand(String commandName, String httpMethod)
try {
writer.write("@Override\n");
writer.write("public String getPostCommand() {\n");
writer.write("\treturn \"" + commandName + "\";\n");
writer.write("}\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetChildResource(String path, String childResourceClassName) {
try {
writer.write("\t@Path(\"" + path + "/\")\n");
writer.write("\tpublic " + childResourceClassName + " get" + childResourceClassName + "() {\n");
writer.write("\t\t" + childResourceClassName + " resource = injector.inject(" + childResourceClassName + ".class);\n");
writer.write("\t\tresource.setParentAndTagName(getEntity() , \"" + path + "\");\n");
writer.write("\t\treturn resource;\n");
writer.write("\t}\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetChildResourceForListResources(String keyAttributeName, String childResourceClassName) {
try {
writer.write("\n");
writer.write("\t@Path(\"{" + keyAttributeName + "}/\")\n");
writer.write("\tpublic " + childResourceClassName + " get" + childResourceClassName + "(@PathParam(\"" + keyAttributeName + "\") String id) {\n");
writer.write("\t\t" + childResourceClassName + " resource = injector.inject(" + childResourceClassName + ".class);\n");
writer.write("\t\tresource.setBeanByKey(entity, id, tagName);\n");
writer.write("\t\treturn resource;\n");
writer.write("\t}\n\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetPostCommandForCollectionLeafResource(String postCommandName) {
try {
writer.write("@Override\n");
writer.write("protected String getPostCommand(){\n");
writer.write("return \"" + postCommandName + "\";\n");
writer.write("}\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetDeleteCommandForCollectionLeafResource(String deleteCommandName) {
try {
writer.write("@Override\n");
writer.write("protected String getDeleteCommand(){\n");
writer.write("return \"" + deleteCommandName + "\";\n");
writer.write("}\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void createGetDisplayNameForCollectionLeafResource(String displayName) {
try {
writer.write("@Override\n");
writer.write("protected String getName(){\n");
writer.write("return \"" + displayName + "\";\n");
writer.write("}\n");
} catch (IOException e) {
throw new GeneratorException(e);
}
}
@Override
public void done() {
try {
writer.write("}\n");
writer.close();
} catch (IOException e) {
throw new GeneratorException(e);
}
}
}