org.sonar.api.security

Class ExternalGroupsProvider

java.lang.Object

org.sonar.api.security.ExternalGroupsProvider

public abstract class ExternalGroupsProvider
extends java.lang.Object

Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.

Since:

2.14

See Also:

SecurityRealm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalGroupsProvider.Context

Constructor Summary

Constructors

Constructor and Description
ExternalGroupsProvider()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	doGetGroups(ExternalGroupsProvider.Context context) Override this method in order to load user group information.
java.util.Collection<java.lang.String>	doGetGroups(java.lang.String username) Deprecated. replaced by doGetGroups(org.sonar.api.security.ExternalGroupsProvider.Context) since v. 5.2

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalGroupsProvider

public ExternalGroupsProvider()

Method Detail

doGetGroups

@Deprecated
public java.util.Collection<java.lang.String> doGetGroups(java.lang.String username)

Deprecated. replaced by doGetGroups(org.sonar.api.security.ExternalGroupsProvider.Context) since v. 5.2

Returns:

list of groups associated with specified user, or null if such user doesn't exist

Throws:

java.lang.RuntimeException - in case of unexpected error such as connection failure

doGetGroups

public java.util.Collection<java.lang.String> doGetGroups(ExternalGroupsProvider.Context context)

Override this method in order to load user group information.

Returns:

list of groups associated with specified user, or null if such user doesn't exist

Throws:

java.lang.RuntimeException - in case of unexpected error such as connection failure

Since:

5.2