org.glassfish.grizzly.web.embed
Class GrizzlyWebServer

java.lang.Object
  org.glassfish.grizzly.web.embed.GrizzlyWebServer

public class GrizzlyWebServer
extends Object

This class creates a WebServer that listen for http request. By default, creating an instance of this class can be used as it is to synchronously serve resources located under webResourcesPath. By default, the StaticResourcesAdapter is used when there is no GrizzlyAdapter specified. The StaticResourcesAdapter allow servicing of static resources like html files, images files, etc. The GrizzlyAdapter provides developpers with a simple and consistent mechanism for extending the functionality of the Grizzly WebServer and for bridging existing http based technology like JRuby-on-Rail, Servlet, Bayeux Protocol or any http based protocol.

You can extend the GrizzlyWebServer by adding one or serveral GrizzlyAdapter. If more that one are used, the GrizzlyAdapterChain will be used to map the request to its associated GrizzlyAdapters, using a Mapper. A GrizzlyAdapter gets invoked as soon as the http request has been parsed and decoded. The GrizzlyAdapter#service(org.glassfish.grizzly.web.container.http11.GrizzlyRequest, corg.glassfish.grizzly.web.container.http11.GrizzlyResponse) method is invoked with a GrizzlyRequest and GrizzlyResponse that can be used to extend the functionality of the Web Server. By default, all http requests are synchronously executed.

Asynchronous request processing is automatically enabled as soon as one or several AsyncFilter are added, using the #addAsyncHandler method. AsyncFilter can be used when asynchronous operation are required, like suspending the current http request, delaying the invokation of GrizzlyAdapter etc. The state of the request processing can be managed using AsyncExecutor, like resuming the process so GrizzlyAdapters can be invoked.

The following picture describes how AsyncFilter and GrizzlyAdapter are invoked.

 ----------------------------------------------------------------------------
 - AsyncFilter.doFilter() ---> AsyncExecutor.execute()    -------|          -
 -                                                               |          -
 -                                                               |          -
 -                                                               |          -
 - AsyncFilter.doFilter() <-- GrizzlyAdapter2.service()   <------|          -
 ----------------------------------------------------------------------------
 

