com.sap.cloud.sdk.cloudplatform.servlet

Class BaseRequestContextExecutor<ExecutorT extends BaseRequestContextExecutor<ExecutorT>>

java.lang.Object

com.sap.cloud.sdk.cloudplatform.servlet.BaseRequestContextExecutor<ExecutorT>

Type Parameters:

ExecutorT - The type of the implementation.

Direct Known Subclasses:

JwtBasedRequestContextExecutor, RequestContextExecutor

public abstract class BaseRequestContextExecutor<ExecutorT extends BaseRequestContextExecutor<ExecutorT>>
extends Object

Base class providing methods to execute an arbitrary command in a RequestContext.

The implementations can be called in a fluent way like:

 new Implementation().withListeners(...).execute(() -> System.out.println("Called inside a request context!"));
 

Constructor Summary

Constructors

Constructor and Description
BaseRequestContextExecutor()

Method Summary

Modifier and Type	Method and Description
<T> T	execute(Callable<T> callable) Executes the given Callable as if it was called inside a RequestContext.
void	execute(Executable executable) Executes the given Executable as if it was called inside a RequestContext.
protected abstract ExecutorT	getThis() Getter needed to allow for a type safe return in the builder methods.
ExecutorT	withListeners(RequestContextListener... listeners) Adds the specified listeners to the life-cycle of the RequestContext.
ExecutorT	withoutDefaultListeners() Removes all SDK provided listeners on the classpath from the executor call.
ExecutorT	withoutListener(Class<? extends RequestContextListener> listener) Removes the listener with the specified class from the life-cycle of the RequestContext.
ExecutorT	withoutListeners(Collection<Class<? extends RequestContextListener>> listeners) Removes the listeners with any of the specified classes from the life-cycle of the RequestContext.
ExecutorT	withRequestContext(RequestContext requestContext) The given custom RequestContext is used for the call made with the execute(Executable) and execute(Callable) methods.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRequestContextExecutor

public BaseRequestContextExecutor()

Method Detail

getThis

@Nonnull
protected abstract ExecutorT getThis()

Getter needed to allow for a type safe return in the builder methods. This method should be implemented as

 protected ImplementingType getThis()
 {
     return this;
 }
 

in the subclasses.

Returns:

The current instance of the implementation.

withRequestContext

@Nonnull
public ExecutorT withRequestContext(@Nonnull
                                             RequestContext requestContext)

The given custom RequestContext is used for the call made with the execute(Executable) and execute(Callable) methods. If this method is not invoked a default RequestContext is used instead.

Parameters:

requestContext - The request context to be used by this executor.

Returns:

This executor to provide a fluent interface.

withoutDefaultListeners

@Nonnull
public ExecutorT withoutDefaultListeners()

Removes all SDK provided listeners on the classpath from the executor call.

The various libraries of the SDK provide several different implementations of the RequestContextListener which are loaded automatically if their libraries are part of the classpath. To fine tune the used listeners this method allows to ignore those automatically loaded implementation.

Returns:

This executor to provide a fluent interface.

withListeners

@Nonnull
public ExecutorT withListeners(@Nonnull
                                        RequestContextListener... listeners)

Adds the specified listeners to the life-cycle of the RequestContext.

Parameters:

listeners - The listeners to use during creation and destruction of the RequestContext.

Returns:

This executor to provide a fluent interface.

withoutListener

@Nonnull
public ExecutorT withoutListener(@Nonnull
                                          Class<? extends RequestContextListener> listener)

Removes the listener with the specified class from the life-cycle of the RequestContext.

As RequestContextListener have a unique priority assigned only a single instance of a specific class can be present at any given time. This single listener gets removed, if

 instance.getClass().equals(listener)
 

for the given listener.

Parameters:

listener - The class of the listener to remove.

Returns:

This executor to provide a fluent interface.

withoutListeners

@Nonnull
public ExecutorT withoutListeners(@Nonnull
                                           Collection<Class<? extends RequestContextListener>> listeners)

Removes the listeners with any of the specified classes from the life-cycle of the RequestContext.

As RequestContextListener have a unique priority assigned only a single instance of a specific class can be present at any given time. This single listener gets removed, if

 instance.getClass().equals(listener)
 

for any of the given listeners.

Parameters:

listeners - The classes of the listeners to remove.

Returns:

This executor to provide a fluent interface.

execute

public <T> T execute(@Nonnull
                     Callable<T> callable)
              throws Exception

Executes the given Callable as if it was called inside a RequestContext.

Type Parameters:

T - The return type of the given Callable.

Parameters:

callable - The Callable to execute inside a RequestContext.

Returns:

The value computed by the specified Callable.

Throws:

Exception - If there is an issue while computing the value.

execute

public void execute(@Nonnull
                    Executable executable)
             throws Exception

Executes the given Executable as if it was called inside a RequestContext.

Parameters:

executable - The Executable to execute inside a RequestContext.

Throws:

Exception - If there is an issue while executing the Executable.