net.sf.mmm.service.base.server

Class GenericRemoteInvocationCallHandler<CALL extends RemoteInvocationCall>

java.lang.Object

net.sf.mmm.service.base.server.GenericRemoteInvocationCallHandler<CALL>

Type Parameters:

CALL - is the generic type of the RemoteInvocationCall.

All Implemented Interfaces:

AttributeReadId<String>

Direct Known Subclasses:

GenericRemoteInvocationCommandCallHandler, GenericRemoteInvocationRpcCallHandler

public abstract class GenericRemoteInvocationCallHandler<CALL extends RemoteInvocationCall>
extends Object
implements AttributeReadId<String>

This is the abstract base class for a generic handler to invoke RemoteInvocationCalls from the client on the server-side.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractGenericRemoteInvocationService<?,?,?,?>	genericService
private String	id
private Boolean	login
private Boolean	secured

Constructor Summary

Constructors

Constructor and Description
GenericRemoteInvocationCallHandler(String id, AbstractGenericRemoteInvocationService<?,?,?,?> genericService) The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract Set<? extends javax.validation.ConstraintViolation<?>>	doValidate(CALL call) Called from validate(RemoteInvocationCall) to delegate to JSR303 (javax.validation).
AbstractGenericRemoteInvocationService<?,?,?,?>	getGenericService()
String	getId() This method gets the ID used to identify this object.
protected abstract Method	getServiceMethod()
protected void	handleConstraintViolations(Set<javax.validation.ConstraintViolation<?>> violations) Handles the result of a validation.
abstract Object	invoke(CALL call) Invokes the given RemoteInvocationCall.
boolean	isLogin()
boolean	isSecured()
String	toString()
void	validate(CALL call) Performs a (pre-)validation of the given RemoteInvocationCall.

Methods inherited from class java.lang.Object

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

Field Detail

id

private final String id

See Also:

getId()

secured

private Boolean secured

See Also:

isSecured()

login

private Boolean login

See Also:

isLogin()

genericService

private final AbstractGenericRemoteInvocationService<?,?,?,?> genericService

See Also:

getGenericService()

Constructor Detail

GenericRemoteInvocationCallHandler

public GenericRemoteInvocationCallHandler(String id,
                                          AbstractGenericRemoteInvocationService<?,?,?,?> genericService)

The constructor.

Parameters:

id - - see getId().

genericService - - see getGenericService().

Method Detail

getGenericService

public AbstractGenericRemoteInvocationService<?,?,?,?> getGenericService()

Returns:

the generic remote invocation service.

getId

public String getId()

This method gets the ID used to identify this object. An ID should be unique.

Specified by:

getId in interface AttributeReadId<String>

Returns:

the object's ID.

isLogin

public boolean isLogin()

Returns:

true if login operation, false otherwise.

See Also:

RemoteInvocationSecurityDetector.isLogin(java.lang.reflect.AnnotatedElement)

getServiceMethod

protected abstract Method getServiceMethod()

Returns:

the Method of the remote invocation.

isSecured

public boolean isSecured()

Returns:

true if secured operation, false otherwise.

See Also:

RemoteInvocationSecurityDetector.isSecured(java.lang.reflect.AnnotatedElement)

invoke

public abstract Object invoke(CALL call)
                       throws Exception

Invokes the given RemoteInvocationCall.

Parameters:

call - is the RemoteInvocationCall to execute.

Returns:

the result of the invocation.

Throws:

Exception - if anything goes wrong.

validate

public void validate(CALL call)
              throws Exception

Performs a (pre-)validation of the given RemoteInvocationCall. Will typically be called outside a transaction. Complex business and state validation that requires a transaction has to be performed inside the actual invocation.

Parameters:

call - is the RemoteInvocationCall to validate.

Throws:

Exception - if the given call is invalid.

doValidate

protected abstract Set<? extends javax.validation.ConstraintViolation<?>> doValidate(CALL call)

Called from validate(RemoteInvocationCall) to delegate to JSR303 (javax.validation).

Parameters:

call - is the RemoteInvocationCall to validate.

Returns:

the Set of ConstraintViolations. Will be empty if valid.

handleConstraintViolations

protected void handleConstraintViolations(Set<javax.validation.ConstraintViolation<?>> violations)

Handles the result of a validation.

Parameters:

violations - is the Set of ConstraintViolations.

toString

public String toString()

Overrides:

toString in class Object