com.sap.cloud.sdk.cloudplatform.security

Class JwtBasedRequestContextExecutor

java.lang.Object

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

com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor

public class JwtBasedRequestContextExecutor
extends BaseRequestContextExecutor<JwtBasedRequestContextExecutor>

JWT-based RequestContext executor which runs a given Callable or Executable as if it would have been invoked via a HttpServletRequest with the given JWT bearer as part of the "Authorization" header.

Constructor Summary

Constructors

Constructor and Description
JwtBasedRequestContextExecutor()

Method Summary

Modifier and Type	Method and Description
protected JwtBasedRequestContextExecutor	getThis() Getter needed to allow for a type safe return in the builder methods.
JwtBasedRequestContextExecutor	onBehalfOfTenant(String tenantId) A non-validated JWT is constructed based on tenant information.
JwtBasedRequestContextExecutor	onBehalfOfTenant(String tenantId, String issuerUrl, Collection<String> audiences) A non-validated JWT is constructed based on tenant information.
JwtBasedRequestContextExecutor	onBehalfOfTenant(String tenantId, String issuerUrl, String... audiences) Deprecated. Use onBehalfOfTenant(String) or onBehalfOfTenant(String, String, Collection) instead.
JwtBasedRequestContextExecutor	withJwt(String encodedJwt) The given JWT is used to initialize the RequestContext as if it was called from HttpServletRequest.
JwtBasedRequestContextExecutor	withJwt(String encodedJwt, String refreshToken) The given JWT is used to initialize the RequestContext as if it was called from HttpServletRequest.
JwtBasedRequestContextExecutor	withXsuaaServiceJwt() Retrieves a JWT from the bound XSUAA service and initialize this RequestContextExecutor with it.

Methods inherited from class com.sap.cloud.sdk.cloudplatform.servlet.BaseRequestContextExecutor

execute, execute, withListeners, withoutDefaultListeners, withoutListener, withoutListeners, withParentRequestContext, withRequestContext

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtBasedRequestContextExecutor

public JwtBasedRequestContextExecutor()

Method Detail

onBehalfOfTenant

@Deprecated
 @Nonnull
public JwtBasedRequestContextExecutor onBehalfOfTenant(@Nonnull
                                                                             String tenantId,
                                                                             @Nullable
                                                                             String issuerUrl,
                                                                             @Nonnull
                                                                             String... audiences)

Deprecated. Use onBehalfOfTenant(String) or onBehalfOfTenant(String, String, Collection) instead.

A non-validated JWT is constructed based on tenant information. This artificial JWT is used to initialize the RequestContext as if it was called from HttpServletRequest. Operations in this context are executed on behalf of the subscriber tenant provided. The generated JWT contains default values for issuer URL and audience.

Parameters:

tenantId - The tenant identifier to be used and acted on behalf of.

issuerUrl - The optional issuer URL. If no value is provided, a dummy issuer URL will be constructed by taking the tenantId as subdomain, which will in most cases not allow to use features that rely on the issuer URL, such as accessing multi-tenant services.

audiences - A customizable array of JWT audience entries. If the array is empty, the application name will be used.

Returns:

This executor to provide a fluent interface.

onBehalfOfTenant

@Nonnull
public JwtBasedRequestContextExecutor onBehalfOfTenant(@Nonnull
                                                                String tenantId)

A non-validated JWT is constructed based on tenant information. This artificial JWT is used to initialize the RequestContext as if it was called from HttpServletRequest. Operations in this context are executed on behalf of the subscriber tenant provided. The generated JWT contains default values for issuer URL and audience, which will in most cases not allow to use features that rely on the issuer URL, such as accessing multi-tenant services.

Parameters:

tenantId - The tenant identifier to be used and acted on behalf of.

Returns:

This executor to provide a fluent interface.

onBehalfOfTenant

@Nonnull
public JwtBasedRequestContextExecutor onBehalfOfTenant(@Nonnull
                                                                String tenantId,
                                                                @Nonnull
                                                                String issuerUrl,
                                                                @Nonnull
                                                                Collection<String> audiences)

A non-validated JWT is constructed based on tenant information. This artificial JWT is used to initialize the RequestContext as if it was called from HttpServletRequest. Operations in this context are executed on behalf of the subscriber tenant provided.

Parameters:

tenantId - The tenant identifier to be used and acted on behalf of.

issuerUrl - The issuer URL of the subscriber XSUAA endpoint.

audiences - A customizable array of JWT audience entries. Adding the application name is recommended.

Returns:

This executor to provide a fluent interface.

withJwt

@Nonnull
public JwtBasedRequestContextExecutor withJwt(@Nonnull
                                                       String encodedJwt)

The given JWT is used to initialize the RequestContext as if it was called from HttpServletRequest.

Parameters:

encodedJwt - The encoded JWT to be used.

Returns:

This executor to provide a fluent interface.

withJwt

@Nonnull
public JwtBasedRequestContextExecutor withJwt(@Nonnull
                                                       String encodedJwt,
                                                       @Nonnull
                                                       String refreshToken)

The given JWT is used to initialize the RequestContext as if it was called from HttpServletRequest. Also takes a refresh token to refresh the given JWT if expired.

Parameters:

encodedJwt - The encoded JWT to be used.

refreshToken - The refresh token to be used to refresh the JWT if necessary.

Returns:

This executor to provide a fluent interface.

withXsuaaServiceJwt

@Nonnull
public JwtBasedRequestContextExecutor withXsuaaServiceJwt()

Retrieves a JWT from the bound XSUAA service and initialize this RequestContextExecutor with it.

Probable use cases for this are tasks that should run without any request, so e.g. start-up tasks and handling of received messages.

Returns:

This executor to provide a fluent interface.

getThis

@Nonnull
protected JwtBasedRequestContextExecutor getThis()

Description copied from class: BaseRequestContextExecutor

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.

Specified by:

getThis in class BaseRequestContextExecutor<JwtBasedRequestContextExecutor>

Returns:

The current instance of the implementation.