Package org.codice.ddf.security

Interface Security

public interface Security

Method Summary

Modifier and Type	Method	Description
Subject	getGuestSubject(String ipAddress)	Gets the guest Subject associated with the specified IP.
Subject	getSubject(String username, String password, String ip)
KeyStore	getSystemKeyStore()
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.

Method Details

getSubject

Subject getSubject(String username,
 String password,
 String ip)

javaSubjectHasAdminRole

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

Throws:

SecurityException - if a security manager exists and the AuthPermission("getSubject") permission is not authorized

runWithSubjectOrElevate

<T> T runWithSubjectOrElevate(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

SecurityException - if a security manager exists and the AuthPermission("getSystemSubject") or AuthPermission("getSubject") permissions are not authorized

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

getSystemSubject

@Nullable
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

Throws:

SecurityException - if a security manager exists and the AuthPermission("getSystemSubject") or AuthPermission("getSubject") permissions are not authorized

getGuestSubject

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

runAsAdmin

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

runAsAdminWithException

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

Throws:

PrivilegedActionException

getSystemKeyStore

KeyStore getSystemKeyStore()