<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--NewPage-->
<html>
<head>
<!-- Generated by javadoc on Wed Jul 28 01:21:15 GMT 1999 -->
<title>
  Interface java.security.acl.AclEntry
</title>
</head>
<body>
<a name="_top_"></a>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.security.acl.html">This Package</a>  <a href="java.security.acl.Acl.html#_top_">Previous</a>  <a href="java.security.acl.Group.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
<hr>
<h1>
  Interface java.security.acl.AclEntry
</h1>
<dl>
  <dt> public interface <b>AclEntry</b>
  <dt> extends <a href="java.lang.Cloneable.html#_top_">Cloneable</a>
</dl>
This is the interface used for representing one entry in an Access 
 Control List (ACL).<p>
 An ACL can be thought of as a data structure with multiple ACL entry
 objects. Each ACL entry object contains a set of permissions associated 
 with a particular principal. (A principal represents an entity such as 
 an individual user or a group). Additionally, each ACL entry is specified
 as being either positive or negative. If positive, the permissions are 
 to be granted to the associated principal. If negative, the permissions 
 are to be denied. Each principal can have at most one positive ACL entry 
 and one negative entry; that is, multiple positive or negative ACL 
 entries are not allowed for any principal.
 Note: ACL entries are by default positive. An entry becomes a 
 negative entry only if the <a href = 
 "#setNegativePermissions">setNegativePermissions</a>
 method is called on it.
<p>
<dl>
    <dt> <b>See Also:</b>
    <dd> <a href="java.security.acl.Acl.html#_top_">Acl</a>
</dl>
<hr>
<a name="index"></a>
<h2>
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
</h2>
<dl>
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#addPermission(java.security.acl.Permission)"><b>addPermission</b></a>(Permission)
  <dd>  Adds the specified permission to this ACL entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#checkPermission(java.security.acl.Permission)"><b>checkPermission</b></a>(Permission)
  <dd>  Checks if the specified permission is part of the 
 permission set in this entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#clone()"><b>clone</b></a>()
  <dd>  Clones this ACL entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#getPrincipal()"><b>getPrincipal</b></a>()
  <dd>  Returns the principal for which permissions are granted or denied by 
 this ACL entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#isNegative()"><b>isNegative</b></a>()
  <dd>  Returns true if this is a negative ACL entry (one denying the 
 associated principal the set of permissions in the entry), false 
 otherwise.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#permissions()"><b>permissions</b></a>()
  <dd>  Returns an enumeration of the permissions in this ACL entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#removePermission(java.security.acl.Permission)"><b>removePermission</b></a>(Permission)
  <dd>  Removes the specified permission from this ACL entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setNegativePermissions()"><b>setNegativePermissions</b></a>()
  <dd>  Sets this ACL entry to be a negative one.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#setPrincipal(java.security.Principal)"><b>setPrincipal</b></a>(Principal)
  <dd>  Specifies the principal for which permissions are granted or denied 
 by this ACL entry.
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
	<a href="#toString()"><b>toString</b></a>()
  <dd>  Returns a string representation of the contents of this ACL entry.
</dl>
<a name="methods"></a>
<h2>
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
</h2>
<a name="setPrincipal(java.security.Principal)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setPrincipal"><b>setPrincipal</b></a>
<pre>
 public abstract boolean setPrincipal(<a href="java.security.Principal.html#_top_">Principal</a> user)
</pre>
<dl>
  <dd> Specifies the principal for which permissions are granted or denied 
 by this ACL entry. If a principal was already set for this ACL entry,
 false is returned, otherwise true is returned.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> user - the principal to be set for this entry.
    <dt> <b>Returns:</b>
    <dd> true if the principal is set, false if there was
 already a principal set for this entry.
  </dl></dd>
</dl>
<a name="getPrincipal()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="getPrincipal"><b>getPrincipal</b></a>
<pre>
 public abstract <a href="java.security.Principal.html#_top_">Principal</a> getPrincipal()
</pre>
<dl>
  <dd> Returns the principal for which permissions are granted or denied by 
 this ACL entry. Returns null if there is no principal set for this 
 entry yet.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> the principal associated with this entry.
  </dl></dd>
