de.theit.jenkins.crowd

Class CrowdConfigurationService

java.lang.Object

de.theit.jenkins.crowd.CrowdConfigurationService

public class CrowdConfigurationService
extends Object

This class contains all objects that are necessary to access the REST services on the remote Crowd server. Additionally it contains some helper methods to check for group membership and availability.

Since:

08.09.2011

Version:

$Id$

Author:

Thorsten Heit (theit@gmx.de)

Constructor Summary

Constructors

Constructor and Description
CrowdConfigurationService(String pGroupNames, boolean pNestedGroups) Creates a new Crowd configuration object.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<org.springframework.security.GrantedAuthority>	getAuthoritiesForUser(String username) Retrieves the list of all (nested) groups from the Crowd server that the user is a member of.
boolean	isGroupActive(String groupName) Checks if the specified group name exists on the remote Crowd server and is active.
boolean	isGroupMember(String username) Checks whether the user is a member of one of the Crowd groups whose members are allowed to login.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrowdConfigurationService

public CrowdConfigurationService(String pGroupNames,
                         boolean pNestedGroups)

Creates a new Crowd configuration object.

Parameters:

pGroupNames - The group names to use when authenticating Crowd users. May not be null.

pNestedGroups - Specifies whether nested groups should be used when validating users against a group name.

Method Detail

isGroupMember

public boolean isGroupMember(String username)

Checks whether the user is a member of one of the Crowd groups whose members are allowed to login.

Parameters:

username - The name of the user to check. May not be null or empty.

Returns:

true if and only if the group exists, is active and the user is either a direct group member or, if nested groups may be used, a nested group member. false else.

isGroupActive

public boolean isGroupActive(String groupName)
                      throws com.atlassian.crowd.exception.InvalidAuthenticationException,
                             com.atlassian.crowd.exception.ApplicationPermissionException,
                             com.atlassian.crowd.exception.OperationFailedException

Checks if the specified group name exists on the remote Crowd server and is active.

Parameters:

groupName - The name of the group to check. May not be null or empty.

Returns:

true if and only if the group name is not empty, does exist on the remote Crowd server and is active. false else.

Throws:

com.atlassian.crowd.exception.InvalidAuthenticationException - If the application and password are not valid.

com.atlassian.crowd.exception.ApplicationPermissionException - If the application is not permitted to perform the requested operation on the server

com.atlassian.crowd.exception.OperationFailedException - If the operation has failed for any other reason, including invalid arguments and the operation not being supported on the server.

getAuthoritiesForUser

public Collection<org.springframework.security.GrantedAuthority> getAuthoritiesForUser(String username)

Retrieves the list of all (nested) groups from the Crowd server that the user is a member of.

Parameters:

username - The name of the user. May not be null.

Returns:

The list of all groups that the user is a member of. Always non-null.