This documentation relates to Crowd 2.4.
If you are using an earlier version, please view the previous versions of the Crowd documentation and select the relevant version.
Skip to end of metadata
Comment: Corrected links that should have been relative instead of absolute.
Go to start of metadata

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 at the root of your Crowd Home directory. (See Important Directories and Files for more about the Crowd Home directory.)

Attributes of the crowd.properties File

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.

crowd.base.url

The URL used by Crowd to create the full URL to be sent to users that reset their passwords.

session.isauthenticated

The session key to use when storing a Boolean value indicating whether the user is authenticated or not.

session.tokenkey

The session key to use when storing a String value of the user's authentication token.

session.validationinterval

The number of minutes to cache authentication validation in the session. If this value is set to 0, each HTTP request will be authenticated with the Crowd server.

session.lastvalidation

The session key to use when storing a Date value of the user's last authentication.

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.

5000

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.
As well as allowing you to define the SSO cookie name, this feature also allows you to divide your applications into different SSO groups. For example, you might use one SSO token for your public websites and another for your internal websites.

crowd.token_key

Passing crowd.properties as an Environment Variable

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:

RELATED TOPICS

Passing the crowd.properties File as an Environment Variable
Important Directories and Files
Adding an Application

Labels:
None
Edit Labels

2 Comments

Hide/Show Comments

  1. Mar 04, 2011

    Ivar Sønstabø

    Please note: Opening the CROWD file in Notepad (Win2008/R2) will play a trick on you as it is very difficult to differentiate the parameters from each other. It should look something like this: 

    application.name                        crowd
    application.password                    sDRkwFwX
    application.login.url                   http://localhost:8095/crowd/console/
    crowd.server.url                        http://localhost:8095/crowd/services/
    crowd.base.url                          http://localhost:8095/crowd/
    session.isauthenticated                 session.isauthenticated
    session.tokenkey                        session.tokenkey
    session.validationinterval              0
    session.lastvalidation                  session.lastvalidation

    But might often look like this 

    application.name                        crowdapplication.password                    sDRkwFwX application.login.url                   http://localhost:8095/crowd/console/ crowd.server.url                        http://localhost:8095/crowd/services/crowd.base.url                        http://localhost:8095/crowd/session.isauthenticated                 session.isauthenticatedsession.tokenkey                        session.tokenkeysession.validationinterval              0session.lastvalidation                  session.lastvalidation

    1. Aug 08, 2011

      Anonymous

      This is because the file has Unix-style end-of-line characters (a newline instead of the Windows style carriage return/newline combination).  Most text editors targeted at developers will have an option for displaying and editing these files correctly.