com.ecyrd.jspwiki.auth.acl
Interface AclManager

All Known Implementing Classes:
DefaultAclManager

public interface AclManager

Specifies how to parse and return ACLs from wiki pages.

Since:
2.3
Version:
$Revision: 1.3 $ $Date: 2005/08/07 22:06:09 $
Author:
Andrew Jaquith

Method Summary
 Acl getPermissions(WikiPage page)
          Returns the access control list for the page.
 void initialize(WikiEngine engine, Properties props)
          Initializes the AclManager with a supplied wiki engine and properties.
 Acl parseAcl(WikiPage page, String ruleLine)
          A helper method for parsing textual AccessControlLists.
 

Method Detail

initialize

void initialize(WikiEngine engine,
                Properties props)
Initializes the AclManager with a supplied wiki engine and properties.

Parameters:
engine - the wiki engine
props - the initialization properties

parseAcl

Acl parseAcl(WikiPage page,
             String ruleLine)
             throws WikiSecurityException
A helper method for parsing textual AccessControlLists. The line is in form "(ALLOW) , , ". This method was moved from Authorizer.

Parameters:
page - The current wiki page. If the page already has an ACL, it will be used as a basis for this ACL in order to avoid the creation of a new one.
ruleLine - The rule line, as described above.
Returns:
A valid Access Control List. May be empty.
Throws:
WikiSecurityException, - if the ruleLine was faulty somehow.
WikiSecurityException
Since:
2.1.121

getPermissions

Acl getPermissions(WikiPage page)
Returns the access control list for the page. If the ACL has not been parsed yet, it is done on-the-fly. If the page has a parent page, then that is tried also. This method was moved from Authorizer; it was consolidated with some code from AuthorizationManager.

Parameters:
page -
Returns:
the Acl representing permissions for the page
Since:
2.2.121