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