Package org.apache.hadoop.yarn.security

Class AccessRequest

java.lang.Object

org.apache.hadoop.yarn.security.AccessRequest

@Public
@Unstable
public class AccessRequest
extends java.lang.Object

This request object contains all the context information to determine whether a user has permission to access the target entity. user : the user who's currently accessing accessType : the access type against the entity. entity : the target object user is accessing. appId : the associated app Id for current access. This could be null if no app is associated. appName : the associated app name for current access. This could be null if no app is associated. remoteAddress : The caller's remote ip address. forwardedAddresses : In case this is an http request, this contains the originating IP address of a client connecting to a web server through an HTTP proxy or load balancer. This parameter is null, if it's a RPC request.

Constructor Summary

Constructors

Constructor	Description
AccessRequest(PrivilegedEntity entity, org.apache.hadoop.security.UserGroupInformation user, AccessType accessType, java.lang.String appId, java.lang.String appName, java.lang.String remoteAddress, java.util.List<java.lang.String> forwardedAddresses)

Method Summary

Modifier and Type	Method	Description
AccessType	getAccessType()
java.lang.String	getAppId()
java.lang.String	getAppName()
PrivilegedEntity	getEntity()
java.util.List<java.lang.String>	getForwardedAddresses()
java.lang.String	getRemoteAddress()
org.apache.hadoop.security.UserGroupInformation	getUser()

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessRequest

public AccessRequest(PrivilegedEntity entity,
                     org.apache.hadoop.security.UserGroupInformation user,
                     AccessType accessType,
                     java.lang.String appId,
                     java.lang.String appName,
                     java.lang.String remoteAddress,
                     java.util.List<java.lang.String> forwardedAddresses)

Method Detail

getUser

public org.apache.hadoop.security.UserGroupInformation getUser()

getAccessType

public AccessType getAccessType()

getAppId

public java.lang.String getAppId()

getAppName

public java.lang.String getAppName()

getEntity

public PrivilegedEntity getEntity()

getForwardedAddresses

public java.util.List<java.lang.String> getForwardedAddresses()

getRemoteAddress

public java.lang.String getRemoteAddress()