Integrating Crowd with a Custom Application

Crowd ships with out-of-the-box support for a number of applications. You can also integrate Crowd with other applications as follows:

Step 1. Configuring Crowd to talk to your Application

Please see Adding an Application.

Step 2. Configuring your Application to talk to Crowd

2.1 Developing a Crowd Client

If your application is not listed in Supported Applications and Directories then you will need to create your own Crowd client for your application, using the Crowd REST APIs.

For assistance, please see the developer's guide to creating a Crowd client for your custom application.

2.2 Configuring your Application

The integration libraries and configuration files are included in the Crowd download, in the client folder. You will find the Crowd integration library, and the client libraries on which the framework depends, in the lib folder. An example client properties file crowd.properties is located in the conf folder.

To configure your application, perform the following:

  1. Copy the Crowd client and supporting libraries to your application's classpath, typically WEB-INF/lib.
    These files will be in Crowd's client folder, with a name similar to crowd-integration-client-X.X.X.jar and all supporting JARs in the client/lib folder.
  2. Copy the client properties file crowd.properties to your application's deployment directory, typically WEB-INF/classes.
  3. Edit the crowd.properties file to reflect the values of your deployment parameters. Refer to the description of the attributes in the crowd.properties file.

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:

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

Crowd Documentation

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport