RESTful Service on an embedded Glassfish/Payara

Last posts were about making a RESTFul service and run it on Jersey with an embedded Jetty.
This time I will set up a more Java EE like solution with the same REST Resource, but instead run it on an embedded Glassfish (actually, I will go for Payara). I will take the same model as before. Next part I will also add a JSF 2.2 client to use the RESTful service.

I will create this as a maven multi module with a parent project and two subprojects. One will be a web-project and the other will be a "runner" for the embedded Glassfish. I will not use maven to run, but will create a class that will run the embedded Glassfish with the war-file from the other project.

As it is pretty easy I use NetBeans to create maven projects for me.

The structure will be like this:

• embgf
• task-web
• gf-runner
• pack-dist

task-web

To start with, instead of having to set up a Servlet on "/api" path, we will create a configuration class that extends JAX_RSs Application.

package se.ironic.task.boundary; import java.util.HashSet; import java.util.Set; import javax.ws.rs.ApplicationPath; import javax.ws.rs.core.Application; @ApplicationPath("api") public class JAXRSConfiguration extends Application { @Override public Set<Class<?>> getClasses() { HashSet<Class<?>> classes = new HashSet<>(); classes.add(TaskResource.class); return classes; } }

And this will be the class for the Task service.
package se.ironic.task.boundary; import java.net.URI; import java.util.List; import java.util.Optional; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import se.ironic.task.model.Task; /** * * @author Ironic */ @Path("tasks") public class TaskResource { @GET @Produces(MediaType.APPLICATION_JSON) public List<task> getAll() { return TaskCache.INST.getTasks(); } @POST @Consumes(MediaType.APPLICATION_JSON) public Response create(Task task) { TaskCache.INST.putTask(task); URI id = URI.create("tasks/" + task.getId()); Response resp = Response.created(id).build(); return resp; } @GET @Produces(MediaType.APPLICATION_JSON) @Path("{id}") public Response getTask(@PathParam("id") String id) { Optional<task> task = TaskCache.INST.getTask(id); Response resp = null; if (task.isPresent()) { resp = Response.ok(task.get()).build(); } else { resp = Response.noContent().build(); } return resp; } @PUT @Consumes(MediaType.APPLICATION_JSON) @Path("{id}") public Response update(Task task) { // Just replace the one there TaskCache.INST.putTask(task); return Response.ok().build(); } @DELETE @Path("{id}") public Response delete(@PathParam("id") String id) { System.out.println("Deleting task: " + id); TaskCache.INST.removeTask(id); return Response.ok().build(); } }

The service will be available at [http://localhost:2001/task-web/api/tasks] (depending what you use as port and contextRoot)
Just to have some Tasks to start with since we have a simple cache in a HashMap, we create a startup bean to create some.

package se.ironic.task.control; import java.util.Calendar; import java.util.Date; import javax.annotation.PostConstruct; import javax.ejb.Singleton; import javax.ejb.Startup; import se.ironic.task.boundary.TaskCache; import se.ironic.task.model.Task; @Singleton @Startup public class BootTasks { @PostConstruct public void initTasks() { Calendar cal = Calendar.getInstance(); cal.setTime(new Date()); cal.add(Calendar.DATE, 3); TaskCache.INST.putTask(Task.of("Add JAXRSConfiguration", "Add a class for JAXRS configuration", cal.getTime())); TaskCache.INST.putTask(Task.of("Add TaskResource", "Add a class for Task service", cal.getTime())); TaskCache.INST.putTask(Task.of("Add BootTasks", "Add a bean for bootstrap", cal.getTime())); } }

gf-runner

Embedded Payara

Trying to follow [http://www.payara.co.uk/using_payara_embedded_and_payara_micro_with_mav] I ran in to some issues. The dependency on that page does not really work, it end up with the following message:
[ERROR] Failed to execute goal on project gf-runner: Could not resolve dependencies for project se.ironic:gf-runner:jar:1.0-SNAPSHOT: Failed to collect dependencies at fish.payara.extras:payara-embedded-web:jar:4.1.152.1: Failed to read artifact descriptor for fish.payara.extras:payara-embedded-web:jar:4.1.152.1: Could not find artifact org.glassfish.main.extras:extras:pom:4.1.152.1 in central (http://repo.maven.apache.org/maven2) -> [Help 1]

There is a bug-report on this. But to get on, I will download the jar and do a "quickie" and add it as a system dependency and get on.
<dependency> <groupid>fish.payara.extras</groupId> <artifactid>payara-embedded-all</artifactId> <version>4.1.152.1</version> <!--<type>jar</type>--> <!-- fix until maven repor for payara fixed --> <scope>system</scope> <systempath>${basedir}/lib/payara-embedded-all-4.1.152.1.jar</systemPath> </dependency>
The code to get up and running with the war-file from task-web on an embedded Payara is just a few lines:
package se.ironic.gfrunner; import java.io.File; import org.glassfish.embeddable.BootstrapProperties; import org.glassfish.embeddable.GlassFish; import org.glassfish.embeddable.GlassFishException; import org.glassfish.embeddable.GlassFishProperties; import org.glassfish.embeddable.GlassFishRuntime; public class EmbeddedGFRunner { public static void main(String[] args) throws GlassFishException { if(args.length != 3) { System.out.println("Usage > EmbeddedGFRunner \"port\" \"deployable.war\" \"contextRoot\""); System.exit(1); } int port = Integer.parseInt(args[0]); BootstrapProperties bootstrap = new BootstrapProperties(); GlassFishRuntime runtime = GlassFishRuntime.bootstrap(); GlassFishProperties glassfishProperties = new GlassFishProperties(); glassfishProperties.setPort("http-listener", port); GlassFish glassfish = runtime.newGlassFish(glassfishProperties); glassfish.start(); glassfish.getDeployer().deploy(new File(args[1]), "--contextroot", args[2]); } }

pack-dist

As I am a bit lazy and want to avoid copy jars manually I created a pom-project just to copy dependencies. The needed jar file will end up in the root folders under ./dist/, I also added a bat file to start the embedded Payara with the following content:
java -cp dist/gf-runner-1.0-SNAPSHOT.jar;dist/payara-embedded-all-4.1.152.1.jar se.ironic.gfrunner.EmbeddedGFRunner 2001 dist/task-web-1.0-SNAPSHOT.war task-web

I also tried the jersey-client from the previous post with s slight modification for the context-path and it still works. (or you can start the payara with "/" as context path)

In next part I will add a JSF client on top of this service to show some nice stuff in Java EE 7 and JSF 2.2.

[The full project can be found at: https://bitbucket.org/pejomstd/embedded-gf-payara]