stanford.netdb.util

Class ACL

java.lang.Object

stanford.netdb.logging.NetDB_Logger

stanford.netdb.util.ACL

All Implemented Interfaces:

java.io.Serializable

public class ACL
extends NetDB_Logger

This class stores an ACL file in memory. If the ACL cache is older than age (), the file will be reloaded.

The file is is expected to confrom to the following:
* Each line is expected to be in the format:

[access] [user name]

* [access] is expected to be "allow", or "monitor" (case insensitive). All other values evaluate to "deny".
* [user name] is expected to be the user's netid.
* Comments are allowed anywhere; must be preceded with a hashmark (#), and continue to the end of the line.
* Any amount of whitespace between access and user name is permitted. * Blank lines are ignored.
* Multiple entries for any name will not throw an error. The last value encountered will be the access level for that name.

If a particular name doesn't have an entry in the ACL file, the default access level (the access level for all) will be used. By default all has the access level allow.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ACL(java.lang.String path, java.lang.String name) Create a new ACL with an age of 300 (five minutes).
ACL(java.lang.String path, java.lang.String name, long age) Create a new ACL with an arbitrary age.

Method Summary

Modifier and Type	Method and Description
java.lang.String	access(java.lang.String user_name) Fetch the access value associated with a user name.
long	age() Fetch the maximum age before this cache is considered old.
ACL	age(long age) Set the maximum age before this cache is considered old.
java.lang.Boolean	has_access(java.lang.String user_name) Transform the access string for name into a boolean value.
java.lang.Boolean	has_access(java.lang.String user_name, java.lang.String access_check) Check if user_name has access_check access.

Methods inherited from class stanford.netdb.logging.NetDB_Logger

backup_logger, backup_logger, default_logger, default_logger, entered, entered, entered, exited, exited, exited, get_method_name, log_enter_exit, log_message, logger, logger

Methods inherited from class java.lang.Object

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

Constructor Detail

ACL

public ACL(java.lang.String path,
           java.lang.String name)

Create a new ACL with an age of 300 (five minutes).

Parameters:

path - Path to the ACL file on the disk.

name - Name of the ACL. All instances of ACL with the same name will share the same cache.

ACL

public ACL(java.lang.String path,
           java.lang.String name,
           long age)

Create a new ACL with an arbitrary age.

Parameters:

path - Path to the ACL file on the disk.

name - Name of the ACL. All instances of ACL with the same name will share the same cache.

Method Detail

access

public java.lang.String access(java.lang.String user_name)
                        throws java.lang.Exception

Fetch the access value associated with a user name. This method caches the ACL file contents into memory and will update it every CACHE_AGE seconds. In order to ensure that an out of date cache isn't updated more than once, the method is synchronized.

Throws:

java.lang.Exception

has_access

public java.lang.Boolean has_access(java.lang.String user_name)
                             throws java.lang.Exception

Transform the access string for name into a boolean value.

Returns:

true if the access contains "allow" or "monitor"

Throws:

java.lang.Exception

has_access

public java.lang.Boolean has_access(java.lang.String user_name,
                                    java.lang.String access_check)
                             throws java.lang.Exception

Check if user_name has access_check access.

Returns:

true if the access contains access_check

Throws:

java.lang.Exception

age

public long age()

Fetch the maximum age before this cache is considered old.

age

public ACL age(long age)

Set the maximum age before this cache is considered old.