vqServer API Class vq.server.Acl

java.lang.Object
    |
    +----vq.utils.klentry
            |
            +----vq.server.Acl
Contents
Package index
Package
API index

public class Acl
extends klentry
Represents a vqServer access control list (ACL). Warning: the key field is used to store a unique identifier and should not be modified.


Constructor Index

 o Acl()
Creates a new ACL.

Method Index

 o getID()
Returns the ID of the access control list (as used in the acl field of a self-registration page).
 o getMembers()
Returns the list of members of the access control list.
 o getName()
Returns the name of the access control list (as displayed in the vqServer control centre).
 o getSelfReg()
Returns true if self-registration is enabled for the access control list.
 o getUseCustom()
Returns true if a custom login page is enabled for the access control list.
 o isMember(Acl, boolean)
Returns true if the specified ACL is a member of the access control list.
 o isMember(User, boolean)
Returns true if the specified user is a member of the access control list.
 o kill()
Kills the ACL.
 o save(vqos)
Writes the ACL to the output stream specified in vqServer .cfg file format.
 o setName(String)
Sets the name of the access control list.
 o setSelfReg(boolean)
Enables or disables self-registration for the access control list.
 o setUseCustom(boolean)
Enables or disables use of a custom login page for the access control list.

Constructor Detail

 o Acl
public Acl()
          Creates a new ACL.

Method Detail

 o kill
public void kill()
          Kills the ACL. Warning: do not invoke this method if the ACL is a member of a list.
Overrides:
kill in class klentry
 o save
public void save(vqos os) throws java.io.IOException
          Writes the ACL to the output stream specified in vqServer .cfg file format.
Parameters:
os - the output stream to write the ACL to
Overrides:
save in class klentry
 o getID
public java.lang.String getID()
          Returns the ID of the access control list (as used in the acl field of a self-registration page).
 o getName
public java.lang.String getName()
          Returns the name of the access control list (as displayed in the vqServer control centre).
 o setName
public void setName(java.lang.String name)
          Sets the name of the access control list. After using this method, call Acls.remove() and Acls.add() to maintain the ordering of entries in ACLs.
 o getUseCustom
public boolean getUseCustom()
          Returns true if a custom login page is enabled for the access control list.
 o setUseCustom
public void setUseCustom(boolean useCustom)
          Enables or disables use of a custom login page for the access control list.
 o getSelfReg
public boolean getSelfReg()
          Returns true if self-registration is enabled for the access control list.
 o setSelfReg
public void setSelfReg(boolean allowed)
          Enables or disables self-registration for the access control list.
 o isMember
public boolean isMember(User theUser,
                        boolean searchNested)
          Returns true if the specified user is a member of the access control list. If searchNested is true any nested access control lists are searched recursively.
 o isMember
public boolean isMember(Acl theAcl,
                        boolean searchNested)
          Returns true if the specified ACL is a member of the access control list. If searchNested is true any nested access control lists are searched recursively.
 o getMembers
public kllist getMembers()
          Returns the list of members of the access control list. Entries in the list returned are all instances of AclEntry. Warning: vqServer will not operate correctly if you add anything other than instances of AclEntry to this list.


vqServer API version 1.9. vqServer and the vqServer API are copyright © Steve Shering and vqSoft 1997-2000. Last updated 15 May 2000.

Contents
Package index
Package
API index