Package org.apache.hadoop.security

Class ShellBasedIdMapping

java.lang.Object

org.apache.hadoop.security.ShellBasedIdMapping

All Implemented Interfaces:

IdMappingServiceProvider

public class ShellBasedIdMapping
extends Object
implements IdMappingServiceProvider

A simple shell-based implementation of IdMappingServiceProvider Map id to user name or group name. It does update every 15 minutes. Only a single instance of this class is expected to be on the server. The maps are incrementally updated as described below: 1. Initialize the maps as empty. 2. Incrementally update the maps - When ShellBasedIdMapping is requested for user or group name given an ID, or for ID given a user or group name, do look up in the map first, if it doesn't exist, find the corresponding entry with shell command, and insert the entry to the maps. - When group ID is requested for a given group name, and if the group name is numerical, the full group map is loaded. Because we don't have a good way to find the entry for a numerical group name, loading the full map helps to get in all entries. 3. Periodically refresh the maps for both user and group, e.g, do step 1. Note: for testing purpose, step 1 may initial the maps with full mapping when using constructor ShellBasedIdMapping(Configuration, boolean).

Constructor Summary

Constructors

Constructor	Description
ShellBasedIdMapping(Configuration conf)
ShellBasedIdMapping(Configuration conf, boolean constructFullMapAtInit)

Method Summary

Modifier and Type	Method	Description
void	clearNameMaps()
int	getGid(String group)
int	getGidAllowingUnknown(String group)
org.apache.hadoop.thirdparty.com.google.common.collect.BiMap<Integer,String>	getGidNameMap()
String	getGroupName(int gid, String unknown)
long	getTimeout()
int	getUid(String user)
int	getUidAllowingUnknown(String user)
org.apache.hadoop.thirdparty.com.google.common.collect.BiMap<Integer,String>	getUidNameMap()
String	getUserName(int uid, String unknown)
static boolean	updateMapInternal(org.apache.hadoop.thirdparty.com.google.common.collect.BiMap<Integer,String> map, String mapName, String command, String regex, Map<Integer,Integer> staticMapping)	Get the list of users or groups returned by the specified command, and save them in the corresponding map.
void	updateMaps()

Methods inherited from class java.lang.Object

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

Constructor Details

ShellBasedIdMapping

@VisibleForTesting
public ShellBasedIdMapping(Configuration conf,
 boolean constructFullMapAtInit)
                    throws IOException

Throws:

IOException

ShellBasedIdMapping

public ShellBasedIdMapping(Configuration conf)
                    throws IOException

Throws:

IOException

Method Details

getTimeout

@VisibleForTesting
public long getTimeout()

getUidNameMap

@VisibleForTesting
public org.apache.hadoop.thirdparty.com.google.common.collect.BiMap<Integer,String> getUidNameMap()

getGidNameMap

@VisibleForTesting
public org.apache.hadoop.thirdparty.com.google.common.collect.BiMap<Integer,String> getGidNameMap()

clearNameMaps

@VisibleForTesting
public void clearNameMaps()

updateMapInternal

@VisibleForTesting
public static boolean updateMapInternal(org.apache.hadoop.thirdparty.com.google.common.collect.BiMap<Integer,String> map,
 String mapName,
 String command,
 String regex,
 Map<Integer,Integer> staticMapping)
                                 throws IOException

Get the list of users or groups returned by the specified command, and save them in the corresponding map.

Parameters:

map - map.

mapName - mapName.

command - command.

staticMapping - staticMapping.

regex - regex.

Returns:

updateMapInternal.

Throws:

IOException - raised on errors performing I/O.

updateMaps

public void updateMaps()
                throws IOException

Throws:

IOException

getUid

public int getUid(String user)
           throws IOException

Specified by:

getUid in interface IdMappingServiceProvider

Throws:

IOException

getGid

public int getGid(String group)
           throws IOException

Specified by:

getGid in interface IdMappingServiceProvider

Throws:

IOException

getUserName

public String getUserName(int uid,
 String unknown)

Specified by:

getUserName in interface IdMappingServiceProvider

getGroupName

public String getGroupName(int gid,
 String unknown)

Specified by:

getGroupName in interface IdMappingServiceProvider

getUidAllowingUnknown

public int getUidAllowingUnknown(String user)

Specified by:

getUidAllowingUnknown in interface IdMappingServiceProvider

getGidAllowingUnknown

public int getGidAllowingUnknown(String group)

Specified by:

getGidAllowingUnknown in interface IdMappingServiceProvider