Package com.sap.cloud.sdk.cloudplatform

Class DwcHeaderUtils

java.lang.Object

com.sap.cloud.sdk.cloudplatform.DwcHeaderUtils

@Beta
public class DwcHeaderUtils
extends Object

Utility class to extract specific values from the SAP Deploy with Confidence request headers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DWC_JWT_HEADER	The name of the header that contains the Deploy with Confidence JWT token.
static final String	DWC_SUBDOMAIN_HEADER	The name of the header that contains the Deploy with Confidence scopes information.
static final String	DWC_TENANT_HEADER	The name of the header that contains the Deploy with Confidence tenant information.
static final String	DWC_USER_HEADER	The name of the header that contains the Deploy with Confidence user (princial) information.

Constructor Summary

Constructors

Constructor	Description
DwcHeaderUtils()

Method Summary

Modifier and Type	Method	Description
static String	getDwcJwtOrThrow()	This method fetches the value of the DWC_JWT_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.
static String	getDwcPrincipalIdOrThrow()	This method fetches the value of the DWC_USER_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.
static String	getDwCSubdomainOrNull()	This method fetches the value of the DWC_SUBDOMAIN_HEADER header.
static String	getDwCSubdomainOrThrow()	This method fetches the value of the DWC_SUBDOMAIN_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.
static String	getDwcTenantIdOrThrow()	This method fetches the value of the DWC_TENANT_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.

Methods inherited from class java.lang.Object

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

Field Details

DWC_USER_HEADER

public static final String DWC_USER_HEADER

The name of the header that contains the Deploy with Confidence user (princial) information.

See Also:

• Constant Field Values

DWC_TENANT_HEADER

public static final String DWC_TENANT_HEADER

The name of the header that contains the Deploy with Confidence tenant information.

See Also:

• Constant Field Values

DWC_SUBDOMAIN_HEADER

public static final String DWC_SUBDOMAIN_HEADER

The name of the header that contains the Deploy with Confidence scopes information.

See Also:

• Constant Field Values

DWC_JWT_HEADER

public static final String DWC_JWT_HEADER

The name of the header that contains the Deploy with Confidence JWT token.

See Also:

• Constant Field Values

Constructor Details

DwcHeaderUtils

public DwcHeaderUtils()

Method Details

getDwcTenantIdOrThrow

@Nonnull
public static String getDwcTenantIdOrThrow()

This method fetches the value of the DWC_TENANT_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.

Returns:

The value of the DWC_TENANT_HEADER header.

Throws:

DwcHeaderNotFoundException - if the header was not found.

getDwCSubdomainOrThrow

@Nonnull
public static String getDwCSubdomainOrThrow()

This method fetches the value of the DWC_SUBDOMAIN_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.

Returns:

The value of the DWC_SUBDOMAIN_HEADER header.

Throws:

DwcHeaderNotFoundException - if the header was not found.

getDwCSubdomainOrNull

@Nullable
public static String getDwCSubdomainOrNull()

This method fetches the value of the DWC_SUBDOMAIN_HEADER header. If the header is not present, null will be returned instead.

Returns:

Either the value of the DWC_SUBDOMAIN_HEADER header, or null if the header is not present.

Since:

5.6.0

getDwcPrincipalIdOrThrow

@Nonnull
public static String getDwcPrincipalIdOrThrow()

This method fetches the value of the DWC_USER_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.

Returns:

The value of the DWC_USER_HEADER header.

Throws:

DwcHeaderNotFoundException - if the header was not found.

getDwcJwtOrThrow

@Nonnull
public static String getDwcJwtOrThrow()

This method fetches the value of the DWC_JWT_HEADER header or throws an DwcHeaderNotFoundException if the header was not found.

Returns:

The value of the DWC_JWT_HEADER header.

Throws:

DwcHeaderNotFoundException - if the header was not found.

Since:

5.6.0