li.strolch.service.api

Class AbstractService<T extends ServiceArgument,U extends ServiceResult>

java.lang.Object

li.strolch.service.api.AbstractService<T,U>

All Implemented Interfaces:

Serializable, Restrictable, Service<T,U>

public abstract class AbstractService<T extends ServiceArgument,U extends ServiceResult>
extends Object
implements Service<T,U>

Author:

Robert von Burg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
AbstractService()

Method Summary

Modifier and Type	Method and Description
U	doService(T argument) This method is final as it enforces that the argument is valid, and catches all exceptions and enforces that a service result is returned.
protected Certificate	getCertificate() Returns the Certificate of the user who is performing this service
protected <V> V	getComponent(Class<V> clazz) Returns the reference to the StrolchComponent with the given name, if it exists.
protected ComponentContainer	getContainer() Returns the reference to the ComponentContainer
PrivilegeContext	getPrivilegeContext() Return the PrivilegeContext to perform further privilege authorization validation
PrivilegeHandler	getPrivilegeHandler() Returns the reference to the PrivilegeHandler
String	getPrivilegeName()
Object	getPrivilegeValue()
protected StrolchRealm	getRealm(String realm) Returns the StrolchRealm with the given name.
protected abstract U	getResultInstance() This method is called if the service execution fails and an instance of the expected ServiceResult is required to return to the caller
protected RuntimeConfiguration	getRuntimeConfiguration() Returns the Strolch RuntimeConfiguration
protected abstract U	internalDoService(T arg) Internal method to perform the Service.
protected boolean	isArgumentRequired() Returns true if this Service requires an argument
protected StrolchTransaction	openArgOrUserTx(ServiceArgument arg) Opens a StrolchTransaction by evaluating if the given argument has a realm defined, if not, then the realm from the user certificate is used.
protected StrolchTransaction	openArgOrUserTx(ServiceArgument arg, String action) Opens a StrolchTransaction by evaluating if the given argument has a realm defined, if not, then the realm from the user certificate is used.
protected StrolchTransaction	openTx(String realm) Opens a StrolchTransaction for the given realm, the action for the TX is this implementation's class name.
protected StrolchTransaction	openTx(String realm, String action) Opens a StrolchTransaction for the given realm.
protected StrolchTransaction	openUserTx() Opens a StrolchTransaction where the realm retrieved using ComponentContainer.getRealm(Certificate), the action for the TX is this implementation's class name.
protected StrolchTransaction	openUserTx(String action) Opens a StrolchTransaction where the realm retrieved using ComponentContainer.getRealm(Certificate).
protected void	runAs(String username, PrivilegedRunnable runnable) Performs the given PrivilegedRunnable as a system user with the given username
protected void	runAs(String username, SystemAction action) Performs the given SystemAction as a system user with the given username
protected void	runAsAgent(PrivilegedRunnable runnable) Performs the given PrivilegedRunnable as the privileged system user StrolchConstants.SYSTEM_USER_AGENT
protected void	runAsAgent(SystemAction action) Performs the given SystemAction as the privileged system user StrolchConstants.SYSTEM_USER_AGENT
protected <V> V	runAsAgentWithResult(PrivilegedRunnableWithResult<V> runnable) Performs the given PrivilegedRunnableWithResult as the privileged system user StrolchConstants.SYSTEM_USER_AGENT
protected <V> V	runAsAgentWithResult(SystemActionWithResult<V> action) Performs the given SystemAction as the privileged system user StrolchConstants.SYSTEM_USER_AGENT
protected <V> V	runWithResult(String username, PrivilegedRunnableWithResult<V> runnable) Performs the given PrivilegedRunnableWithResult as a system user with the given username
protected <V> V	runWithResult(String username, SystemActionWithResult<V> action) Performs the given SystemAction as a system user with the given username
void	setContainer(ComponentContainer container) Called by the ServiceHandler to set a reference to the ComponentContainer to be used during service execution
void	setPrivilegeContext(PrivilegeContext privilegeContext) Called by the ServiceHandler to set the PrivilegeContext before this service is performed

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

AbstractService

public AbstractService()

Method Detail

setPrivilegeContext

public final void setPrivilegeContext(PrivilegeContext privilegeContext)

Called by the ServiceHandler to set the PrivilegeContext before this service is performed

Parameters:

privilegeContext - the privilegeContext to set

getPrivilegeContext

public final PrivilegeContext getPrivilegeContext()

Return the PrivilegeContext to perform further privilege authorization validation

Returns:

the privilegeContext

getCertificate

protected final Certificate getCertificate()

Returns the Certificate of the user who is performing this service

Returns:

the certificate

setContainer

public final void setContainer(ComponentContainer container)

Called by the ServiceHandler to set a reference to the ComponentContainer to be used during service execution

Parameters:

container - the container to set

getContainer

protected final ComponentContainer getContainer()

Returns the reference to the ComponentContainer

Returns:

the container

getPrivilegeHandler

public PrivilegeHandler getPrivilegeHandler()
                                     throws IllegalArgumentException

Returns the reference to the PrivilegeHandler

Returns:

the privilege handler

Throws:

IllegalArgumentException

getComponent

protected final <V> V getComponent(Class<V> clazz)

Returns the reference to the StrolchComponent with the given name, if it exists. If it does not exist, an IllegalArgumentException is thrown

Parameters:

clazz -

Returns:

the component with the given name

Throws:

IllegalArgumentException - if the component does not exist

getRuntimeConfiguration

protected final RuntimeConfiguration getRuntimeConfiguration()

Returns the Strolch RuntimeConfiguration

Returns:

