org.codice.ddf.security.common

Class Security

java.lang.Object

org.codice.ddf.security.common.Security

public class Security
extends Object

Singleton class that provides common security related utility functions. To use, get the instance of the class using getInstance() and call the desired method, or inject as a dependency.

IMPORTANT: New methods added to this class should be non-static.

Method Summary

Modifier and Type	Method and Description
Date	getExpires(Subject subject) Get the expires time from the Subject's token.
Subject	getGuestSubject(String ipAddress) Gets the guest Subject associated with the specified IP.
static Security	getInstance()
SecurityManager	getSecurityManager() Gets a reference to the SecurityManager.
Subject	getSubject(String username, String password) Gets the Subject given a user name and password.
Subject	getSystemSubject() Gets the Subject associated with this system.
boolean	javaSubjectHasAdminRole() Determines if the current Java Subject has the admin role.
<T> T	runAsAdmin(PrivilegedAction<T> action)
<T> T	runAsAdminWithException(PrivilegedExceptionAction<T> action)
<T> T	runWithSubjectOrElevate(Callable<T> codeToRun) Runs the Callable in the current thread as the current security framework's Subject.
boolean	tokenAboutToExpire(Subject subject) Determines whether a Subject's token is about to expire or not.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Security getInstance()

Returns:

unique instance of this class. Never null.

getSubject

public Subject getSubject(String username,
                          String password)

Gets the Subject given a user name and password.

Parameters:

username - username

password - password

Returns:

Subject associated with the user name and password provided

javaSubjectHasAdminRole

public boolean javaSubjectHasAdminRole()

Determines if the current Java Subject has the admin role.

Returns:

true if the Java Subject exists and has the admin role, false otherwise

runWithSubjectOrElevate

public <T> T runWithSubjectOrElevate(@NotNull
                                     Callable<T> codeToRun)
                              throws SecurityServiceException,
                                     InvocationTargetException

Runs the Callable in the current thread as the current security framework's Subject. If the security framework's Subject is not currently set and the Java Subject contains the admin role, elevates and runs the Callable as the system Subject.

Type Parameters:

T - type of the returned value

Parameters:

codeToRun - code to run

Returns:

value returned by the Callable

Throws:

SecurityServiceException - if the current subject didn' have enough permissions to run the code

InvocationTargetException - wraps any exception thrown by Callable.call(). Callable exception can be retrieved using the InvocationTargetException.getCause().

getSystemSubject

@Nullable
public Subject getSystemSubject()

Gets the Subject associated with this system. Uses a cached subject since the subject will not change between calls.

Returns:

system's Subject or null if unable to get the system's Subject

getGuestSubject

public Subject getGuestSubject(String ipAddress)

Gets the guest Subject associated with the specified IP. Uses a cached subject when possible since the subject will not change between calls.

Returns:

system's Subject

tokenAboutToExpire

public boolean tokenAboutToExpire(Subject subject)

Determines whether a Subject's token is about to expire or not.

Parameters:

subject - subject whose token needs to be checked

Returns:

true only if the Subject's token will expire soon

getExpires

public Date getExpires(Subject subject)

Get the expires time from the Subject's token.

Parameters:

subject - subject whose token needs to be checked

Returns:

Date or null if subject doesn't have an expire time.

getSecurityManager

@Nullable
public SecurityManager getSecurityManager()

Gets a reference to the SecurityManager.

Returns:

reference to the SecurityManager or null if unable to get the SecurityManager

runAsAdmin

public <T> T runAsAdmin(PrivilegedAction<T> action)

runAsAdminWithException

public <T> T runAsAdminWithException(PrivilegedExceptionAction<T> action)
                              throws PrivilegedActionException

Throws:

PrivilegedActionException