|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.turbine.util.template.TemplateSecurityCheck
public class TemplateSecurityCheck
Utility class to help check for proper authorization when using template screens. Sample usages:
TemplateSecurityCheck secCheck = new TemplateSecurityCheck( data );
secCheck.setMessage( "Sorry, you do not have permission to " +
"access this area." );
secCheck.setFailTemplate("login.wm");
if ( !secCheck.hasRole("ADMIN") )
return;
Constructor Summary | |
---|---|
TemplateSecurityCheck(RunData data)
Generic Constructor. |
|
TemplateSecurityCheck(RunData data,
String message)
Constructor. |
Method Summary | |
---|---|
boolean |
checkLogin()
Check that the user has logged in. |
String |
getFailScreen()
Get the value of failScreen. |
String |
getFailTemplate()
Get the value of failTemplate. |
String |
getMessage()
Get the message that should be displayed. |
boolean |
hasPermission(Permission permission)
Does the User have this permission? |
boolean |
hasRole(Role role)
Does the User have this role? |
void |
setFailScreen(String v)
Set the value of failScreen. |
void |
setFailTemplate(String v)
Set the value of failTemplate. |
void |
setMessage(String v)
Set the message that should be displayed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TemplateSecurityCheck(RunData data, String message)
data
- A Turbine RunData object.message
- A String with the message to display upon
failure.public TemplateSecurityCheck(RunData data)
data
- A Turbine RunData object.Method Detail |
---|
public boolean hasRole(Role role) throws Exception
role
- The role to be checked.
Exception
- Trouble validating.public boolean hasPermission(Permission permission) throws Exception
permission
- The permission to be checked.
Exception
- Trouble validating.public boolean checkLogin() throws Exception
Exception,
- a generic exception.
Exception
public void setMessage(String v)
v
- A String with the message that should be displayed.public String getMessage()
public String getFailScreen()
public void setFailScreen(String v)
v
- A String with the value of failScreen.public String getFailTemplate()
public void setFailTemplate(String v)
v
- A String with the value of failTemplate.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |