Uses of Class
org.apache.hadoop.security.UserGroupInformation

Packages that use UserGroupInformation

Package	Description
org.apache.hadoop.fs	An abstract file system API.
org.apache.hadoop.ipc	Tools to help define network clients and servers.
org.apache.hadoop.security	Classes for hadoop security.
org.apache.hadoop.security.authorize	Support for service-level authorization.
org.apache.hadoop.security.token	Support for delegation tokens.
org.apache.hadoop.security.token.delegation	ZooKeeper secret manager for TokenIdentifiers and DelegationKeys.
org.apache.hadoop.security.token.delegation.web
org.apache.hadoop.util	Common utilities.

Uses of UserGroupInformation in org.apache.hadoop.fs

Methods in org.apache.hadoop.fs that return UserGroupInformation

Modifier and Type	Method	Description
UserGroupInformation	FileContext.getUgi()	Gets the ugi in the file-context

Methods in org.apache.hadoop.fs with parameters of type UserGroupInformation

Modifier and Type	Method	Description
static void	FileSystem.closeAllForUGI(UserGroupInformation ugi)	Close all cached FileSystem instances for a given UGI.

Uses of UserGroupInformation in org.apache.hadoop.ipc

Fields in org.apache.hadoop.ipc declared as UserGroupInformation

Modifier and Type	Field	Description
UserGroupInformation	Server.Connection.attemptingUser

Methods in org.apache.hadoop.ipc that return UserGroupInformation

Modifier and Type	Method	Description
abstract UserGroupInformation	ExternalCall.getRemoteUser()
UserGroupInformation	Server.Call.getRemoteUser()
static UserGroupInformation	Server.getRemoteUser()	Returns the RPC remote user when invoked inside an RPC.
UserGroupInformation	Schedulable.getUserGroupInformation()
UserGroupInformation	Server.Call.getUserGroupInformation()

Methods in org.apache.hadoop.ipc with parameters of type UserGroupInformation

Modifier and Type	Method	Description
static <T> ProtocolProxy<T>	RPC.getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory)	Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server
static <T> ProtocolProxy<T>	RPC.getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy)	Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server.
static <T> ProtocolProxy<T>	RPC.getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth)	Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server.
static <T> ProtocolProxy<T>	RPC.getProtocolProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)	Get a protocol proxy that contains a proxy connection to a remote server and a set of methods that are supported by the server.
<T> ProtocolProxy<T>	ProtobufRpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout)	Deprecated.
<T> ProtocolProxy<T>	ProtobufRpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy)	Deprecated.
<T> ProtocolProxy<T>	ProtobufRpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)	Deprecated.
<T> ProtocolProxy<T>	ProtobufRpcEngine2.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout)
<T> ProtocolProxy<T>	ProtobufRpcEngine2.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy)
<T> ProtocolProxy<T>	ProtobufRpcEngine2.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)
static <T> T	RPC.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory)	Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.
static <T> T	RPC.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout)	Construct a client-side proxy that implements the named protocol, talking to a server at the named address.
<T> ProtocolProxy<T>	RpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy)	Construct a client-side proxy object.
<T> ProtocolProxy<T>	RpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)	Construct a client-side proxy object.
<T> ProtocolProxy<T>	WritableRpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy)	Deprecated. Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.
<T> ProtocolProxy<T>	WritableRpcEngine.getProxy(Class<T> protocol, long clientVersion, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)	Deprecated. Construct a client-side proxy object that implements the named protocol, talking to a server at the named address.

Constructors in org.apache.hadoop.ipc with parameters of type UserGroupInformation

Modifier	Constructor	Description
	ConnectionId(InetSocketAddress address, Class<?> protocol, UserGroupInformation ticket, int rpcTimeout, RetryPolicy connectionRetryPolicy, Configuration conf)
protected	Invoker(Class<?> protocol, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)
protected	Invoker(Class<?> protocol, InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)

Uses of UserGroupInformation in org.apache.hadoop.security

Methods in org.apache.hadoop.security that return UserGroupInformation

Modifier and Type	Method	Description
static UserGroupInformation	UserGroupInformation.createProxyUser(String user, UserGroupInformation realUser)	Create a proxy user using username of the effective user and the ugi of the real user.
static UserGroupInformation	UserGroupInformation.createProxyUserForTesting(String user, UserGroupInformation realUser, String[] userGroups)	Create a proxy user UGI for testing HDFS and MapReduce
static UserGroupInformation	UserGroupInformation.createRemoteUser(String user)	Create a user from a login name.
static UserGroupInformation	UserGroupInformation.createRemoteUser(String user, SaslRpcServer.AuthMethod authMethod)	Create a user from a login name.
static UserGroupInformation	UserGroupInformation.createUserForTesting(String user, String[] userGroups)	Create a UGI for testing HDFS and MapReduce
static UserGroupInformation	UserGroupInformation.getBestUGI(String ticketCachePath, String user)	Find the most appropriate UserGroupInformation to use
static UserGroupInformation	UserGroupInformation.getCurrentUser()	Return the current user, including any doAs in the current stack.
static UserGroupInformation	UserGroupInformation.getLoginUser()	Get the currently logged in user.
UserGroupInformation	UserGroupInformation.getRealUser()	get RealUser (vs.
static UserGroupInformation	UserGroupInformation.getRealUserOrSelf(UserGroupInformation user)	If this is a proxy user, get the real user.
static UserGroupInformation	UserGroupInformation.getUGIFromSubject(Subject subject)	Create a UserGroupInformation from a Subject with Kerberos principal.
static UserGroupInformation	UserGroupInformation.getUGIFromTicketCache(String ticketCache, String user)	Create a UserGroupInformation from a Kerberos ticket cache.
static UserGroupInformation	UserGroupInformation.loginUserFromKeytabAndReturnUGI(String user, String path)	Log a user in from a keytab file.

Methods in org.apache.hadoop.security with parameters of type UserGroupInformation

Modifier and Type	Method	Description
static UserGroupInformation	UserGroupInformation.createProxyUser(String user, UserGroupInformation realUser)	Create a proxy user using username of the effective user and the ugi of the real user.
static UserGroupInformation	UserGroupInformation.createProxyUserForTesting(String user, UserGroupInformation realUser, String[] userGroups)	Create a proxy user UGI for testing HDFS and MapReduce
void	KDiag.dumpTokens(UserGroupInformation ugi)	Dump all tokens of a UGI.
static UserGroupInformation.AuthenticationMethod	UserGroupInformation.getRealAuthenticationMethod(UserGroupInformation ugi)	Returns the authentication method of a ugi.
static UserGroupInformation	UserGroupInformation.getRealUserOrSelf(UserGroupInformation user)	If this is a proxy user, get the real user.
static void	UserGroupInformation.logAllUserInfo(UserGroupInformation ugi)	Log all (current, real, login) UGI and token info into UGI debug log.
static void	UserGroupInformation.logAllUserInfo(org.slf4j.Logger log, UserGroupInformation ugi)	Log all (current, real, login) UGI and token info into specified log.
static void	UserGroupInformation.logUserInfo(org.slf4j.Logger log, String caption, UserGroupInformation ugi)	Log current UGI and token information into specified log.
static void	UserGroupInformation.setLoginUser(UserGroupInformation ugi)

Constructors in org.apache.hadoop.security with parameters of type UserGroupInformation

Modifier	Constructor	Description
	SaslRpcClient(UserGroupInformation ugi, Class<?> protocol, InetSocketAddress serverAddr, Configuration conf)	Create a SaslRpcClient that can be used by a RPC client to negotiate SASL authentication with a RPC server

Uses of UserGroupInformation in org.apache.hadoop.security.authorize

Methods in org.apache.hadoop.security.authorize with parameters of type UserGroupInformation

Modifier and Type	Method	Description
void	DefaultImpersonationProvider.authorize(UserGroupInformation user, InetAddress remoteAddress)
default void	ImpersonationProvider.authorize(UserGroupInformation user, String remoteAddress)	Authorize the superuser which is doing doAs.
void	ImpersonationProvider.authorize(UserGroupInformation user, InetAddress remoteAddress)	Authorize the superuser which is doing doAs.
static void	ProxyUsers.authorize(UserGroupInformation user, String remoteAddress)	Authorize the superuser which is doing doAs.
static void	ProxyUsers.authorize(UserGroupInformation user, String remoteAddress, Configuration conf)	Deprecated. use ProxyUsers.authorize(UserGroupInformation, String) instead.
static void	ProxyUsers.authorize(UserGroupInformation user, InetAddress remoteAddress)	Authorize the superuser which is doing doAs.
void	ServiceAuthorizationManager.authorize(UserGroupInformation user, Class<?> protocol, Configuration conf, InetAddress addr)	Authorize the user to access the protocol being used.
boolean	AccessControlList.isUserAllowed(UserGroupInformation ugi)
final boolean	AccessControlList.isUserInList(UserGroupInformation ugi)	Checks if a user represented by the provided UserGroupInformation is a member of the Access Control List.

Uses of UserGroupInformation in org.apache.hadoop.security.token

Methods in org.apache.hadoop.security.token that return UserGroupInformation

Modifier and Type	Method	Description
abstract UserGroupInformation	TokenIdentifier.getUser()	Get the Ugi with the username encoded in the token identifier

Uses of UserGroupInformation in org.apache.hadoop.security.token.delegation

Methods in org.apache.hadoop.security.token.delegation that return UserGroupInformation

Modifier and Type	Method	Description
UserGroupInformation	AbstractDelegationTokenIdentifier.getUser()	Get the username encoded in the token identifier

Uses of UserGroupInformation in org.apache.hadoop.security.token.delegation.web

Methods in org.apache.hadoop.security.token.delegation.web that return UserGroupInformation

Modifier and Type	Method	Description
static UserGroupInformation	HttpUserGroupInformation.get()	Returns the remote UserGroupInformation in context for the current HTTP request, taking into account proxy user requests.
UserGroupInformation	DelegationTokenManager.verifyToken(Token<? extends AbstractDelegationTokenIdentifier> token)

Methods in org.apache.hadoop.security.token.delegation.web with parameters of type UserGroupInformation

Modifier and Type	Method	Description
Token<? extends AbstractDelegationTokenIdentifier>	DelegationTokenManager.createToken(UserGroupInformation ugi, String renewer)
Token<? extends AbstractDelegationTokenIdentifier>	DelegationTokenManager.createToken(UserGroupInformation ugi, String renewer, String service)

Uses of UserGroupInformation in org.apache.hadoop.util

Methods in org.apache.hadoop.util that return UserGroupInformation

Modifier and Type	Method	Description
static UserGroupInformation	ProtoUtil.getUgi(org.apache.hadoop.ipc.protobuf.IpcConnectionContextProtos.IpcConnectionContextProto context)
static UserGroupInformation	ProtoUtil.getUgi(org.apache.hadoop.ipc.protobuf.IpcConnectionContextProtos.UserInformationProto userInfo)

Methods in org.apache.hadoop.util with parameters of type UserGroupInformation

Modifier and Type	Method	Description
static org.apache.hadoop.ipc.protobuf.IpcConnectionContextProtos.IpcConnectionContextProto	ProtoUtil.makeIpcConnectionContext(String protocol, UserGroupInformation ugi, SaslRpcServer.AuthMethod authMethod)	This method creates the connection context using exactly the same logic as the old connection context as was done for writable where the effective and real users are set based on the auth method.