net.sf.mmm.service.base.server

Class AbstractGenericRemoteInvocationService<CALL extends RemoteInvocationCall,REQUEST extends GenericRemoteInvocationRequest<CALL,? extends GenericRemoteInvocationTransactionalCalls<CALL>>,RESPONSE extends GenericRemoteInvocationResponse,HANDLER extends GenericRemoteInvocationCallHandler<CALL>>

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.service.base.server.AbstractGenericRemoteInvocationService<CALL,REQUEST,RESPONSE,HANDLER>

Type Parameters:

CALL - is the generic type of the RemoteInvocationCall.

REQUEST - is the generic type of the GenericRemoteInvocationRequest.

RESPONSE - is the generic type of the GenericRemoteInvocationResponse.

HANDLER - is the generic type of the GenericRemoteInvocationCallHandler.

Direct Known Subclasses:

AbstractGenericRemoteInvocationCommandService, AbstractGenericRemoteInvocationRpcService

public abstract class AbstractGenericRemoteInvocationService<CALL extends RemoteInvocationCall,REQUEST extends GenericRemoteInvocationRequest<CALL,? extends GenericRemoteInvocationTransactionalCalls<CALL>>,RESPONSE extends GenericRemoteInvocationResponse,HANDLER extends GenericRemoteInvocationCallHandler<CALL>>
extends AbstractLoggableComponent

This is the abstract base class for the common implementation of GenericRemoteInvocationRpcService and GenericRemoteInvocationCommandService.
As extension you could e.g. add custom security checks or override the error handling.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractGenericRemoteInvocationService.RequestContext A context object for stateful information related to the current GenericRemoteInvocationRequest.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,HANDLER>	callHandlerMap
private ExceptionUtil	exceptionUtil
private int	maximumCallsPerRequest
private int	maximumCallsPerTransaction
private int	maximumTransactionsPerRequest
private RemoteInvocationSecurityDetector	securityDetector
private javax.validation.Validator	validator
private CsrfTokenManager	xsrfTokenManager

Constructor Summary

Constructors

Constructor and Description
AbstractGenericRemoteInvocationService() The constructor.

Method Summary

Modifier and Type	Method and Description
private void	checkDosLimit(int actualCount, int maximumAllowedCount) Verifies that the given actualCount is less or equal to the given maximumAllowedCount.
protected abstract RESPONSE	createResponse(int requestId, CsrfToken xsrfToken, GenericRemoteInvocationTransactionalResults[] transactionalResults) Creates a new instance of <RESPONSE>.
protected void	doInitialize() This method performs the actual initialization.
protected void	doSecurityCheck(AbstractGenericRemoteInvocationService.RequestContext context) This method performs a security check for the given request.
ExceptionUtil	getExceptionUtil()
protected HANDLER	getHandler(CALL call)
protected int	getHandlerCount()
protected abstract String	getHandlerId(CALL call)
int	getMaximumCallsPerRequest()
int	getMaximumCallsPerTransaction()
int	getMaximumTransactionsPerRequest()
RemoteInvocationSecurityDetector	getSecurityDetector()
javax.validation.Validator	getValidator()
CsrfTokenManager	getXsrfTokenManager()
protected RemoteInvocationCallFailedException	handleCallFailure(CALL call, Throwable error) This method contains the failure handling if a Throwable occurred while processing a RemoteInvocationCall.
protected void	handleLoginOperation(AbstractGenericRemoteInvocationService.RequestContext context) Post-processing for the login operation.
protected GenericRemoteInvocationTransactionalResults	handleTxCallsFailure(GenericRemoteInvocationTransactionalCalls<CALL> txCall, Throwable error) This method contains the failure handling if a Throwable occurred while processing GenericRemoteInvocationTransactionalCalls.
protected void	logFailure(Object source, Throwable error) Logs a given error that occurred while processing the given source.
protected Serializable	processCall(CALL call, AbstractGenericRemoteInvocationService.RequestContext context) Processes the given RemoteInvocationCall.
protected abstract GenericRemoteInvocationTransactionalResults	processCallsInTransaction(GenericRemoteInvocationTransactionalCalls<CALL> transactionalCalls, AbstractGenericRemoteInvocationService.RequestContext context) This method calls processTransactionalCalls(GenericRemoteInvocationTransactionalCalls, RequestContext) in a new transaction.
protected RESPONSE	processRequest(REQUEST request) Processes the given GenericRemoteInvocationRequest and creates the corresponding GenericRemoteInvocationResponse.
protected GenericRemoteInvocationTransactionalResults	processTransactionalCalls(GenericRemoteInvocationTransactionalCalls<CALL> transactionalCalls, AbstractGenericRemoteInvocationService.RequestContext context) This method processes the given GenericRemoteInvocationTransactionalCalls.
protected void	registerHandler(HANDLER handler) Registers the given handler.
void	setExceptionUtil(ExceptionUtil exceptionUtil)
void	setMaximumCallsPerRequest(int maximumCallsPerRequest)
void	setMaximumCallsPerTransaction(int maximumCallsPerTransaction)
void	setMaximumTransactionsPerRequest(int maximumTransactionsPerRequest)
void	setSecurityDetector(RemoteInvocationSecurityDetector securityDetector)
void	setValidator(javax.validation.Validator validator)
void	setXsrfTokenManager(CsrfTokenManager xsrfTokenManager)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

callHandlerMap

private final Map<String,HANDLER extends GenericRemoteInvocationCallHandler<CALL>> callHandlerMap

See Also:

processCall(RemoteInvocationCall, RequestContext)

xsrfTokenManager

private CsrfTokenManager xsrfTokenManager

See Also:

getXsrfTokenManager()

securityDetector

private RemoteInvocationSecurityDetector securityDetector

See Also:

getSecurityDetector()

exceptionUtil

private ExceptionUtil exceptionUtil

See Also:

getExceptionUtil()

maximumTransactionsPerRequest

private int maximumTransactionsPerRequest

See Also:

getMaximumTransactionsPerRequest()

maximumCallsPerTransaction

private int maximumCallsPerTransaction

See Also:

getMaximumCallsPerTransaction()

maximumCallsPerRequest

private int maximumCallsPerRequest

See Also:

getMaximumCallsPerRequest()

validator

private javax.validation.Validator validator

See Also:

getValidator()

Constructor Detail

AbstractGenericRemoteInvocationService

public AbstractGenericRemoteInvocationService()

The constructor.

Method Detail

getSecurityDetector

public RemoteInvocationSecurityDetector getSecurityDetector()

Returns:

the RemoteInvocationSecurityDetector to use.

setSecurityDetector

@Inject
public void setSecurityDetector(RemoteInvocationSecurityDetector securityDetector)

Parameters:

securityDetector - is the RemoteInvocationSecurityDetector to Inject.

getXsrfTokenManager

public CsrfTokenManager getXsrfTokenManager()

Returns:

the xsrfTokenManager

setXsrfTokenManager

@Inject
public void setXsrfTokenManager(CsrfTokenManager xsrfTokenManager)

Parameters:

xsrfTokenManager - is the CsrfTokenManager to Inject.

getExceptionUtil

public ExceptionUtil getExceptionUtil()

Returns:

the ExceptionUtil to use.

setExceptionUtil

@Inject
public void setExceptionUtil(ExceptionUtil exceptionUtil)

Parameters:

exceptionUtil - is the ExceptionUtil to Inject.

getValidator

public javax.validation.Validator getValidator()

Returns:

the Validator instance to use.

setValidator

@Inject
public void setValidator(javax.validation.Validator validator)

Parameters:

validator - is the Validator to Inject.

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

getMaximumTransactionsPerRequest

public int getMaximumTransactionsPerRequest()

Returns:

the maximum number of transactions allowed per request to prevent Denial of Service (DoS) attacks.

setMaximumTransactionsPerRequest

public void setMaximumTransactionsPerRequest(int maximumTransactionsPerRequest)

Parameters:

maximumTransactionsPerRequest - is new value of getMaximumTransactionsPerRequest().

getMaximumCallsPerTransaction

public int getMaximumCallsPerTransaction()

Returns:

the maximum number of RemoteInvocationCalls allowed per transactions to prevent Denial of Service (DoS) attacks.

setMaximumCallsPerTransaction

public void setMaximumCallsPerTransaction(int maximumCallsPerTransaction)

Parameters:

maximumCallsPerTransaction - is new value of getMaximumCallsPerTransaction().

getMaximumCallsPerRequest

public int getMaximumCallsPerRequest()

Returns:

the maximum number of RemoteInvocationCalls allowed per request to prevent Denial of Service (DoS) attacks.

setMaximumCallsPerRequest

public void setMaximumCallsPerRequest(int maximumCallsPerRequest)

Parameters:

maximumCallsPerRequest - is new value of getMaximumCallsPerRequest().

doSecurityCheck

protected void doSecurityCheck(AbstractGenericRemoteInvocationService.RequestContext context)

This method performs a security check for the given request.

Parameters:

context - is the AbstractGenericRemoteInvocationService.RequestContext to check.

checkDosLimit

private void checkDosLimit(int actualCount,
                           int maximumAllowedCount)

Verifies that the given actualCount is less or equal to the given maximumAllowedCount. Otherwise an exception is thrown.

Parameters:

actualCount - the actual count.

maximumAllowedCount - the maximum allowed count.

processRequest

protected RESPONSE processRequest(REQUEST request)

Processes the given GenericRemoteInvocationRequest and creates the corresponding GenericRemoteInvocationResponse.

Parameters:

request - is the GenericRemoteInvocationRequest to process.

Returns:

the GenericRemoteInvocationResponse to send back to the client.

createResponse

protected abstract RESPONSE createResponse(int requestId,
                                           CsrfToken xsrfToken,
                                           GenericRemoteInvocationTransactionalResults[] transactionalResults)

Creates a new instance of <RESPONSE>.

Parameters:

requestId - is the requestId.

xsrfToken - is the xsrfToken.

transactionalResults - are the transactional results.

Returns:

the new GenericRemoteInvocationRequest.

processCallsInTransaction

protected abstract GenericRemoteInvocationTransactionalResults processCallsInTransaction(GenericRemoteInvocationTransactionalCalls<CALL> transactionalCalls,
                                                                                         AbstractGenericRemoteInvocationService.RequestContext context)
                                                                                  throws Exception

This method calls processTransactionalCalls(GenericRemoteInvocationTransactionalCalls, RequestContext) in a new transaction.
ATTENTION:
If you want to implement this using spring-aop and @Transactional you need to be aware that you have to keep the annotated method out of this class as spring-aop uses dynamic proxies by default that only support transactions when a method is called from outside the class and not for method calls within a class. This is a typical pitfall and one of the reasons why we are using mmm-transaction by default.

Parameters:

transactionalCalls - is the GenericRemoteInvocationTransactionalCalls.

context - is the AbstractGenericRemoteInvocationService.RequestContext to pass.

Returns:

the GenericRemoteInvocationTransactionalResults.

Throws:

Exception - if anything goes wrong.

processTransactionalCalls

protected GenericRemoteInvocationTransactionalResults processTransactionalCalls(GenericRemoteInvocationTransactionalCalls<CALL> transactionalCalls,
                                                                                AbstractGenericRemoteInvocationService.RequestContext context)

This method processes the given GenericRemoteInvocationTransactionalCalls.

Parameters:

transactionalCalls - is the GenericRemoteInvocationTransactionalCalls.

context - is the AbstractGenericRemoteInvocationService.RequestContext to pass.

Returns:

the GenericRemoteInvocationTransactionalResults.

processCall

protected Serializable processCall(CALL call,
                                   AbstractGenericRemoteInvocationService.RequestContext context)
                            throws Throwable

Processes the given RemoteInvocationCall. This method does not need to handle any Exceptions as this is already done by the caller of this method.

Parameters:

call - is the RemoteInvocationCall to invoke.

context - is the AbstractGenericRemoteInvocationService.RequestContext.

Returns:

the actual result of the call. May be null.

Throws:

Throwable - in case of any kind of error.

handleLoginOperation

protected void handleLoginOperation(AbstractGenericRemoteInvocationService.RequestContext context)

Post-processing for the login operation. Will generate the initial CsrfToken.

Parameters:

context - is the AbstractGenericRemoteInvocationService.RequestContext.

getHandler

protected HANDLER getHandler(CALL call)
                      throws ObjectNotFoundException

Parameters:

call - is the RemoteInvocationCall.

Returns:

the corresponding GenericRemoteInvocationCallHandler.

Throws:

ObjectNotFoundException - if no handler exists for the given call.

registerHandler

protected void registerHandler(HANDLER handler)

Registers the given handler.

Parameters:

handler - is the GenericRemoteInvocationCallHandler to register.

getHandlerCount

protected int getHandlerCount()

Returns:

the number of registered GenericRemoteInvocationCallHandlers.

getHandlerId

protected abstract String getHandlerId(CALL call)

Parameters:

call - is the RemoteInvocationCall.

Returns:

the corresponding ID.

handleCallFailure

protected RemoteInvocationCallFailedException handleCallFailure(CALL call,
                                                                Throwable error)

This method contains the failure handling if a Throwable occurred while processing a RemoteInvocationCall.

Parameters:

call - is the RemoteInvocationCall.

error - is the Throwable that occurred.

Returns:

the RemoteInvocationCallFailedException to throw.

handleTxCallsFailure

protected GenericRemoteInvocationTransactionalResults handleTxCallsFailure(GenericRemoteInvocationTransactionalCalls<CALL> txCall,
                                                                           Throwable error)

This method contains the failure handling if a Throwable occurred while processing GenericRemoteInvocationTransactionalCalls.

Parameters:

txCall - is the GenericRemoteInvocationTransactionalCalls.

error - is the Throwable that occurred.

Returns:

the RemoteInvocationCallFailedException to throw.

logFailure

protected void logFailure(Object source,
                          Throwable error)

Logs a given error that occurred while processing the given source.

Parameters:

source - is the source object. We do not use Object.toString() here as this is for debug output and might contain confidential information such as passwords or whatever that we do not want to log.

error - is the Throwable to log.