org.apache.turbine.util
Class SecurityCheck

java.lang.Object
  |
  +--org.apache.turbine.util.SecurityCheck

public class SecurityCheck
extends java.lang.Object

Utility for doing security checks in Screens and Actions. Sample usage:
SecurityCheck mycheck = new SecurityCheck(data, "Unauthorized to do this!", "WrongPermission"); if ( !mycheck.hasPermission("add_user"); return;

Version:
$Id$
Author:
Dave Bryson

Field Summary
private  RunData data
           
private  java.lang.String failScreen
           
private  java.lang.String message
           
 
Constructor Summary
SecurityCheck(RunData data, java.lang.String message, java.lang.String failedScreen)
          Constructor.
 
Method Summary
 java.lang.String getFailScreen()
          Get the screen that should be displayed.
 java.lang.String getMessage()
          Get the message that should be displayed.
 boolean hasPermission(Permission permission)
          Does the user have this permission?
 boolean hasPermission(java.lang.String permission)
          Does the user have this permission?
 boolean hasRole(Role role)
          Does the user have this role?
 boolean hasRole(java.lang.String role)
          Does the user have this role?
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

message

private java.lang.String message

failScreen

private java.lang.String failScreen

data

private RunData data
Constructor Detail

SecurityCheck

public SecurityCheck(RunData data,
                     java.lang.String message,
                     java.lang.String failedScreen)
Constructor.
Parameters:
data - A Turbine RunData object.
message - The message to display upon failure.
failedScreen - The screen to redirect to upon failure.
Method Detail

hasRole

public boolean hasRole(Role role)
                throws java.lang.Exception
Does the user have this role?
Parameters:
role - A Role.
Returns:
True if the user has this role.
Throws:
Exception, - a generic exception.

hasRole

public boolean hasRole(java.lang.String role)
                throws java.lang.Exception
Does the user have this role?
Parameters:
role - A String.
Returns:
True if the user has this role.
Throws:
Exception, - a generic exception.

hasPermission

public boolean hasPermission(Permission permission)
                      throws java.lang.Exception
Does the user have this permission?
Parameters:
permission - A Permission.
Returns:
True if the user has this permission.
Throws:
Exception, - a generic exception.

hasPermission

public boolean hasPermission(java.lang.String permission)
                      throws java.lang.Exception
Does the user have this permission?
Parameters:
permission - A String.
Returns:
True if the user has this permission.
Throws:
Exception, - a generic exception.

getMessage

public java.lang.String getMessage()
Get the message that should be displayed. This is initialized in the constructor.
Returns:
A String.

getFailScreen

public java.lang.String getFailScreen()
Get the screen that should be displayed. This is initialized in the constructor.
Returns:
A String.


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.