The crowd.properties File

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

属性	説明
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:

属性	説明	既定値
http.proxy.host	The name of the proxy server used to transport SOAP traffic to the Crowd server.	(なし)
http.proxy.port	The connection port of the proxy server (must be specified if a proxy host is specified).	(なし)
http.proxy.username	The username used to authenticate with the proxy server (if the proxy server requires authentication).	(なし)
http.proxy.password	The password used to authenticate with the proxy server (if the proxy server requires authentication).	(なし)
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. 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.

例:

-Dcrowd.properties={FILE-PATH}/crowd.properties

Child pages

Attributes of the crowd.properties File

Passing crowd.properties as an Environment Variable

関連トピック