Documentation for Crowd 1.5. Documentation for other versions of Crowd is available too.

Caching is used to store run-time authentication and authorisation rules, which can be expensive to calculate.

In Crowd, data caching occurs in two main areas:

  • The Crowd server itself — To improve performance, Crowd can store users' authentication and per-application permissions in a local cache for a specified period. You can enable or disable this cache via an option on the 'General Options' screen in the Crowd Administration Console. This option is described below.
  • The applications that are connected to Crowd — Applications, such as JIRA, Confluence and Bamboo, can store user, group and role data in a local cache. This helps improve the performance of Crowd since these applications do not have to repeatedly request information from Crowd. Generally it is not necessary to configure application caching, although this depends on the size of your application deployments. You can set the options for application caching in the cache configuration file for that application. See Configuring Caching for an Application.

Caching of Users' Application Permissions on the Crowd Server — The Authorisation Cache

Crowd can store users' authentication and per-application permissions in a local cache for a specified period after retrieving the information from the directory and application data. The cached data will answer the following questions:

  • For a particular user: Is the user authenticated?
  • For a particular user and application: Does the user have access to the application?

Recommended setting: Enabled. For performance reasons, we recommend that the cache be enabled on the Crowd server. This is the default setting.

The effect of caching the data is that users will retain access to applications for a period after their username or permission has been removed, i.e. until the server-side cache expires. You should disable the cache only if you need immediate results when removing users or their permissions.

To enable caching of user-to-application permissions on the Crowd server,

  1. Log in to the Crowd Administration Console.
  2. Click the 'Administration' tab in the top navigation bar.
  3. The 'General Options' screen will appear. Put a tick in the 'Enable Data Caching' checkbox.
  4. Click the 'Update' button.

Screenshot: 'Caching'



Some applications may enable/disable caching based on the Crowd server setting

The Crowd API allows an application to query whether caching is enabled on the Crowd server (isCacheEnabled). The Crowd Java client does not make use of this API feature, because it makes more sense to have application caching configured entirely on the application side. If you have a Crowd-integrated custom application which does make use of this API call, then the setting on the Crowd server will affect your application-side caching as well.

関連トピック

Crowd Documentation





Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.