JBoss.orgCommunity Documentation

Chapter 13. Complete Protocol Reference

13.1. Local
13.1.1. Configuration
13.2. Servlet 2.5
13.2.1. Configuration
13.3. Servlet 3.0
13.3.1. Configuration

13.1. Local

The Local Protocol implementation is used by most EE5 compliant containers. It does nothing to the deployment. The Local Protocol is also used when executing in run mode as client.

Table 13.1. Packaging rules

@DeploymentOutputAction
JavaArchiveJavaArchiveDoes nothing.
WebArchiveWebArchiveDoes nothing.
EnterpriseArchiveEnterpriseArchiveDoes nothing.

Table 13.2. Protocol Configuration Options

NameTypeDefaultDescription
    

13.2. Servlet 2.5

The Servlet 2.5 Protocol implementation is used by most EE5 compliant containers. It will attempt to add a war to the deployment.

Table 13.3. Packaging rules

@DeploymentOutputAction
JavaArchiveEnterpriseArchiveCreate a new EnterpriseArchive, add @Deployment and ServletProtocol as module, the other Auxiliary Archives as libraries.
WebArchiveWebArchive If a web.xml is found, a Servlet will be added, else a web.xml will be added. The Servlet WebArchive will be merged with the Deployment and the Auxiliary Archives added as libraries.
EnterpriseArchiveEnterpriseArchiveSame as JavaArchive, but using the @Deployment defined EnterpriseArchive instead of creating a new.

Table 13.4. Protocol Configuration Options

NameTypeDefaultDescription
hostStringnoneUsed to override the Deployments default hostname.
portStringnoneUsed to override the Deployments default http port.
contextRootintnoneUsed to override the Deployments default contextRoot.

13.3. Servlet 3.0

The Servlet 3.0 Protocol implementation is used by most EE6 compliant containers. It will attempt to add a web-fragment to the deployment.

Table 13.5. Packaging rules

@DeploymentOutputAction
JavaArchiveWebArchiveCreates a new WebArchive, adds @Deployment and Auxiliary Archives as libraries.
WebArchiveWebArchiveAdds @Deployment and Auxiliary Archives as libraries.
EnterpriseArchiveEnterpriseArchive If a single WebArchive is found, the same as for WebArchive is done. If no WebArchives are found a new one is creates, adds @Deployment and Auxiliary Archives as libraries. If multiple WebArchives are found, a exception is thrown.

Table 13.6. Protocol Configuration Options

NameTypeDefaultDescription
hostStringnoneUsed to override the Deployments default hostname.
portStringnoneUsed to override the Deployments default http port.
contextRootintnoneUsed to override the Deployments default contextRoot.