org.eclipse.scout.rt.server

Class ServiceOperationInvoker

java.lang.Object

org.eclipse.scout.rt.server.ServiceOperationInvoker

@ApplicationScoped
public class ServiceOperationInvoker
extends Object

Provides functionality to invoke service operations as described by ServiceTunnelRequest and to return the operations result in the form of a ServiceTunnelResponse.

Constructor Summary

Constructors

Constructor and Description
ServiceOperationInvoker()

Method Summary

Modifier and Type	Method and Description
protected void	checkRemoteServiceAccessByAnnotations(Class<?> interfaceClass, Class<?> implClass, Method interfaceMethod, Object[] args) Check pass 2 on instance
protected void	checkRemoteServiceAccessByInterface(Class<?> interfaceClass, Method interfaceMethod, Object[] args) Check pass 1 on type
protected void	checkRemoteServiceAccessByPermission(Class<?> interfaceClass, Class<?> implClass, Method interfaceMethod, Object[] args) Check pass 3 RemoteServiceAccessPermission if a client (gui) is allowed to call this service from remote using a remote service proxy.
protected void	checkServiceAvailable(Class<?> serviceInterfaceClass, Object service) Check, if an instance is available
protected Object	getValidatedServiceAccess(Class<?> serviceInterfaceClass, Method serviceOp, Object[] args) Check, if the service can be accessed
protected void	handleException(Throwable t) Method invoked to handle a service exception.
protected Throwable	interceptException(Throwable t) Method invoked to intercept a service exception before being put into the ServiceTunnelResponse to be sent to the client.
ServiceTunnelResponse	invoke(org.eclipse.scout.rt.platform.context.RunContext runContext, ServiceTunnelRequest serviceReq) Invoke the service associated with the ServiceTunnelRequest.
protected ServiceTunnelResponse	invokeInternal(ServiceTunnelRequest serviceReq)
protected boolean	mustAuthorize(Class<?> interfaceClass, Class<?> implClass, Method interfaceMethod, Object[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceOperationInvoker

public ServiceOperationInvoker()

Method Detail

invoke

public ServiceTunnelResponse invoke(org.eclipse.scout.rt.platform.context.RunContext runContext,
                                    ServiceTunnelRequest serviceReq)

Invoke the service associated with the ServiceTunnelRequest.
Must be called within a transaction.

invokeInternal

protected ServiceTunnelResponse invokeInternal(ServiceTunnelRequest serviceReq)
                                        throws ClassNotFoundException

Throws:

ClassNotFoundException

getValidatedServiceAccess

protected Object getValidatedServiceAccess(Class<?> serviceInterfaceClass,
                                           Method serviceOp,
                                           Object[] args)

Check, if the service can be accessed

checkServiceAvailable

protected void checkServiceAvailable(Class<?> serviceInterfaceClass,
                                     Object service)

Check, if an instance is available

checkRemoteServiceAccessByInterface

protected void checkRemoteServiceAccessByInterface(Class<?> interfaceClass,
                                                   Method interfaceMethod,
                                                   Object[] args)

Check pass 1 on type

checkRemoteServiceAccessByAnnotations

protected void checkRemoteServiceAccessByAnnotations(Class<?> interfaceClass,
                                                     Class<?> implClass,
                                                     Method interfaceMethod,
                                                     Object[] args)

Check pass 2 on instance

Using blacklist RemoteServiceAccessDenied

checkRemoteServiceAccessByPermission

protected void checkRemoteServiceAccessByPermission(Class<?> interfaceClass,
                                                    Class<?> implClass,
                                                    Method interfaceMethod,
                                                    Object[] args)

Check pass 3 RemoteServiceAccessPermission if a client (gui) is allowed to call this service from remote using a remote service proxy.

Deny access by default.

Accepts when a RemoteServiceAccessPermission was implied or authorization was waved using whitelist RemoteServiceWithoutAuthorization in mustAuthorize(Class, Class, Method, Object[])

mustAuthorize

protected boolean mustAuthorize(Class<?> interfaceClass,
                                Class<?> implClass,
                                Method interfaceMethod,
                                Object[] args)

Returns:

true unless there is a RemoteServiceWithoutAuthorization on the called method or interface in the class tree

Since:

6.1

handleException

protected void handleException(Throwable t)

Method invoked to handle a service exception. This method must not throw an exception.

The default implementation handles an exception via ExceptionHandler, but only if the current context is not cancelled.

interceptException

protected Throwable interceptException(Throwable t)

Method invoked to intercept a service exception before being put into the ServiceTunnelResponse to be sent to the client. This method must not throw an exception.

Security: do not send back original error and stack trace with implementation details.

The default implementation returns an empty exception, or in case of a VetoException only its title, message, htmlMessage, error code and severity.