Package org.apache.hadoop.security

Interface GroupMappingServiceProvider

All Known Implementing Classes:

CompositeGroupsMapping, JniBasedUnixGroupsMapping, JniBasedUnixGroupsMappingWithFallback, JniBasedUnixGroupsNetgroupMapping, JniBasedUnixGroupsNetgroupMappingWithFallback, LdapGroupsMapping, NullGroupsMapping, RuleBasedLdapGroupsMapping, ShellBasedUnixGroupsMapping, ShellBasedUnixGroupsNetgroupMapping

@Public
@Evolving
public interface GroupMappingServiceProvider

An interface for the implementation of a user-to-groups mapping service used by Groups.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	GROUP_MAPPING_CONFIG_PREFIX

Method Summary

Modifier and Type	Method	Description
void	cacheGroupsAdd(java.util.List<java.lang.String> groups)	Caches the group user information
void	cacheGroupsRefresh()	Refresh the cache of groups and user mapping
java.util.List<java.lang.String>	getGroups(java.lang.String user)	Get all various group memberships of a given user.
default java.util.Set<java.lang.String>	getGroupsSet(java.lang.String user)	Get all various group memberships of a given user.

Field Detail

GROUP_MAPPING_CONFIG_PREFIX

static final java.lang.String GROUP_MAPPING_CONFIG_PREFIX

See Also:

Constant Field Values

Method Detail

getGroups

java.util.List<java.lang.String> getGroups(java.lang.String user)
                                    throws java.io.IOException

Get all various group memberships of a given user. Returns EMPTY list in case of non-existing user

Parameters:

user - User's name

Returns:

group memberships of user

Throws:

java.io.IOException - raised on errors performing I/O.

cacheGroupsRefresh

void cacheGroupsRefresh()
                 throws java.io.IOException

Refresh the cache of groups and user mapping

Throws:

java.io.IOException - raised on errors performing I/O.

cacheGroupsAdd

void cacheGroupsAdd(java.util.List<java.lang.String> groups)
             throws java.io.IOException

Caches the group user information

Parameters:

groups - list of groups to add to cache

Throws:

java.io.IOException - raised on errors performing I/O.

getGroupsSet

default java.util.Set<java.lang.String> getGroupsSet(java.lang.String user)
                                              throws java.io.IOException

Get all various group memberships of a given user. Returns EMPTY set in case of non-existing user

Parameters:

user - User's name

Returns:

set of group memberships of user

Throws:

java.io.IOException - raised on errors performing I/O.