Package org.apache.hadoop.security

Interface GroupMappingServiceProvider

@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 final String	GROUP_MAPPING_CONFIG_PREFIX

Method Summary

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

Field Details

GROUP_MAPPING_CONFIG_PREFIX

static final String GROUP_MAPPING_CONFIG_PREFIX

See Also:

• Constant Field Values

Method Details

getGroups

List<String> getGroups(String user)
                throws 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:

IOException - raised on errors performing I/O.

cacheGroupsRefresh

void cacheGroupsRefresh()
                 throws IOException

Refresh the cache of groups and user mapping

Throws:

IOException - raised on errors performing I/O.

cacheGroupsAdd

void cacheGroupsAdd(List<String> groups)
             throws IOException

Caches the group user information

Parameters:

groups - list of groups to add to cache

Throws:

IOException - raised on errors performing I/O.

getGroupsSet

default Set<String> getGroupsSet(String user)
                          throws 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:

IOException - raised on errors performing I/O.