Arquillian-Undertow-Extension - ShrinkWrap Question

[asotobu]

Hello, maybe I should move this topic on ShrinkWrap forum, but I think this is the right place to ask because involves Arquillian too.

I am developing a container extension for undertow. Currently I am developing the ShrinkWrap part and I have got some questions about how to develop it:

For example in undertow you need to register a servlet by calling something like:

.addServlets(servlet("MessageServlet", MessageServlet.class) .addInitParam("message", "Hello World") .addMapping("/*")

so apart from servlet class you also need to provide a name, init parameters, mapping, ... So it seems I need something more complex than WebArchive (or not IDK).

So in my opinion there are two possible solutions:

The first one use WebArchive and detect Servlet classes, when one Servlet class is detected then we can get that information (servletName and mapping) from Servlet class. I don't like this approach because we are cutting  the way how undertow configures servlets.

The other approach is creating a UndertowArchive which allow you to add all required information. The problem is that there are a lot of overridden methods  that has not sense.

Do you have any suggestion of how to attack this problem or any other plausible solution?

Thank you so much.

[kpiwko]

Hey Alex,

you're basically limited to implement https://github.com/arquillian/arquillian-core/blob/master/container/spi/src/main/java/org/jboss/arquillian/container/spi/client/container/DeployableContainer.java interface in Arquillian Undertow container. I don't see too many common stuff in UnderTow deployment representation https://github.com/undertow-io/undertow/blob/master/servlet/src/main/java/io/undertow/servlet/api/DeploymentInfo.java and ShrinkWrap Archive https://github.com/shrinkwrap/shrinkwrap/blob/master/api/src/main/java/org/jboss/shrinkwrap/api/Archive.java . Eventually, you could also implement UndertowDeploymentDescriptor as https://github.com/shrinkwrap/descriptors/blob/master/api-base/src/main/java/org/jboss/shrinkwrap/descriptor/api/Descriptor.java but that would metadata update difficult.

I'd go by implementing Assignable interface and require user to cast it to Archive<?> by hand. So it would look like following:

ShrinkWrap.create(UndertowArchive.class).from(DeploymentInfo.builder().foo().bar()).as(WebArchive.class);

This approach would allow you to reuse Undertow builders and will not directly expose Archive<?> methods to user, so you can safely stub them with UnsupportedOperationException. I'm using similar way within MavenImporter in ShrinkWrap Resolvers - https://github.com/shrinkwrap/resolver/blob/master/impl-maven-archive/src/main/java/org/jboss/shrinkwrap/resolver/impl/maven/archive/importer/MavenImporterImpl.java. Other option I can think of is implementing an UndertowAsset and make it a root resource but this will be awkward to use imho.

Another open question is whether you actually want to support deploying JavaArchive/WebArchive/EnterpriseArchive to Undertow container.

HTH,

Karel

[asotobu]

My original idea was to use WebArchive for Servlets, Filters, well all DeploymentInfo artifacts, and use JarArchive for Handlers. And maybe I will implement as your suggestion to avoid users to use invalid methods.