the Strolch RuntimeConfiguration

getRealm

protected final StrolchRealm getRealm(String realm)
                               throws StrolchException

Returns the StrolchRealm with the given name. If the realm does not exist, then a StrolchException is thrown

Parameters:

realm - the name of the StrolchRealm to return

Returns:

the StrolchRealm with the given name

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

openTx

protected StrolchTransaction openTx(String realm)
                             throws StrolchException

Opens a StrolchTransaction for the given realm, the action for the TX is this implementation's class name. This transaction should be used in a try-with-resource clause so it is properly closed

Parameters:

realm - the name of the realm to return

Returns:

the open StrolchTransaction

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

openArgOrUserTx

protected StrolchTransaction openArgOrUserTx(ServiceArgument arg)
                                      throws StrolchException

Opens a StrolchTransaction by evaluating if the given argument has a realm defined, if not, then the realm from the user certificate is used. The action for the TX is this implementation's class name. This transaction should be used in a try-with-resource clause so it is properly closed

Parameters:

arg - the ServiceArgument

Returns:

the open StrolchTransaction

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

openArgOrUserTx

protected StrolchTransaction openArgOrUserTx(ServiceArgument arg,
                                             String action)
                                      throws StrolchException

Opens a StrolchTransaction by evaluating if the given argument has a realm defined, if not, then the realm from the user certificate is used. The action for the TX is this implementation's class name. This transaction should be used in a try-with-resource clause so it is properly closed

Parameters:

arg - the ServiceArgument

action - the action to use for the opened TX

Returns:

the open StrolchTransaction

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

openTx

protected StrolchTransaction openTx(String realm,
                                    String action)
                             throws StrolchException

Opens a StrolchTransaction for the given realm. This transaction should be used in a try-with-resource clause so it is properly closed

Parameters:

realm - the name of the realm

action - the action to use for the opened TX

Returns:

the open StrolchTransaction

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

openUserTx

protected StrolchTransaction openUserTx()
                                 throws StrolchException

Opens a StrolchTransaction where the realm retrieved using ComponentContainer.getRealm(Certificate), the action for the TX is this implementation's class name. This transaction should be used in a try-with-resource clause so it is properly closed

Returns:

the open StrolchTransaction

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

openUserTx

protected StrolchTransaction openUserTx(String action)
                                 throws StrolchException

Opens a StrolchTransaction where the realm retrieved using ComponentContainer.getRealm(Certificate). This transaction should be used in a try-with-resource clause so it is properly closed

Parameters:

action - the action to use for the opened TX

Returns:

the open StrolchTransaction

Throws:

StrolchException - if the StrolchRealm does not exist with the given name

runAs

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

Performs the given SystemAction as a system user with the given username

Parameters:

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

action - the action to perform

Throws:

PrivilegeException

runWithResult

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

Performs the given SystemAction as a system user with the given username

Parameters:

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

action - the action to perform

Returns:

the result

Throws:

PrivilegeException

runAs

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

Performs the given PrivilegedRunnable as a system user with the given username

Parameters:

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

runnable - the runnable to perform

Throws:

PrivilegeException

runWithResult

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

Performs the given PrivilegedRunnableWithResult as a system user with the given username

Parameters:

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

runnable - the runnable to perform

Returns:

the result

Throws:

PrivilegeException

runAsAgent

protected void runAsAgent(SystemAction action)
                   throws PrivilegeException

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

Parameters:

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

action - the action to perform

Throws:

PrivilegeException

runAsAgentWithResult

protected <V> V runAsAgentWithResult(SystemActionWithResult<V> action)
                              throws PrivilegeException

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

Parameters:

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

action - the action to perform

Returns:

the result

Throws:

PrivilegeException

runAsAgent

protected void runAsAgent(PrivilegedRunnable runnable)
                   throws PrivilegeException

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

Parameters:

action - the action to perform

Throws:

PrivilegeException

runAsAgentWithResult

protected <V> V runAsAgentWithResult(PrivilegedRunnableWithResult<V> runnable)
                              throws PrivilegeException

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

Parameters:

action - the action to perform

Returns:

the result

Throws:

PrivilegeException

doService

public final U doService(T argument)

This method is final as it enforces that the argument is valid, and catches all exceptions and enforces that a service result is returned. A concrete implementation will implement the business logic in internalDoService(ServiceArgument)

Specified by:

doService in interface Service<T extends ServiceArgument,U extends ServiceResult>

Parameters:

argument - the argument for the service

Returns:

the service result

isArgumentRequired

protected boolean isArgumentRequired()

Returns true if this Service requires an argument

Returns:

if true, then an argument must be set to execute the service. If the argument is missing, then the service execution fails immediately

getResultInstance

protected abstract U getResultInstance()

This method is called if the service execution fails and an instance of the expected ServiceResult is required to return to the caller

Returns:

an instance of the ServiceResult returned by this implementation

internalDoService

protected abstract U internalDoService(T arg)
                                throws Exception

Internal method to perform the Service. The implementor does not need to handle exceptions as this is done in the doService(ServiceArgument) which calls this method

Parameters:

arg - the ServiceArgument containing the arguments to perform the concrete service

Returns:

a ServiceResult which denotes the execution state of this Service

Throws:

Exception - if something went wrong. The caller will catch and handle the ServiceResult

getPrivilegeName

public String getPrivilegeName()

Specified by:

getPrivilegeName in interface Restrictable

See Also:

Restrictable.getPrivilegeName()

getPrivilegeValue

public Object getPrivilegeValue()

Specified by:

getPrivilegeValue in interface Restrictable

See Also:

Restrictable.getPrivilegeValue()