Documentation for Crowd 1.4. Documentation for other versions of Crowd is available too.
When integrating an application with Crowd, you will copy Crowd's client library and the crowd.properties
configuration file into the application's library. For details of the procedure, refer to Adding an Application.
The Crowd Administration Console application also has its own crowd.properties
file, which is located in the Crowd Installation directory at
{CROWD_INSTALL}\crowd-webapp\WEB-INF\classes
Attribute |
Description |
---|---|
application.name |
The name that the application will use when authenticating with the Crowd server. This needs to match the name you specified in Adding an Application. |
application.password |
The password that the application will use when authenticating with the Crowd server. This needs to match the password you specified in Adding an Application. |
application.login.url |
Crowd will redirect the user to this URL if their authentication token expires or is invalid due to security restrictions. |
crowd.server.url |
The URL to use when connecting with the integration libraries to communicate with the Crowd server. |
session.isauthenticated |
The session key to use when storing a |
session.tokenkey |
The session key to use when storing a |
session.validationinterval |
The session key to use when storing an |
session.lastvalidation |
The session key to use when storing a |
The following optional attributes in the crowd.properties
file allow further customisation of the client:
Attribute |
Description |
Default Value |
---|---|---|
http.proxy.host |
The name of the proxy server used to transport SOAP traffic to the Crowd server. |
(none) |
http.proxy.port |
The connection port of the proxy server (must be specified if a proxy host is specified). |
(none) |
http.proxy.username |
The username used to authenticate with the proxy server (if the proxy server requires authentication). |
(none) |
http.proxy.password |
The password used to authenticate with the proxy server (if the proxy server requires authentication). |
(none) |
http.max.connections |
The maximum number of HTTP connections in the connection pool for communication with the Crowd server. |
20 |
http.timeout |
The HTTP connection timeout (milliseconds) used for communication with the Crowd server. A value of zero indicates that there is no connection timeout. |
0 |
cookie.tokenkey |
When using Crowd for single sign-on (SSO), you can specify the SSO cookie name for each application. Under the standard configuration, Crowd will use a single, default cookie name for all Crowd-connected applications. You can override the default with your own cookie name. |
crowd.token_key |
You can pass the location of a client application's crowd.properties
file to the client application as an environment variable when starting the client application. This means that you can choose a suitable location for the crowd.properties
file, instead of putting it in the client application's WEB-INF/classes
directory.
This applies to the Crowd Administration Console's crowd.properties
file too. You may find this particularly useful when integrating with a WAR deployment of an integrated application.
Example:
-Dcrowd.properties={FILE-PATH}/crowd.properties
Passing the crowd.properties File as an Environment Variable
Important Directories and Files
Adding an Application