li.strolch.runtime.privilege

Interface PrivilegeHandler

All Known Implementing Classes:

DefaultStrolchPrivilegeHandler

public interface PrivilegeHandler

The privilege handler for authenticating users and performing actions as a system user

Author:

Robert von Burg

Method Summary

Modifier and Type	Method and Description
Certificate	authenticate(String username, byte[] password) Authenticate a user
PrivilegeContext	getPrivilegeContext(Certificate certificate) Returns the PrivilegeContext for the given certificate
PrivilegeHandler	getPrivilegeHandler() Returns the PrivilegeHandler
boolean	invalidateSession(Certificate certificate) Invalidates the given certificate
void	isCertificateValid(Certificate certificate) Validate that the certificate is still valid
void	runAs(String username, PrivilegedRunnable runnable) Run the given PrivilegedRunnable as the given system user
void	runAs(String username, SystemAction action) Run the given SystemAction as the given system user
void	runAsAgent(PrivilegedRunnable runnable) Run the given PrivilegedRunnable as the system user StrolchConstants.SYSTEM_USER_AGENT
void	runAsAgent(SystemAction action) Run the given SystemAction as the system user StrolchConstants.SYSTEM_USER_AGENT
<T> T	runAsAgentWithResult(PrivilegedRunnableWithResult<T> runnable) Run the given PrivilegedRunnableWithResult as the system user StrolchConstants.SYSTEM_USER_AGENT
<T> T	runAsAgentWithResult(SystemActionWithResult<T> action) Run the given SystemActionWithResult as the system user StrolchConstants.SYSTEM_USER_AGENT
<T> T	runWithResult(String username, PrivilegedRunnableWithResult<T> runnable) Run the given PrivilegedRunnable as the given system user
<T> T	runWithResult(String username, SystemActionWithResult<T> action) Run the given SystemActionWithResult as the given system user
boolean	sessionTimeout(Certificate certificate) Notifies that the session has timed out, i.e.

Method Detail

authenticate

Certificate authenticate(String username,
                         byte[] password)

Authenticate a user

Parameters:

username - the username

password - the password

Returns:

the certificate

See Also:

PrivilegeHandler.authenticate(String, byte[])

isCertificateValid

void isCertificateValid(Certificate certificate)
                 throws PrivilegeException

Validate that the certificate is still valid

Parameters:

certificate - the certificate

Throws:

PrivilegeException - if the certificate is not valid

See Also:

PrivilegeHandler.isCertificateValid(Certificate)

invalidateSession

boolean invalidateSession(Certificate certificate)

Invalidates the given certificate

Parameters:

certificate - the certificate

Returns:

true if the certificate was invalidated, or false if it was already invalidated

See Also:

PrivilegeHandler.invalidateSession(li.strolch.privilege.model.Certificate)

sessionTimeout

boolean sessionTimeout(Certificate certificate)

Notifies that the session has timed out, i.e. the certificate must be invalidated

Parameters:

certificate - the certificate that has timed out

Returns:

true if the certificate was invalidated, or false it was already invalidated

See Also:

PrivilegeHandler.invalidateSession(li.strolch.privilege.model.Certificate)

getPrivilegeContext

PrivilegeContext getPrivilegeContext(Certificate certificate)
                              throws PrivilegeException

Returns the PrivilegeContext for the given certificate

Parameters:

certificate - the certificate

Returns:

the PrivilegeContext for the given certificate

Throws:

PrivilegeException - if the certificate is not valid anymore

See Also:

PrivilegeHandler.getPrivilegeContext(li.strolch.privilege.model.Certificate)

runAs

void runAs(String username,
           SystemAction action)
    throws PrivilegeException

Run the given SystemAction as the given system user

Parameters:

username - the system username

action - the action to perform

Throws:

PrivilegeException - if there is something wrong

runWithResult

<T> T runWithResult(String username,
                    SystemActionWithResult<T> action)
             throws PrivilegeException

Run the given SystemActionWithResult as the given system user

Parameters:

username - the system username

action - the action to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

runAs

void runAs(String username,
           PrivilegedRunnable runnable)
    throws PrivilegeException

Run the given PrivilegedRunnable as the given system user

Parameters:

username - the system username

runnable - the runnable to perform

Throws:

PrivilegeException - if there is something wrong

runWithResult

<T> T runWithResult(String username,
                    PrivilegedRunnableWithResult<T> runnable)
             throws PrivilegeException

Run the given PrivilegedRunnable as the given system user

Parameters:

username - the system username

runnable - the runnable to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

runAsAgent

void runAsAgent(SystemAction action)
         throws PrivilegeException

Run the given SystemAction as the system user StrolchConstants.SYSTEM_USER_AGENT

Parameters:

runnable - the runnable to perform

Throws:

PrivilegeException - if there is something wrong

runAsAgentWithResult

<T> T runAsAgentWithResult(SystemActionWithResult<T> action)
                    throws PrivilegeException

Run the given SystemActionWithResult as the system user StrolchConstants.SYSTEM_USER_AGENT

Parameters:

runnable - the runnable to perform

Throws:

PrivilegeException - if there is something wrong

runAsAgent

void runAsAgent(PrivilegedRunnable runnable)
         throws PrivilegeException

Run the given PrivilegedRunnable as the system user StrolchConstants.SYSTEM_USER_AGENT

Parameters:

runnable - the runnable to perform

Throws:

PrivilegeException - if there is something wrong

runAsAgentWithResult

<T> T runAsAgentWithResult(PrivilegedRunnableWithResult<T> runnable)
                    throws PrivilegeException

Run the given PrivilegedRunnableWithResult as the system user StrolchConstants.SYSTEM_USER_AGENT

Parameters:

runnable - the runnable to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

getPrivilegeHandler

PrivilegeHandler getPrivilegeHandler()

Returns the PrivilegeHandler

Returns:

the PrivilegeHandler