There are two main cases I want to cover here: port redirection and serving multiple protocols on one port. I'm pretty sure that covering both in one post would egregiously long so I'm going to break things up into two posts. In this first post, we'll cover what will likely the be more common use case: port redirection. In this example scenario, you only want to serve requests via https rather than http. In this case, you can configure GlassFish to return a 302 and push clients off to https transparently. This type of configuration has been available in GlassFish since at least v2 and is still available in v3. However, in v3 it wasn't "officially" supported so you had to manually massage your domain.xml. While documented in various blogs around net, it's not officially supported in v3. As of, well now I guess, that's all changed. I've added some asadmin commands to the 3.1 nightly builds that expose a more user friendly way to configure port unification. In this blog, I'll introduce these commands and show you how to set up a simple redirect to enforce https requests on a given listener. As always, when experimenting with this sort of thing, you should back up your domain.xml so if you hose your configuration, you can easily roll back to a working configuration.
There are two main concepts involved: <protocol-filter> and <protocol-finder>. There are a handful of other elements involved but we've hidden them from you by default since very few people will need to manage those elements. The first step is to create the <protocol-filter>:
asadmin create-protocol --securityenabled=false http-redirect asadmin create-protocol-filter --protocol http-redirect --classname com.sun.grizzly.config.HttpRedirectFilter redirect-filter
We need to create a new <protocol> element to hold our new filter first. You can't simply reuse, say, http-listener-1 because port unification elements and <http>/<ssl> can't coexist on the same protocol elements. You could of course issue a number of commands to preserve the name of http-listener-1 but the work involved is likely not worth it. It's certainly overkill for this example so I'll leave that as an exercise for you if you're that interested in it. The next asadmin command creates the actual protocol filter. With these two commands we have now have a new entry in our domain.xml that looks like this:
Notice that there are new elements: <protocol-chain-instance-handler> and <protocol-chain>. These are some implementation details that should be mostly irrelevant to all but a handful of users. I only mention them so that you'll be expecting to see them and that you know you can safely skip over them. With those pieces in place, we can now create our finders.
To create our finders, we need to create another <protocol> element to hold them and then create the finders themselves:
asadmin create-protocol --securityenabled=false pu-protocol asadmin create-protocol-finder --protocol pu-protocol --target-protocol http-listener-2 --classname com.sun.grizzly.config.HttpProtocolFinder http-finder asadmin create-protocol-finder --protocol pu-protocol --target-protocol http-redirect --classname com.sun.grizzly.config.HttpProtocolFinder http-redirect
Note that the first <protocol-finder> refers to the http-listener-2 <protocol>. We'll be using that protocol definition to configure the https processing. The second finder refers to the <http-finder protocol> definition we just created and it is this piece that will be doing the redirect from http->https for us. The first finder will trap all https requests and hand them off, while the second will handle all cleartext http requests and redirect for us. The resulting domain.xml elements looks like this:
Again, we silently create the <port-unification> element for you so you needn't worry about it. These elements that we silently create for you, we will also silently delete them for you when you delete the last elements contained in them. So those are our port unification elements. With those created, we just need to reconfigure listener to use these new elements:
asadmin set configs.config.server-config.network-config.network-listeners.network-listener.http-listener-1.protocol=pu-protocol
With that, we can try hitting port 8080 and see things in action. The easiest way to see this, probably, is to use wget:
wget -q -S http://localhost:8080/
With this command, you should see the following output:
HTTP/1.1 302 Moved Temporarily Location: https://localhost:8080/ Connection:close Cache-control: private
As you can see there, the server returns a 302 back to the client with the new location of https://localhost:8080. That's all it takes. Now every request will use https regardless of the original request. You could, of course, use a similar set up to push everyone from https back to http. This is especially useful for those without any need for https and are concerned about server load since https can be expensive to process.
In the next entry, I'll tackle the use case of serving up multiple protocols from one listener. This will be especially useful for those behind firewalls wanting to open only a single port to the outside world. Hopefully this will get you started. If you have any questions, feel free to leave a comment or ask on the glassfish users mailing list.
For convenience, here are all the commands necessary to try this out at home in one downloadable file:
wget -q -S http://localhost:8080/ asadmin create-protocol --securityenabled=false http-redirect asadmin create-protocol-filter --protocol http-redirect --classname com.sun.grizzly.config.HttpRedirectFilter redirect-filter asadmin create-protocol --securityenabled=false pu-protocol asadmin create-protocol-finder --protocol pu-protocol --target-protocol http-listener-2 --classname com.sun.grizzly.config.HttpProtocolFinder http-finder asadmin create-protocol-finder --protocol pu-protocol --target-protocol http-redirect --classname com.sun.grizzly.config.HttpProtocolFinder http-redirect asadmin set configs.config.server-config.network-config.network-listeners.network-listener.http-listener-1.protocol=pu-protocol wget -q -S http://localhost:8080/