org.benow.security
Class Security

java.lang.Object
  org.benow.security.Security

public class Security
extends java.lang.Object

security: org.benow.security.SecurityFactory

Author:

andy

Field Summary

static java.lang.String	CFG_ADMINISTRATOR_CLASS
static java.lang.String	RUN_USER

Constructor Summary

Security()

Method Summary

static void	assertPermission(Permission toAssert)
static User	authenticate(java.lang.String userName, java.lang.String password)
static User	authenticate(java.lang.String domain, java.lang.String userName, java.lang.String password)
static Role	createRole(java.lang.String name)
static org.benow.java.run.Runner	createSecureRunner(User user)
static java.lang.Thread	createSecureThread(java.lang.String userName, java.lang.Runnable runnable)
static java.lang.Thread	createSecureThread(User user, java.lang.Runnable runnable)
static User	createUser(java.lang.String name)
static User	currentUser() Synonym for get current user
static Permission	declareLocalPermission(java.lang.String name) Creates a permission local to the calling class (if called during initial field assignment) with given suffix
static SecurityAdministrator	getAdministrator()
static User	getAdminUser()
static User	getCurrentUser()
static User	getDefaultUser()
static Role	getRole(java.lang.String name)
static java.util.Collection<Role>	getRoles()
static User	getUserByEmail(java.lang.String email)
static User	getUserByName(java.lang.String name)
static boolean	hasPermission(Permission perm) Convenience method.
static boolean	isAdministratorUser()
static boolean	isDefaultUser()
static void	log(java.lang.String msg) Log a message to the security logger.
static void	logout()
static void	prepForRun(org.benow.java.run.Runner runner, User user)
static void	runAs(java.lang.String userName, java.lang.Runnable runnable)
static void	runAs(User user, java.lang.Runnable runnable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CFG_ADMINISTRATOR_CLASS

public static java.lang.String CFG_ADMINISTRATOR_CLASS

RUN_USER

public static final java.lang.String RUN_USER

Constructor Detail

Security

public Security()

Method Detail

getAdministrator

public static SecurityAdministrator getAdministrator()

declareLocalPermission

public static Permission declareLocalPermission(java.lang.String name)

Creates a permission local to the calling class (if called during initial field assignment) with given suffix

Parameters:

string -

Returns:

authenticate

public static User authenticate(java.lang.String userName,
                                java.lang.String password)

createSecureRunner

public static org.benow.java.run.Runner createSecureRunner(User user)

prepForRun

public static void prepForRun(org.benow.java.run.Runner runner,
                              User user)

createUser

public static User createUser(java.lang.String name)

authenticate

public static User authenticate(java.lang.String domain,
                                java.lang.String userName,
                                java.lang.String password)

isDefaultUser

public static boolean isDefaultUser()

isAdministratorUser

public static boolean isAdministratorUser()

getUserByName

public static User getUserByName(java.lang.String name)

getRole

public static Role getRole(java.lang.String name)
                    throws NoSuchRoleException

Throws:

NoSuchRoleException

getRoles

public static java.util.Collection<Role> getRoles()

getCurrentUser

public static User getCurrentUser()

getDefaultUser

public static User getDefaultUser()

assertPermission

public static void assertPermission(Permission toAssert)

getUserByEmail

public static User getUserByEmail(java.lang.String email)

createRole

public static Role createRole(java.lang.String name)

hasPermission

public static boolean hasPermission(Permission perm)

Convenience method. Does current user have given permission.

Parameters:

perm -

Returns:

log

public static void log(java.lang.String msg)

Log a message to the security logger. If configured, security events are logged to a separate file.

Parameters:

msg -

logout

public static void logout()

createSecureThread

public static java.lang.Thread createSecureThread(java.lang.String userName,
                                                  java.lang.Runnable runnable)

createSecureThread

public static java.lang.Thread createSecureThread(User user,
                                                  java.lang.Runnable runnable)

runAs

public static void runAs(java.lang.String userName,
                         java.lang.Runnable runnable)

runAs

public static void runAs(User user,
                         java.lang.Runnable runnable)

getAdminUser

public static User getAdminUser()

currentUser

public static User currentUser()

Synonym for get current user

Returns: