blob: 1b2508fe977e33caa958b460199ee3ae77de1e61 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:06:54 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FSPermissionChecker (Apache Hadoop HDFS 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FSPermissionChecker (Apache Hadoop HDFS 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FSPermissionChecker.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FsImageProto.StringTableSectionOrBuilder.html" title="interface in org.apache.hadoop.hdfs.server.namenode"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSTreeTraverser.TraverseInfo.html" title="class in org.apache.hadoop.hdfs.server.namenode"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html" target="_top">Frames</a></li>
<li><a href="FSPermissionChecker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hdfs.server.namenode</div>
<h2 title="Class FSPermissionChecker" class="title">Class FSPermissionChecker</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hdfs.server.namenode.FSPermissionChecker</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html" title="interface in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider.AccessControlEnforcer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FSPermissionChecker</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html" title="interface in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider.AccessControlEnforcer</a></pre>
<div class="block">Class that helps in checking file system permission.
The state of this class need not be synchronized as it has data structures that
are read-only.
Some of the helper methods are guarded by <code>FSNamesystem.readLock()</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#FSPermissionChecker-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider-">FSPermissionChecker</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fsOwner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;supergroup,
org.apache.hadoop.security.UserGroupInformation&nbsp;callerUgi,
<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider</a>&nbsp;attributeProvider)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#FSPermissionChecker-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider-boolean-">FSPermissionChecker</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fsOwner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;supergroup,
org.apache.hadoop.security.UserGroupInformation&nbsp;callerUgi,
<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider</a>&nbsp;attributeProvider,
boolean&nbsp;useAuthorizationWithContextAPI)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#checkPermission-org.apache.hadoop.hdfs.server.namenode.CachePool-org.apache.hadoop.fs.permission.FsAction-">checkPermission</a></span>(org.apache.hadoop.hdfs.server.namenode.CachePool&nbsp;pool,
org.apache.hadoop.fs.permission.FsAction&nbsp;access)</code>
<div class="block">Whether a cache pool can be accessed by the current context</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#checkPermission-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributes:A-org.apache.hadoop.hdfs.server.namenode.INode:A-byte:A:A-int-java.lang.String-int-boolean-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-boolean-">checkPermission</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fsOwner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;supergroup,
org.apache.hadoop.security.UserGroupInformation&nbsp;callerUgi,
org.apache.hadoop.hdfs.server.namenode.INodeAttributes[]&nbsp;inodeAttrs,
org.apache.hadoop.hdfs.server.namenode.INode[]&nbsp;inodes,
byte[][]&nbsp;components,
int&nbsp;snapshotId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
int&nbsp;ancestorIndex,
boolean&nbsp;doCheckOwner,
org.apache.hadoop.fs.permission.FsAction&nbsp;ancestorAccess,
org.apache.hadoop.fs.permission.FsAction&nbsp;parentAccess,
org.apache.hadoop.fs.permission.FsAction&nbsp;access,
org.apache.hadoop.fs.permission.FsAction&nbsp;subAccess,
boolean&nbsp;ignoreEmptyDir)</code>
<div class="block">Checks permission on a file system object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#checkPermissionWithContext-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AuthorizationContext-">checkPermissionWithContext</a></span>(<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AuthorizationContext.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider.AuthorizationContext</a>&nbsp;authzContext)</code>
<div class="block">Checks permission on a file system object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#checkSuperuserPrivilege--">checkSuperuserPrivilege</a></span>()</code>
<div class="block">Verify if the caller has the required permission.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#getAttributesProvider--">getAttributesProvider</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#getUser--">getUser</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#isMemberOfGroup-java.lang.String-">isMemberOfGroup</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#isSuperUser--">isSuperUser</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html#setOperationType-java.lang.String-">setOperationType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;opType)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FSPermissionChecker-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FSPermissionChecker</h4>
<pre>protected&nbsp;FSPermissionChecker(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fsOwner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;supergroup,
org.apache.hadoop.security.UserGroupInformation&nbsp;callerUgi,
<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider</a>&nbsp;attributeProvider)</pre>
</li>
</ul>
<a name="FSPermissionChecker-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FSPermissionChecker</h4>
<pre>protected&nbsp;FSPermissionChecker(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fsOwner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;supergroup,
org.apache.hadoop.security.UserGroupInformation&nbsp;callerUgi,
<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider</a>&nbsp;attributeProvider,
boolean&nbsp;useAuthorizationWithContextAPI)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setOperationType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperationType</h4>
<pre>public static&nbsp;void&nbsp;setOperationType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;opType)</pre>
</li>
</ul>
<a name="isMemberOfGroup-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMemberOfGroup</h4>
<pre>public&nbsp;boolean&nbsp;isMemberOfGroup(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;group)</pre>
</li>
</ul>
<a name="getUser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUser()</pre>
</li>
</ul>
<a name="isSuperUser--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSuperUser</h4>
<pre>public&nbsp;boolean&nbsp;isSuperUser()</pre>
</li>
</ul>
<a name="getAttributesProvider--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributesProvider</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider</a>&nbsp;getAttributesProvider()</pre>
</li>
</ul>
<a name="checkSuperuserPrivilege--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkSuperuserPrivilege</h4>
<pre>public&nbsp;void&nbsp;checkSuperuserPrivilege()
throws org.apache.hadoop.security.AccessControlException</pre>
<div class="block">Verify if the caller has the required permission. This will result into
an exception if the caller is not allowed to access the resource.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.AccessControlException</code></dd>
</dl>
</li>
</ul>
<a name="checkPermission-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributes:A-org.apache.hadoop.hdfs.server.namenode.INode:A-byte:A:A-int-java.lang.String-int-boolean-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkPermission</h4>
<pre>public&nbsp;void&nbsp;checkPermission(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fsOwner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;supergroup,
org.apache.hadoop.security.UserGroupInformation&nbsp;callerUgi,
org.apache.hadoop.hdfs.server.namenode.INodeAttributes[]&nbsp;inodeAttrs,
org.apache.hadoop.hdfs.server.namenode.INode[]&nbsp;inodes,
byte[][]&nbsp;components,
int&nbsp;snapshotId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path,
int&nbsp;ancestorIndex,
boolean&nbsp;doCheckOwner,
org.apache.hadoop.fs.permission.FsAction&nbsp;ancestorAccess,
org.apache.hadoop.fs.permission.FsAction&nbsp;parentAccess,
org.apache.hadoop.fs.permission.FsAction&nbsp;access,
org.apache.hadoop.fs.permission.FsAction&nbsp;subAccess,
boolean&nbsp;ignoreEmptyDir)
throws org.apache.hadoop.security.AccessControlException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html#checkPermission-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributes:A-org.apache.hadoop.hdfs.server.namenode.INode:A-byte:A:A-int-java.lang.String-int-boolean-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-boolean-">INodeAttributeProvider.AccessControlEnforcer</a></code></span></div>
<div class="block">Checks permission on a file system object. Has to throw an Exception
if the filesystem object is not accessible by the calling Ugi.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html#checkPermission-java.lang.String-java.lang.String-org.apache.hadoop.security.UserGroupInformation-org.apache.hadoop.hdfs.server.namenode.INodeAttributes:A-org.apache.hadoop.hdfs.server.namenode.INode:A-byte:A:A-int-java.lang.String-int-boolean-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-org.apache.hadoop.fs.permission.FsAction-boolean-">checkPermission</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html" title="interface in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider.AccessControlEnforcer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fsOwner</code> - Filesystem owner (The Namenode user)</dd>
<dd><code>supergroup</code> - super user geoup</dd>
<dd><code>callerUgi</code> - UserGroupInformation of the caller</dd>
<dd><code>inodeAttrs</code> - Array of INode attributes for each path element in the
the path</dd>
<dd><code>inodes</code> - Array of INodes for each path element in the path</dd>
<dd><code>components</code> - Array of byte arrays of the LocalName</dd>
<dd><code>snapshotId</code> - the snapshotId of the requested path</dd>
<dd><code>path</code> - Path String</dd>
<dd><code>ancestorIndex</code> - Index of ancestor</dd>
<dd><code>doCheckOwner</code> - perform ownership check</dd>
<dd><code>ancestorAccess</code> - The access required by the ancestor of the path.</dd>
<dd><code>parentAccess</code> - The access required by the parent of the path.</dd>
<dd><code>access</code> - The access required by the path.</dd>
<dd><code>subAccess</code> - If path is a directory, It is the access required of
the path and all the sub-directories. If path is not a
directory, there should ideally be no effect.</dd>
<dd><code>ignoreEmptyDir</code> - Ignore permission checking for empty directory?</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.AccessControlException</code></dd>
</dl>
</li>
</ul>
<a name="checkPermissionWithContext-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AuthorizationContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkPermissionWithContext</h4>
<pre>public&nbsp;void&nbsp;checkPermissionWithContext(<a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AuthorizationContext.html" title="class in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider.AuthorizationContext</a>&nbsp;authzContext)
throws org.apache.hadoop.security.AccessControlException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html#checkPermissionWithContext-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AuthorizationContext-">INodeAttributeProvider.AccessControlEnforcer</a></code></span></div>
<div class="block">Checks permission on a file system object. Has to throw an Exception
if the filesystem object is not accessessible by the calling Ugi.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html#checkPermissionWithContext-org.apache.hadoop.hdfs.server.namenode.INodeAttributeProvider.AuthorizationContext-">checkPermissionWithContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AccessControlEnforcer.html" title="interface in org.apache.hadoop.hdfs.server.namenode">INodeAttributeProvider.AccessControlEnforcer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authzContext</code> - an <a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/INodeAttributeProvider.AuthorizationContext.html" title="class in org.apache.hadoop.hdfs.server.namenode"><code>INodeAttributeProvider.AuthorizationContext</code></a> object encapsulating
the various parameters required to authorize an
operation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.AccessControlException</code></dd>
</dl>
</li>
</ul>
<a name="checkPermission-org.apache.hadoop.hdfs.server.namenode.CachePool-org.apache.hadoop.fs.permission.FsAction-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>checkPermission</h4>
<pre>public&nbsp;void&nbsp;checkPermission(org.apache.hadoop.hdfs.server.namenode.CachePool&nbsp;pool,
org.apache.hadoop.fs.permission.FsAction&nbsp;access)
throws org.apache.hadoop.security.AccessControlException</pre>
<div class="block">Whether a cache pool can be accessed by the current context</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pool</code> - CachePool being accessed</dd>
<dd><code>access</code> - type of action being performed on the cache pool</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.security.AccessControlException</code> - if pool cannot be accessed</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FSPermissionChecker.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FsImageProto.StringTableSectionOrBuilder.html" title="interface in org.apache.hadoop.hdfs.server.namenode"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/hdfs/server/namenode/FSTreeTraverser.TraverseInfo.html" title="class in org.apache.hadoop.hdfs.server.namenode"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/hdfs/server/namenode/FSPermissionChecker.html" target="_top">Frames</a></li>
<li><a href="FSPermissionChecker.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>