Based on the version of JBoss / WildFly you are using, please use the quick links below to directly go to the associated chapter:
JBoss 4.0.x and 4.2.x
In JBoss 4.x, the JMX-based remote deployer can accept URLs that point to another machine. For example (please note that the URL is "beautified" to be across lines so it is readable):
http://10.156.216.147:8080/jmx-console/HtmlAdaptor
?action=invokeOpByName&name=jboss.system:service%3DMainDeployer
&methodName=deploy&argType=java.net.URL
&arg0=http%3A%2F%2F10.156.220.90%3A18080%2Fparuemas-1.0-SNAPSHOT.war
In this case, our JBoss server on 10.156.216.127 will connect to 10.156.220.90 via HTTP and download the paruemas-1.0-SNAPSHOT.war file. Once the file is downloaded, JBoss will automatically deploy it.
The Codehaus Cargo JBoss container uses this principle to expose your Java EE application to JBoss using an HTTP server that is started on the machine where Codehaus Cargo is currently running. That HTTP server is controlled using two parameters:
JBossPropertySet.REMOTEDEPLOY_HOSTNAME (i.e., cargo.jboss.remotedeploy.hostname ): sets the hostname that the JBoss server will attempt to connect to. By default, the Codehaus Cargo JBoss container will automatically resolve the current machine's network name or IP address and fill this accordingly.
JBossPropertySet.REMOTEDEPLOY_PORT (i.e., cargo.jboss.remotedeploy.port ): sets the port number on which the HTTP server will be started on the machine running Codehaus Cargo. By default, that one is set to 1 + the HTTP port for JBoss. For example, if JBoss is running on HTTP port 8080 , then the default for JBossPropertySet.REMOTEDEPLOY_PORT will be 18080 .
The obvious limitation you should be aware of is that JBoss needs to have direct access to the machine running Codehaus Cargo.
JBoss 5.0.x, 5.1.x, 6.0.x and 6.1.x
Starting from JBoss 5.x, JBoss has a Deployment Manager that can be used for deploying things on the JBoss server. If you really want to know how it works under the hood, you can read about this feature on the JBoss Website. If you only want to remotely deploy applications using Codehaus Cargo to your JBoss server, you can of course ignore that document.
To connect to the JBoss Deployment Manager, Codehaus Cargo uses JBoss' JMX RMI port; and that's what makes things get a bit complicated. For the connection to succeed, the following JARs need to be in the container classpath or in the current Java Thread's context classloader:
- JBoss deployment manager JARs
- JBoss remoting client JARs
Here is an example code for the users of the Java API:
List<URL> urls = new ArrayList<URL>();
// Add many libraries from JBOSS_HOME
for (File jar : new File(this.localContainer.getHome(), "lib").listFiles())
{
if (jar.isFile())
{
urls.add(jar.toURI().toURL());
}
}
for (File jar : new File(this.localContainer.getHome(), "common/lib").listFiles())
{
if (jar.isFile())
{
urls.add(jar.toURI().toURL());
}
}
// Create a ClassLoader contaning all these JARs
URL[] urlsArray = new URL[urls.size()];
urlsArray = urls.toArray(urlsArray);
URLClassLoader classLoader = new URLClassLoader(urlsArray, this.getClass().getClassLoader());
Thread.currentThread().setContextClassLoader(classLoader);
// Now, create the JBoss Remote container
...
Here is an example Maven 3 plugin configuration:
<!--
Some transitive dependencies of JBoss artifacts, for example apache-xerces:xml-apis, are
only available on the JBoss third party repository.
-->
<pluginRepositories>
<pluginRepository>
<id>repository.jboss.org_thirdparty-releases</id>
<name>JBoss.org third party releases repository</name>
<url>https://repository.jboss.org/nexus/content/repositories/thirdparty-releases</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>repository.jboss.org_thirdparty-uploads</id>
<name>JBoss.org third party uploads repository</name>
<url>https://repository.jboss.org/nexus/content/repositories/thirdparty-uploads</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<repositories>
<repository>
<id>repository.jboss.org_thirdparty-releases</id>
<name>JBoss.org third party releases repository</name>
<url>https://repository.jboss.org/nexus/content/repositories/thirdparty-releases</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
<repository>
<id>repository.jboss.org_thirdparty-uploads</id>
<name>JBoss.org third party uploads repository</name>
<url>https://repository.jboss.org/nexus/content/repositories/thirdparty-uploads</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
...
<plugin>
<groupId>org.codehaus.cargo</groupId>
<artifactId>cargo-maven3-plugin</artifactId>
<version>${cargo.plugin.version}</version>
<configuration>
<container>
<containerId>jboss51x</containerId>
<type>remote</type>
</container>
<configuration>
<type>runtime</type>
<properties>
<cargo.hostname>production27</cargo.hostname>
<cargo.rmi.port>11099</cargo.rmi.port>
</properties>
</configuration>
</configuration>
<dependencies>
<dependency>
<groupId>org.jboss.integration</groupId>
<artifactId>jboss-profileservice-spi</artifactId>
<version>5.1.0.GA</version>
</dependency>
<dependency>
<groupId>org.jboss.jbossas</groupId>
<artifactId>jboss-as-client</artifactId>
<version>5.1.0.GA</version>
<type>pom</type>
</dependency>
</dependencies>
</plugin>
You can also use the Codehaus Cargo JBoss remote deployer to remotely deploy to JBoss farms versions 5.x and newer. To do so, use these two properties:
cargo.jboss.clustered : if true , deployment is done in the farm directory
cargo.jboss.configuration : JBoss profile name, default name is default
JBoss 7.0.x onwards / WildFly 8.x onwards
The same instructions for JBoss 5.x, 5.1.x and 6.x also apply for JBoss 7.0.x onwards as well as WildFly 8.x onwards, with some differences:
- The JAR files to include are different
- JBoss (Application Server) as well as JBoss Enterprise Application Platform (EAP) 6.x use the
cargo.jboss.management-native.port port
- All WildFly versions as well as JBoss Enterprise Application Platform (EAP) 7.x use the
cargo.jboss.management-http.port port
The following examples detail these differences.
Here is an example code for the users of the Java API:
/**
* Add all JARs in a folder in the list of files (recursive).
* @param folder Folder to recursively scan.
* @param files List containing all files.
*/
public static void addAllJars(File folder, List<URL> files) throws Exception
{
if (folder.isDirectory())
{
for (File file : folder.listFiles())
{
if (file.isFile() && file.getName().endsWith(".jar"))
{
files.add(file.toURI().toURL());
}
else if (file.isDirectory())
{
addAllJars(file, files);
}
}
}
}
List<URL> urls = new ArrayList<URL>();
// Add many libraries from JBOSS_HOME/modules
addAllJars(new File(this.localContainer.getHome(), "modules"), urls);
// Create a ClassLoader contaning all these JARs
URL[] urlsArray = new URL[urls.size()];
urlsArray = urls.toArray(urlsArray);
URLClassLoader classLoader = new URLClassLoader(urlsArray, this.getClass().getClassLoader());
Thread.currentThread().setContextClassLoader(classLoader);
// Now, create the JBoss Remote container
...
Here is an example Maven 3 plugin configuration:
<plugin>
<groupId>org.codehaus.cargo</groupId>
<artifactId>cargo-maven3-plugin</artifactId>
<version>${cargo.plugin.version}</version>
<configuration>
<container>
<containerId>jboss7x</containerId>
<type>remote</type>
</container>
<configuration>
<type>runtime</type>
<properties>
<cargo.hostname>production27</cargo.hostname>
<cargo.jboss.management-native.port>19999</cargo.jboss.management-native.port>
</properties>
</configuration>
</configuration>
<dependencies>
<dependency>
<groupId>org.jboss.as</groupId>
<artifactId>jboss-as-controller-client</artifactId>
<version>7.0.2.Final</version>
</dependency>
</dependencies>
</plugin>
|