Here is some examples:

 Synchronous Web Server servicing static resources
        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        } 

 Synchronous Web Server servicing customized resources
        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            ws.addGrizzlyAdapter(new GrizzlyAdapter(){  

                public void service(GrizzlyRequest request, GrizzlyResponse response){
                    try {
                        response.getWriter().println("Grizzly is soon cool");
                    } catch (IOException ex) {                        
                    }
                }
            });
            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        } 
 Synchronous Web Server servicing a Servlet

        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            ServletAdapter sa = new ServletAdapter();
            sa.setRootFolder("/Path/To/Exploded/War/File");
            sa.setServlet(new MyServlet());
            ws.addGrizzlyAdapter(sa);
            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        } 
 Synchronous Web Server servicing two Servlet

        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            ServletAdapter sa = new ServletAdapter();
            sa.setRootFolder("/Path/To/Exploded/War/File");
            sa.setServlet(new MyServlet());
            ws.addGrizzlyAdapter(sa);

            ServletAdapter sa = new ServletAdapter();
            sa.setRootFolder("/Path/To/Exploded/War2/File");
            sa.setServlet(new MySecondServlet());
            ws.addGrizzlyAdapter(sa);

            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        } 
 
 Asynchronous Web Server servicing customized resources
 The example below delay the request processing for 10 seconds, without holding 
 a thread.
 
        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            ws.addAsyncFilter(new AsyncFilter() {
                private final ScheduledThreadPoolExecutor scheduler = 
                        new ScheduledThreadPoolExecutor(1);
                public boolean doFilter(final AsyncExecutor asyncExecutor) {
                    //Throttle the request
                    scheduler.schedule(new Callable() {
                        public Object call() throws Exception {
                            asyncExecutor.execute();
                            asyncExecutor.postExecute();
                            return null;
                        }
                    }, 10, TimeUnit.SECONDS);

                    // Call the next AsyncFilter
                    return true;
                }
            });

            ws.addGrizzlyAdapter(new GrizzlyAdapter(){                  
                public void service(GrizzlyRequest request, GrizzlyResponse response){
                    try {
                        response.getWriter().println("Grizzly is soon cool");
                    } catch (IOException ex) {                        
                    }
                }
            });
            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        } 
 Asynchronous Web Server servicing Servlet
 The example below delay the request processing for 10 seconds, without holding 
 a thread.
 
        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            ws.addAsyncFilter(new AsyncFilter() {
                private final ScheduledThreadPoolExecutor scheduler = 
                        new ScheduledThreadPoolExecutor(1);
                public boolean doFilter(final AsyncExecutor asyncExecutor) {
                    //Throttle the request
                    scheduler.schedule(new Callable() {
                        public Object call() throws Exception {
                            asyncExecutor.execute();
                            asyncExecutor.postExecute();
                            return null;
                        }
                    }, 10, TimeUnit.SECONDS);

                    // Call the next AsyncFilter
                    return true;
                }
            });

            ServletAdapter sa = new ServletAdapter();
            sa.setRootFolder("/Path/To/Exploded/War/File");
            sa.setServlet(new MyServlet());
            ws.addGrizzlyAdapter(sa);

            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        }  
 Asynchronous Web Server servicing Servlet and supporting the Bayeux Protocol

        GrizzlyWebServer ws = new GrizzlyWebServer("/var/www");
        try{
            // Add Comet Support
            ws.addAsyncFilter(new CometAsyncFilter());

            //Add Bayeux support
            CometdAdapter cometdAdapter = new CometdAdapter();
            ws.addGrizzlyAdapter(cometdAdapter);

            ServletAdapter sa = new ServletAdapter();
            sa.setRootFolder("/Path/To/Exploded/War/File");
            sa.setServlet(new MyServlet());
            ws.addGrizzlyAdapter(sa);

            ws.start();
        } catch (IOException ex){
            // Something when wrong.
        } 
 Synchronous Web Server servicing static resources eand exposed using JMX Mbeans

        GrizzlyWebServer ws = new GrizzlyWebServer(path);    
        ws.enableJMX(new Management() {

            public void registerComponent(Object bean, ObjectName oname, String type) 
                    throws Exception{
                Registry.getRegistry().registerComponent(bean,oname,type);
            }

            public void unregisterComponent(ObjectName oname) throws Exception{
                Registry.getRegistry().
                        unregisterComponent(oname);
            }  
        });
        ws.start();
    }
}
 Synchronous Web Server servicing two Servlet
 
      GrizzlyWebServer ws = new GrizzlyWebServer(path);
        ServletAdapter sa = new ServletAdapter();
        sa.setRootFolder(".");
        sa.setServletInstance(new ServletTest("Adapter-1"));
        ws.addGrizzlyAdapter(sa, new String[]{"/Adapter-1"});

        ServletAdapter sa2 = new ServletAdapter();
        sa2.setRootFolder("/tmp");
        sa2.setServletInstance(new ServletTest("Adapter-2"));
        ws.addGrizzlyAdapter(sa2, new String[]{"/Adapter-2"});

        System.out.println("Grizzly WebServer listening on port 8080");
        ws.start();

  * Synchronous Web Server servicing two Servlet using SSL

        GrizzlyWebServer ws = new GrizzlyWebServer(443,path,5,true);
        SSLContextConfigurator sslConfig = new SSLContextConfigurator();
        sslConfig.setTrustStoreFile("Path-to-trustore");
        sslConfig.setKeyStoreFile("Path-to-Trustore");
        ws.setSSLConfiguration(new SSLEngineConfigurator(
                sslConfig.createSSLContext(), false, false, false);

        ServletAdapter sa = new ServletAdapter();
        sa.setRootFolder(".");
        sa.setServletInstance(new ServletTest("Adapter-1"));
        ws.addGrizzlyAdapter(sa, new String[]{"/Adapter-1"});

        ServletAdapter sa2 = new ServletAdapter();
        sa2.setRootFolder("/tmp");
        sa2.setServletInstance(new ServletTest("Adapter-2"));
        ws.addGrizzlyAdapter(sa2, new String[]{"/Adapter-2"});

        System.out.println("Grizzly WebServer listening on port 8080");
        ws.start();
 

Author:

Jeanfrancois Arcand, Alexey Stashok

Constructor Summary

GrizzlyWebServer()
Create a default GrizzlyWebServer

GrizzlyWebServer(int port)
Create a WebServer that listen on port

GrizzlyWebServer(int port, String webResourcesPath)
Create a WebServer that listen on port

GrizzlyWebServer(int port, String webResourcesPath, boolean isSecure)
Create a WebServer that listen for secure tls/https requests

GrizzlyWebServer(String webResourcesPath)
Create a WebServer which server files from webResourcesPath

Method Summary

void	addAsyncFilter(AsyncFilter asyncFilter) Add an AsyncFilter.
void	addGrizzlyAdapter(GrizzlyAdapter grizzlyAdapter, String[] mapping) Add a GrizzlyAdapter with its associated mapping.
void	enableJMX(Management jmxManagement) Enable JMX Management by configuring the Management
String	getHost() Get host, on which GrizzlyWebServer listens.
int	getPort() Get port, on which GrizzlyWebServer listens.
SSLEngineConfigurator	getSSLConfiguration() Get the secured connection configuration.
Statistics	getStatistics() Return a Statistics instance that can be used to gather statistics.
Transport	getTransport() Get GrizzlyWebServer underlying Transport.
AsyncWebFilterConfig	getWebConfig() Get GrizzlyWebServer underlying AsyncWebFilterConfig.
boolean	isSecure() Returns true, if secured connections is enabled, or false otherwise
static GrizzlyWebServer	newConfiguredInstance(String path) Return an already configured GrizzlyWebServer that can serves static resources.
boolean	removeGrizzlyAdapter(GrizzlyAdapter grizzlyAdapter) Remove a GrizzlyAdapter return true, if the operation was successful.
void	setHost(String host) Set host, on which GrizzlyWebServer listens.
void	setPort(int port) Set port, on which GrizzlyWebServer listens.
void	setSecure(boolean isSecure) Adjust the secured connection mode.
void	setSSLConfiguration(SSLEngineConfigurator sslConfiguration) Set the secured connection configuration.
void	setTransport(Transport transport) Set GrizzlyWebServer underlying Transport.
void	setWebFilter(AsyncWebFilterConfig webConfig) Set GrizzlyWebServer underlying AsyncWebFilterConfig.
void	start() Start the GrizzlyWebServer and start listening for http requests.
void	stop() Stop the GrizzlyWebServer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrizzlyWebServer

public GrizzlyWebServer()

Create a default GrizzlyWebServer

GrizzlyWebServer

public GrizzlyWebServer(int port)

Create a WebServer that listen on port

Parameters:

port - The port opened

GrizzlyWebServer

public GrizzlyWebServer(String webResourcesPath)

Create a WebServer which server files from webResourcesPath

Parameters:

webResourcesPath - the path to the web resource (ex: /var/www)

GrizzlyWebServer

public GrizzlyWebServer(int port,
                        String webResourcesPath)

Create a WebServer that listen on port

Parameters:

port - The port opened

webResourcesPath - the path to the web resource (ex: /var/www)

GrizzlyWebServer

public GrizzlyWebServer(int port,
                        String webResourcesPath,
                        boolean isSecure)

Create a WebServer that listen for secure tls/https requests

Parameters:

port - The port opened

webResourcesPath - the path to the web resource (ex: /var/www)

secure - true if https needs to be used.

Method Detail

addAsyncFilter

public void addAsyncFilter(AsyncFilter asyncFilter)

Add an AsyncFilter. Adding AsyncFilter automatically enable Grizzly Asynchronous Request Processing mode. AsyncFilters are always invoked before GrizzlyAdapter

Parameters:

asyncFilter - An AsyncFilter

addGrizzlyAdapter

public void addGrizzlyAdapter(GrizzlyAdapter grizzlyAdapter,
                              String[] mapping)

Add a GrizzlyAdapter with its associated mapping. A request will be dispatched to a GrizzlyAdapter based on its mapping value.

Parameters:

grizzlyAdapter - a GrizzlyAdapter

mapping - An array contains the context path mapping information.

removeGrizzlyAdapter

public boolean removeGrizzlyAdapter(GrizzlyAdapter grizzlyAdapter)

Remove a GrizzlyAdapter return true, if the operation was successful.

isSecure

public boolean isSecure()

Returns true, if secured connections is enabled, or false otherwise

Returns:

true, if secured connections is enabled, or false otherwise

setSecure

public void setSecure(boolean isSecure)

Adjust the secured connection mode.

Parameters:

isSecure - true, if secured connections should be enabled, or false otherwise

getSSLConfiguration

public SSLEngineConfigurator getSSLConfiguration()

Get the secured connection configuration.

Returns:

the secured connection configuration.

setSSLConfiguration

public void setSSLConfiguration(SSLEngineConfigurator sslConfiguration)

Set the secured connection configuration.

Parameters:

sslConfiguration - the secured connection configuration.

getTransport

public Transport getTransport()

Get GrizzlyWebServer underlying Transport.

Returns:

GrizzlyWebServer underlying Transport.

setTransport

public void setTransport(Transport transport)

Set GrizzlyWebServer underlying Transport.

Parameters:

transport - GrizzlyWebServer underlying Transport.

getWebConfig

public AsyncWebFilterConfig getWebConfig()

Get GrizzlyWebServer underlying AsyncWebFilterConfig.

Returns:

GrizzlyWebServer underlying AsyncWebFilterConfig.

setWebFilter

public void setWebFilter(AsyncWebFilterConfig webConfig)

Set GrizzlyWebServer underlying AsyncWebFilterConfig.

Parameters:

webFilter - GrizzlyWebServer underlying AsyncWebFilterConfig.

getHost

public String getHost()

Get host, on which GrizzlyWebServer listens. Default value is 0.0.0.0

Returns:

host, on which GrizzlyWebServer listens.

setHost

public void setHost(String host)

Set host, on which GrizzlyWebServer listens. Default value is 0.0.0.0

Parameters:

host - The host, on which GrizzlyWebServer listens.

getPort

public int getPort()

Get port, on which GrizzlyWebServer listens. Default value is 8080.

Returns:

port, on which GrizzlyWebServer listens.

setPort

public void setPort(int port)

Set port, on which GrizzlyWebServer listens. Default value is 8080.

Parameters:

port - The port, on which GrizzlyWebServer listens.

start

public void start()
           throws IOException

Start the GrizzlyWebServer and start listening for http requests. Calling this method several time has no effect once GrizzlyWebServer has been started.

Throws:

IOException

enableJMX

public void enableJMX(Management jmxManagement)

Enable JMX Management by configuring the Management

Parameters:

jmxManagement - An instance of the Management interface

getStatistics

public Statistics getStatistics()

Return a Statistics instance that can be used to gather statistics. By default, the Statistics object is not gathering statistics. Invoking Statistics.startGatheringStatistics() will do it.

stop

public void stop()

Stop the GrizzlyWebServer.

newConfiguredInstance

public static final GrizzlyWebServer newConfiguredInstance(String path)

Return an already configured GrizzlyWebServer that can serves static resources.

Parameters:

path - the directory to serve static resource from.

Returns:

a ready to use GrizzlyWebServer that listen on port 8080