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

Author:

Andrew Jaquith

Method Summary

Modifier and Type	Method and Description
Acl	getPermissions(WikiPage page) Returns the access control list for the page.
void	initialize(WikiEngine engine, java.util.Properties props) Initializes the AclManager with a supplied wiki engine and properties.
Acl	parseAcl(WikiPage page, java.lang.String ruleLine) A helper method for parsing textual AccessControlLists.
void	setPermissions(WikiPage page, Acl acl) Sets the access control list for the page and persists it.

Method Detail

initialize

void initialize(WikiEngine engine,
                java.util.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,
             java.lang.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.

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 - the wiki page

Returns:

the Acl representing permissions for the page

Since:

2.2.121

setPermissions

void setPermissions(WikiPage page,
                    Acl acl)
             throws WikiSecurityException

Sets the access control list for the page and persists it.

Parameters:

page - the wiki page

acl - the access control list

Throws:

WikiSecurityException - if the ACL cannot be set or persisted

Since:

2.5