Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| jBPM distribution 6.0.0-SNAPSHOT
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jbpm.services.task.identity
Class LDAPUserGroupCallbackImpl

    java.lang.Object
      org.jbpm.services.task.identity.LDAPUserGroupCallbackImpl

All Implemented Interfaces:
  UserGroupCallback

    @Alternative
    public class LDAPUserGroupCallbackImpl

extends Object
implements org.kie.internal.task.api.UserGroupCallback

LDAP integration for Task Service to collect user and role/group information. Following is a list of all supported properties:

- ldap.bind.user (optional if LDAP server accepts anonymous access)
- ldap.bind.pwd (optional if LDAP server accepts anonymous access
- ldap.user.ctx (mandatory)
- ldap.role.ctx (mandatory)
- ldap.user.roles.ctx (optional, if not given ldap.role.ctx will be used)
- ldap.user.filter (mandatory)
- ldap.role.filter (mandatory)
- ldap.user.roles.filter (mandatory)
- ldap.user.attr.id (optional, if not given 'uid' will be used)
- ldap.roles.attr.id (optional, if not given 'cn' will be used)
- ldap.user.id.dn (optional, is user id a DN, instructs the callback to query for user DN before searching for roles, default false)
- java.naming.factory.initial
- java.naming.security.authentication
- java.naming.security.protocol
- java.naming.provider.url

Field Summary
`static String` | `BIND_PWD`
`static String` | `BIND_USER`
`protected static String` | `DEFAULT_PROPERTIES_NAME`
`static String` | `IS_USER_ID_DN`
`protected static String[]` | `requiredProperties`
`static String` | `ROLE_ATTR_ID`
`static String` | `ROLE_CTX`
`static String` | `ROLE_FILTER`
`static String` | `USER_ATTR_ID`
`static String` | `USER_CTX`
`static String` | `USER_FILTER`
`static String` | `USER_ROLES_CTX`
`static String` | `USER_ROLES_FILTER`

Constructor Summary
`LDAPUserGroupCallbackImpl()`
`LDAPUserGroupCallbackImpl(Properties config)`

Method Summary
`protected InitialLdapContext` | `buildInitialLdapContext()`
`boolean` | `existsGroup(String groupId)` Resolves existence of group id.
`boolean` | `existsUser(String userId)` Resolves existence of user id.
`List<String>` | `getGroupsForUser(String userId, List<String> groupIds, List<String> allExistingGroupIds)` Returns list of group ids for specified user id.
`protected void` | `validate()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### DEFAULT_PROPERTIES_NAME

    protected static final String DEFAULT_PROPERTIES_NAME

See Also:
  Constant Field Values

### BIND_USER

    public static final String BIND_USER

See Also:
  Constant Field Values

### BIND_PWD

    public static final String BIND_PWD

See Also:
  Constant Field Values

### USER_CTX

    public static final String USER_CTX

See Also:
  Constant Field Values

### ROLE_CTX

    public static final String ROLE_CTX

See Also:
  Constant Field Values

### USER_ROLES_CTX

    public static final String USER_ROLES_CTX

See Also:
  Constant Field Values

### USER_FILTER

    public static final String USER_FILTER

See Also:
  Constant Field Values

### ROLE_FILTER

    public static final String ROLE_FILTER

See Also:
  Constant Field Values

### USER_ROLES_FILTER

    public static final String USER_ROLES_FILTER

See Also:
  Constant Field Values

### USER_ATTR_ID

    public static final String USER_ATTR_ID

See Also:
  Constant Field Values

### ROLE_ATTR_ID

    public static final String ROLE_ATTR_ID

See Also:
  Constant Field Values

### IS_USER_ID_DN

    public static final String IS_USER_ID_DN

See Also:
  Constant Field Values

### requiredProperties

    protected static final String[] requiredProperties

Constructor Detail

### LDAPUserGroupCallbackImpl

    public LDAPUserGroupCallbackImpl()

### LDAPUserGroupCallbackImpl

    public LDAPUserGroupCallbackImpl(Properties config)

Method Detail

### existsUser

    public boolean existsUser(String userId)

  Description copied from interface: `UserGroupCallback`
  Resolves existence of user id.

  Specified by:
    `existsUser` in interface `UserGroupCallback`
  Parameters:
    `userId` - the user id assigned to the task
  Returns:
    true if userId exists, false otherwise.

### existsGroup

    public boolean existsGroup(String groupId)

  Description copied from interface: `UserGroupCallback`
  Resolves existence of group id.

  Specified by:
    `existsGroup` in interface `UserGroupCallback`
  Parameters:
    `groupId` - the group id assigned to the task
  Returns:
    true if groupId exists, false otherwise.

### getGroupsForUser

    public List<String> getGroupsForUser(String userId,
                                         List<String> groupIds,
                                         List<String> allExistingGroupIds)

  Description copied from interface: `UserGroupCallback`
  Returns list of group ids for specified user id.

  Specified by:
    `getGroupsForUser` in interface `UserGroupCallback`
  Parameters:
    `userId` - the user id assigned to the task
    `groupIds` - list of group ids assigned to the task
    `allExistingGroupIds` - list of all currently known group ids
  Returns:
    List of group ids.

### validate

    protected void validate()

### buildInitialLdapContext

    protected InitialLdapContext buildInitialLdapContext()
                                                  throws NamingException

  Throws:
    `NamingException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| jBPM distribution 6.0.0-SNAPSHOT
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2013 JBoss by Red Hat. All Rights Reserved.