Creating a Custom Directory Connector

Crowd comes with a number of supplied directory connectors. If your directory is not listed in Supported Applications and Directories then you will need to create your own custom directory connector.

The directory connectors that come with Crowd implement the Java interface RemoteDirectory. The RemoteDirectory interface defines generic methods for authentication, searching and entity create, remove and update operations.

To connect Crowd to a custom directory server, you will need to write a Java class file that implements the RemoteDirectory interface.

In our example below, the MyCustomDirectoryServer class extends the Crowd DirectoryEntity utility class. The utility class manages setting runtime properties that may be used by the Crowd server in the future for operations such as getting the Crowd ID number of the directory server.

package com.atlassian.crowd.integration.directory.custom;

import com.atlassian.crowd.integration.SearchContext;
import com.atlassian.crowd.integration.authentication.PasswordCredential;
import com.atlassian.crowd.integration.directory.RemoteDirectory;
import com.atlassian.crowd.integration.exception.*;
import com.atlassian.crowd.integration.model.DirectoryEntity;
import com.atlassian.crowd.integration.model.RemoteGroup;
import com.atlassian.crowd.integration.model.RemotePrincipal;
import com.atlassian.crowd.integration.model.RemoteRole;

import java.rmi.RemoteException;
import java.util.List;

public class MyCustomDirectoryServer extends DirectoryEntity implements RemoteDirectory
{
    public RemotePrincipal authenticate(String name, PasswordCredential[] credentials) throws RemoteException, 
            InvalidPrincipalException, InactiveAccountException, InvalidAuthenticationException {
        // Perform your custom directory server authentication code here.
        // 
        // The source code to the InternalDirectory, which comes with your commercial license is a good implementation example.
    }

    // Other RemoteDirectory interface methods will also need to be implemented ...
}

Once you have finished implementing all of the methods defined by the RemoteDirectory interface, you will then need to:

1. Create a JAR of the MyCustomDirectoryServer and any supporting class files.
2. Shut down Crowd.
3. Place the newly-created JAR from step one in the CROWD/crowd-webapp/WEB-INF/lib folder.
4. Start Crowd.
5. Follow the instructions on configuring a custom directory connector through the Crowd Administration Console.

次のステップ

After creating your directory connector, please see Configuring a Custom Directory Connector.

関連トピック

• Creating a new translation for Crowd
• Crowd Developer FAQ
  • Where can I find a list of Crowd dependencies?
  • Where can I find an overview of SSO?
• Customising the Crowd Source Code
• Database Schema and Example SQL for Crowd
  • Crowd Database Schema
• Developing Plugins for Crowd
  • Component Plugin Modules
  • Event Listeners
  • Password Encoders
  • Servlet Plugin Modules
  • Web Item Plugin Modules
  • Web Section Plugin Modules
• IntelliJ IDEA Setup Guide
  • Setting up Tomcat in IDEA for Crowd
• Using the Crowd Remote API
  • Creating a Crowd Client for your Custom Application
    • Application Integration Overview
      • Sample Application ('demo')
    • Java Integration Libraries
      • Compiling the Crowd Source
      • Creating a Crowd Client using Crowd Integration Libraries
      • Maven 2 Integration
      • Using the Search API
    • SOAP API
      • Axis 1.x Client Stub Generation
      • Microsoft .NET Client
  • Creating a Custom Directory Connector

Crowd Documentation