|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Authorizer
Interface for service providers of authorization information. After a user
successfully logs in, the
AuthenticationManager
consults the configured
Authorizer to determine which additional
Role
principals should be added to
the user's WikiSession. To determine which roles should be injected, the
Authorizer is queried for the roles it knows about by calling
getRoles()
. Then, each role
returned by the Authorizer is tested by calling
isUserInRole(WikiSession, Principal)
.
If this check fails, and the Authorizer is of type WebAuthorizer,
AuthenticationManager checks the role again by calling
WebAuthorizer.isUserInRole(javax.servlet.http.HttpServletRequest, Principal)
).
Any roles that pass the test are injected into the Subject by firing
appropriate authentication events.
Method Summary | |
---|---|
Principal |
findRole(String role)
Looks up and returns a role Principal matching a given String. |
Principal[] |
getRoles()
Returns an array of role Principals this Authorizer knows about. |
void |
initialize(WikiEngine engine,
Properties props)
Initializes the authorizer. |
boolean |
isUserInRole(WikiSession session,
Principal role)
Determines whether the Subject associated with a WikiSession is in a particular role. |
Method Detail |
---|
Principal[] getRoles()
Principal findRole(String role)
null
.
Note that it may not always be feasible for an Authorizer implementation
to return a role Principal.
role
- the name of the role to retrieve
void initialize(WikiEngine engine, Properties props) throws WikiSecurityException
engine
- the current wiki engineprops
- the wiki engine initialization properties
WikiSecurityException
- if the Authorizer could not be initializedboolean isUserInRole(WikiSession session, Principal role)
null
, this method must
return false
.
session
- the current WikiSessionrole
- the role to check
true
if the user is considered to be in the role,
false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |