Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current ·  View Page History
<< Previous Version 29 Next >>

Definition

Properties to configure a container (request port, shutdown port, logging level, threads, etc)

Explanations

It is possible to set container configuration properties using the Cargo API. These properties are applied to a Configuration.

There are 2 kinds of properties:

  • General properties
  • Container-specific properties. See each container's page for a list of all the properties it supports.

Some general properties:

Property name

Java constant (for the Java API)

Description

Valid values

Default value

Example

cargo.hostname

GeneralPropertySet.HOSTNAME

Host name on which the container listens to

string

"localhost"

"myserver"

cargo.jvmargs

GeneralPropertySet.JVMARGS

JVM args to be used when starting/stopping containers

string

N/A

"-Xmx500m"

cargo.logging

GeneralPropertySet.LOGGING

Level representing the quantity of information we wish to log

"low", "medium" or "high"

"medium"

"high"

cargo.protocol

GeneralPropertySet.PROTOCOL

Protocol on which the container is listening to

"http", "https"

"http"

"http"

cargo.remote.password

RemotePropertySet.PASSWORD

Password to use to authenticate against a remote container (when deploying for example)

string

Depends on the container

"manager"

cargo.remote.username

RemotePropertySet.USERNAME

Username to use to authenticate against a remote container (when deploying for example)

string

Depends on the container

"system"

cargo.rmi.port

GeneralPropertySet.RMI_PORT

The port to use when communicating with this server, for example to start and stop it

integer

Depends on the container

"1099"

cargo.servlet.port

ServletPropertySet.PORT

Port on which the Servlet/JSP container listens to

integer

"8080"

"8280"

cargo.servlet.users

ServletPropertySet.USERS

Allow defining users and map to roles

string

N/A

"name1:pwd1:role11,...,role1N|name2:pwd2:role21,...,role2N|..."

Support Matrix

Java

Ant

Maven2

IntelliJ IDEA

Netbeans

(tick)

(tick)

(tick)

(question)

(question)

Java API

Example of starting Tomcat 5.x on port 8081:

You can check if a configuration supports a given property by using Configuration.getCapability().supportsProperty(String propertyName).

For example if you want to check if the configuration supports setting the port property:

Ant Task

Example of starting Tomcat 5.x on port 8081:

Maven 2 Plugin

Example of starting Tomcat 5.x on port 8081:

Labels
  • None