li.strolch.runtime.privilege

Class DefaultStrolchPrivilegeHandler

java.lang.Object

li.strolch.agent.api.StrolchComponent

li.strolch.runtime.privilege.DefaultStrolchPrivilegeHandler

All Implemented Interfaces:

PrivilegeHandler

public class DefaultStrolchPrivilegeHandler
extends StrolchComponent
implements PrivilegeHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRIVILEGE_CONFIG_XML
static String	PROP_PRIVILEGE_CONFIG_FILE

Fields inherited from class li.strolch.agent.api.StrolchComponent

COMPONENT_VERSION_PROPERTIES, logger

Constructor Summary

Constructors

Constructor and Description
DefaultStrolchPrivilegeHandler(ComponentContainer container, String componentName)

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
void	initialize(ComponentConfiguration configuration) Life cycle step initialize.
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) Performs the given PrivilegedRunnable as the given system user
void	runAs(String username, SystemAction action) Performs the given PrivilegedRunnable as the given system user
void	runAsAgent(PrivilegedRunnable runnable) Performs the given PrivilegedRunnable as the privileged system user StrolchConstants.SYSTEM_USER_AGENT
void	runAsAgent(SystemAction action) Performs the given PrivilegedRunnable as the given system user
<T> T	runAsAgentWithResult(PrivilegedRunnableWithResult<T> runnable) Performs the given PrivilegedRunnable as the privileged system user StrolchConstants.SYSTEM_USER_AGENT
<T> T	runAsAgentWithResult(SystemActionWithResult<T> action) Performs the given PrivilegedRunnable as the given system user
<T> T	runWithResult(String username, PrivilegedRunnableWithResult<T> runnable) Performs the given PrivilegedRunnable as the given system user
<T> T	runWithResult(String username, SystemActionWithResult<T> action) Performs the given PrivilegedRunnable as the given system user
boolean	sessionTimeout(Certificate certificate) Notifies that the session has timed out, i.e.

Methods inherited from class li.strolch.agent.api.StrolchComponent

assertContainerStarted, assertStarted, destroy, getConfiguration, getContainer, getName, getState, getVersion, setup, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

PROP_PRIVILEGE_CONFIG_FILE

public static final String PROP_PRIVILEGE_CONFIG_FILE

See Also:

Constant Field Values

PRIVILEGE_CONFIG_XML

public static final String PRIVILEGE_CONFIG_XML

See Also:

Constant Field Values

Constructor Detail

DefaultStrolchPrivilegeHandler

public DefaultStrolchPrivilegeHandler(ComponentContainer container,
                                      String componentName)

Method Detail

initialize

public void initialize(ComponentConfiguration configuration)
                throws Exception

Description copied from class: StrolchComponent

Life cycle step initialize. Here you would typically read configuration values

Overrides:

initialize in class StrolchComponent

Throws:

Exception

authenticate

public Certificate authenticate(String username,
                                byte[] password)

Description copied from interface: PrivilegeHandler

Authenticate a user

Specified by:

authenticate in interface PrivilegeHandler

Parameters:

username - the username

password - the password

Returns:

the certificate

See Also:

PrivilegeHandler.authenticate(String, byte[])

isCertificateValid

public void isCertificateValid(Certificate certificate)
                        throws PrivilegeException

Description copied from interface: PrivilegeHandler

Validate that the certificate is still valid

Specified by:

isCertificateValid in interface PrivilegeHandler

Parameters:

certificate - the certificate

Throws:

PrivilegeException - if the certificate is not valid

See Also:

PrivilegeHandler.isCertificateValid(Certificate)

invalidateSession

public boolean invalidateSession(Certificate certificate)

Description copied from interface: PrivilegeHandler

Invalidates the given certificate

Specified by:

invalidateSession in interface PrivilegeHandler

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

public boolean sessionTimeout(Certificate certificate)

Description copied from interface: PrivilegeHandler

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

Specified by:

sessionTimeout in interface PrivilegeHandler

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)

runAs

public void runAs(String username,
                  SystemAction action)
           throws PrivilegeException

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the given system user

Specified by:

runAs in interface PrivilegeHandler

Overrides:

runAs in class StrolchComponent

Parameters:

username - the name of the system user to perform the action as

action - the action to perform

Throws:

PrivilegeException - if there is something wrong

runWithResult

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

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the given system user

Specified by:

runWithResult in interface PrivilegeHandler

Overrides:

runWithResult in class StrolchComponent

Parameters:

username - the name of the system user to perform the action as

action - the action to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

runAs

public void runAs(String username,
                  PrivilegedRunnable runnable)
           throws PrivilegeException

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the given system user

Specified by:

runAs in interface PrivilegeHandler

Overrides:

runAs in class StrolchComponent

Parameters:

username - the name of the system user to perform the action as

runnable - the runnable to perform

Throws:

PrivilegeException - if there is something wrong

runWithResult

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

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the given system user

Specified by:

runWithResult in interface PrivilegeHandler

Overrides:

runWithResult in class StrolchComponent

Parameters:

username - the name of the system user to perform the action as

runnable - the runnable to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

runAsAgent

public void runAsAgent(SystemAction action)
                throws PrivilegeException

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the given system user

Specified by:

runAsAgent in interface PrivilegeHandler

Overrides:

runAsAgent in class StrolchComponent

Parameters:

action - the action to perform

Throws:

PrivilegeException - if there is something wrong

runAsAgentWithResult

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

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the given system user

Specified by:

runAsAgentWithResult in interface PrivilegeHandler

Overrides:

runAsAgentWithResult in class StrolchComponent

Parameters:

action - the action to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

runAsAgent

public void runAsAgent(PrivilegedRunnable runnable)
                throws PrivilegeException

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the privileged system user StrolchConstants.SYSTEM_USER_AGENT

Specified by:

runAsAgent in interface PrivilegeHandler

Overrides:

runAsAgent in class StrolchComponent

Parameters:

runnable - the runnable to perform

Throws:

PrivilegeException - if there is something wrong

runAsAgentWithResult

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

Description copied from class: StrolchComponent

Performs the given PrivilegedRunnable as the privileged system user StrolchConstants.SYSTEM_USER_AGENT

Specified by:

runAsAgentWithResult in interface PrivilegeHandler

Overrides:

runAsAgentWithResult in class StrolchComponent

Parameters:

runnable - the runnable to perform

Returns:

the result

Throws:

PrivilegeException - if there is something wrong

getPrivilegeContext

public PrivilegeContext getPrivilegeContext(Certificate certificate)
                                     throws PrivilegeException

Description copied from interface: PrivilegeHandler

Returns the PrivilegeContext for the given certificate

Specified by:

getPrivilegeContext in interface PrivilegeHandler

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)

getPrivilegeHandler

public PrivilegeHandler getPrivilegeHandler()

Description copied from interface: PrivilegeHandler

Returns the PrivilegeHandler

Specified by:

getPrivilegeHandler in interface PrivilegeHandler

Returns:

the PrivilegeHandler