webserver

Guice WebServer Module - backed by latest Jetty, Jersey and Jackson. Without HK2-Guice bridge.

Library is useful for lite web services. Following JAX-RS convention it's so easy to write from simple to very complex REST endpoints. Library is simple, fast with small footprint. The library is written to fully support JSON as input and output format.

Dependencies

• Guice
• Jetty
• Jersey
• Jackson 2 (Transitive)

Installation

In your POM file, add following dependency:

<dependency>
  <groupId>com.sorskod.webserver</groupId>
  <artifactId>webserver</artifactId>
  <version>1.1.0</version>
</dependency>

Note: You may want to check for the latest version.

Snapshot installation

For the latest snapshot version, you need to add add OSS Sonartype repository to your POM file and the following dependency:

<project>
    <repositories>
        <repository>
            <id>oss-sonatype</id>
            <name>oss-sonatype</name>
            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>
    
    <dependencies>
        <dependency>
          <groupId>com.sorskod.webserver</groupId>
          <artifactId>webserver</artifactId>
          <version>1.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

Usage

There is a working example in test package. However, here is the short guideline:

1. Bind all JAX-RS resource classes in Guice context. (All classes annotated with @Path will be registered in Jersey's context. Jersey's auto-discovery feature is disabled.)
2. Install WebServerModule
3. Install HTTPConnectorModule or/and HTTPSConnectorModule
4. Provide Configurator implementation
5. Inject Jetty Server and call start()

Example:

public class MyModule extends AbstractModule {
  
  protected void configure() {
    
    // Bind @Path annotated classes
    bind(MyHttpResource.class);
  }
  
  @Provides
  @DefaultConnector
  Configurator configuratorProvider() {
    return () -> 8080; // WebServer port 
  }
  
  @ProvidesIntoSet
  Feature customJaxrsFeature() {
    // Provide custom features, register filters, etc 
    return (context) -> {};
  }
}

Injector injector = Guice.createInjector(new WebServerModule(), 
                                         new HTTPConnectorModule(),
                                         new MyModule());


injector.getInstance(Server.class).start();

NOTE

Library is written for fun and test purposes. Pull requests and improvement ideas are welcome.

TODO

• Remove HK2 and make Guice as only DI framework (Hard to accomplish)
• README & Wiki
• Example project