Page Comparison

...

• Subscribe to the cargo dev mailing list and ask as many question you'd like there!
• Create a JIRA issue on http://jira.codehaus.org (you'll need to register). We'll then add you to the cargo-developers group in JIRA and assign the issue to you
• Checkout Cargo from SVN trunk
• Understand the Cargo project's directory structure. Container implementations are located in trunk/core/containers/ContainerName.
• Have a look at existing container implementations (search for example for Resin3xLocalContainer or Orion2xLocalContainer).Create a org.codehaus.cargo.container.containerName package if it doesn't already exist
  • Some containers are simple to read and understand; for example jo or glassfish
  • Some other containers are much more feature-complete (remote deployers, datasources, etc.); for example tomcat or jonas.
• Create your container's Maven module, with its package inside.
• Create the following classes:
  • A container implementation class named _ServerNameNxContainerType_Container where ServerName is the name of the container, Nx the version and ContainerType the type of container (InstalledLocal or Remote). For example: JBoss3xLocalContainer.
  • One or several configuration implementation classes named _ServerNameConfigurationType_Configuration where ConfigurationType can be StandaloneLocal, ExistingLocal or Runtime. For example JBossStandaloneLocalConfiguration.
  • One or several deployer implementation classes named _ServerNameDeployerType_Deployer where DeployerType can be InstalledLocal or Remote. For example: JBossInstalledLocalDeployer.
  • You may need to implement some ancillary classes but those are the main 2 required. Check how the other container are implemented to see how to implement them and what other classes you may need to implementFinally, implement the FactoryRegistry that will register your container to CARGO.
• Cargo has an SPI that you should use and that should make it easy for you. Your container class should extend org.codehaus.cargo.container.spi.Abstract_ContainerType_Container and your configuration class should extend org.codehaus.cargo.container.spi.configuration.Abstract_ConfigurationType_Configuration.
• Register your new classes in the generic API in the Factory classes trunk/core/api/generic so that users can use your new container by using the generic APIMake sure you've defined a link to your container's factory registry in src/main/resources/META-INF/services/org.codehaus.cargo.generic.AbstractFactoryRegistry.
• Run the Cargo build to ensure everything is working. You'll probably find that you haven't followed the Cargo project's coding conventions... Fix those and build again until it passes! Please note that when you run the build it'll automatically run the samples test suites in your container (provided you've added your container to the generic API as described in the previous step and provided you've defined the right capabilities for your container). See the Building page for more details on the build.
• Once built, add your new container to the samples and the uberjar.
  • As soon as you add your container to the samples, the Maven build will automatically attempt to start your container.
• Register on Codehaus' confluence. Once this is done I'll add you to the cargo-developers user group so that you have the right to edit yourself the Cargo web site pages
• Document the new container on the Cargo web site
• Create a SVN patch and attach it to the JIRA issue you have created above
• Once the patch has been accepted:
  • Add the container to the Containers list on the main web site
  • Add the container to the Navigation page (left side of the CARGO Web site)
  • Add the container to the Downloads page
  • Add the container to the Continous integration so that its integrity can be checked at each build

Thanks and happy coding!