Package org.apache.hadoop.security

Class CompositeGroupsMapping

java.lang.Object

org.apache.hadoop.security.CompositeGroupsMapping

All Implemented Interfaces:

Configurable, GroupMappingServiceProvider

@LimitedPrivate({"HDFS","MapReduce"})
@Evolving
public class CompositeGroupsMapping
extends java.lang.Object
implements GroupMappingServiceProvider, Configurable

An implementation of GroupMappingServiceProvider which composites other group mapping providers for determining group membership. This allows to combine existing provider implementations and composite a virtually new provider without customized development to deal with complex situation.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MAPPING_PROVIDER_CONFIG_PREFIX
static java.lang.String	MAPPING_PROVIDERS_COMBINED_CONFIG_KEY
static java.lang.String	MAPPING_PROVIDERS_CONFIG_KEY

Fields inherited from interface org.apache.hadoop.security.GroupMappingServiceProvider

GROUP_MAPPING_CONFIG_PREFIX

Constructor Summary

Constructors

Constructor	Description
CompositeGroupsMapping()

Method Summary

Modifier and Type	Method	Description
void	cacheGroupsAdd(java.util.List<java.lang.String> groups)	Adds groups to cache, no need to do that for this provider
void	cacheGroupsRefresh()	Caches groups, no need to do that for this provider
Configuration	getConf()	Return the configuration used by this object.
java.util.List<java.lang.String>	getGroups(java.lang.String user)	Returns list of groups for a user.
java.util.Set<java.lang.String>	getGroupsSet(java.lang.String user)	Get all various group memberships of a given user.
void	setConf(Configuration conf)	Set the configuration to be used by this object.

Methods inherited from class java.lang.Object

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

Field Detail

MAPPING_PROVIDERS_CONFIG_KEY

public static final java.lang.String MAPPING_PROVIDERS_CONFIG_KEY

See Also:

Constant Field Values

MAPPING_PROVIDERS_COMBINED_CONFIG_KEY

public static final java.lang.String MAPPING_PROVIDERS_COMBINED_CONFIG_KEY

See Also:

Constant Field Values

MAPPING_PROVIDER_CONFIG_PREFIX

public static final java.lang.String MAPPING_PROVIDER_CONFIG_PREFIX

See Also:

Constant Field Values

Constructor Detail

CompositeGroupsMapping

public CompositeGroupsMapping()

Method Detail

getGroups

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

Returns list of groups for a user.

Specified by:

getGroups in interface GroupMappingServiceProvider

Parameters:

user - get groups for this user

Returns:

list of groups for a given user

Throws:

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

cacheGroupsRefresh

public void cacheGroupsRefresh()
                        throws java.io.IOException

Caches groups, no need to do that for this provider

Specified by:

cacheGroupsRefresh in interface GroupMappingServiceProvider

Throws:

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

cacheGroupsAdd

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

Adds groups to cache, no need to do that for this provider

Specified by:

cacheGroupsAdd in interface GroupMappingServiceProvider

Parameters:

groups - unused

Throws:

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

getGroupsSet

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

Description copied from interface: GroupMappingServiceProvider

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

Specified by:

getGroupsSet in interface GroupMappingServiceProvider

Parameters:

user - User's name

Returns:

set of group memberships of user

Throws:

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

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

Returns:

Configuration

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

Parameters:

conf - configuration to be used