</dl>
<a name="setNegativePermissions()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="setNegativePermissions"><b>setNegativePermissions</b></a>
<pre>
 public abstract void setNegativePermissions()
</pre>
<dl>
  <dd> Sets this ACL entry to be a negative one. That is, the associated 
 principal (e.g., a user or a group) will be denied the permission set 
 specified in the entry.
 Note: ACL entries are by default positive. An entry becomes a 
 negative entry only if this <code>setNegativePermissions</code> 
 method is called on it.
<p>
</dl>
<a name="isNegative()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="isNegative"><b>isNegative</b></a>
<pre>
 public abstract boolean isNegative()
</pre>
<dl>
  <dd> Returns true if this is a negative ACL entry (one denying the 
 associated principal the set of permissions in the entry), false 
 otherwise.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> true if this is a negative ACL entry, false if it's not.
  </dl></dd>
</dl>
<a name="addPermission(java.security.acl.Permission)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="addPermission"><b>addPermission</b></a>
<pre>
 public abstract boolean addPermission(<a href="java.security.acl.Permission.html#_top_">Permission</a> permission)
</pre>
<dl>
  <dd> Adds the specified permission to this ACL entry. Note: An entry can 
 have multiple permissions.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> permission - the permission to be associated with
 the principal in this entry.
    <dt> <b>Returns:</b>
    <dd> true if the permission was added, false if the
 permission was already part of this entry's permission set.
  </dl></dd>
</dl>
<a name="removePermission(java.security.acl.Permission)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="removePermission"><b>removePermission</b></a>
<pre>
 public abstract boolean removePermission(<a href="java.security.acl.Permission.html#_top_">Permission</a> permission)
</pre>
<dl>
  <dd> Removes the specified permission from this ACL entry.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> permission - the permission to be removed from this entry.
    <dt> <b>Returns:</b>
    <dd> true if the permission is removed, false if the
 permission was not part of this entry's permission set.
  </dl></dd>
</dl>
<a name="checkPermission(java.security.acl.Permission)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="checkPermission"><b>checkPermission</b></a>
<pre>
 public abstract boolean checkPermission(<a href="java.security.acl.Permission.html#_top_">Permission</a> permission)
</pre>
<dl>
  <dd> Checks if the specified permission is part of the 
 permission set in this entry.
<p>
  <dd><dl>
    <dt> <b>Parameters:</b>
    <dd> permission - the permission to be checked for.
    <dt> <b>Returns:</b>
    <dd> true if the permission is part of the
 permission set in this entry, false otherwise.
  </dl></dd>
</dl>
<a name="permissions()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="permissions"><b>permissions</b></a>
<pre>
 public abstract <a href="java.util.Enumeration.html#_top_">Enumeration</a> permissions()
</pre>
<dl>
  <dd> Returns an enumeration of the permissions in this ACL entry.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> an enumeration of the permissions in this ACL entry.
  </dl></dd>
</dl>
<a name="toString()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="toString"><b>toString</b></a>
<pre>
 public abstract <a href="java.lang.String.html#_top_">String</a> toString()
</pre>
<dl>
  <dd> Returns a string representation of the contents of this ACL entry.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> a string representation of the contents.
    <dt> <b>Overrides:</b>
    <dd> <a href="java.lang.Object.html#toString()">toString</a> in class <a href="java.lang.Object.html#_top_">Object</a>
  </dl></dd>
</dl>
<a name="clone()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
<a name="clone"><b>clone</b></a>
<pre>
 public abstract <a href="java.lang.Object.html#_top_">Object</a> clone()
</pre>
<dl>
  <dd> Clones this ACL entry.
<p>
  <dd><dl>
    <dt> <b>Returns:</b>
    <dd> a clone of this ACL entry.
    <dt> <b>Overrides:</b>
    <dd> <a href="java.lang.Object.html#clone()">clone</a> in class <a href="java.lang.Object.html#_top_">Object</a>
  </dl></dd>
</dl>
<hr>
<pre>
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-java.security.acl.html">This Package</a>  <a href="java.security.acl.Acl.html#_top_">Previous</a>  <a href="java.security.acl.Group.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
</body>
</html>
