com.sap.cloud.sdk.frameworks.hystrix

Class HystrixUtil

java.lang.Object

com.sap.cloud.sdk.frameworks.hystrix.HystrixUtil

public final class HystrixUtil
extends Object

An utility class handling the creation of Setter object that can be used to initialize Hystrix Command objects.

Therefore this class also handles the creation of command keys based on user and tenant Ids.

Constructor Summary

Constructors

Constructor and Description
HystrixUtil()

Method Summary

Modifier and Type	Method and Description
static String	getCommandKey(Class<?> commandClass, String tenantId, String userName) Constructs a command key for the given tenant identifier and user name, independent of whether they are null or not.
static com.netflix.hystrix.HystrixCommandProperties.Setter	getDefaultErpCommandProperties() Getter for default command properties to be used by a Hystrix Command.
static com.netflix.hystrix.HystrixCommand.Setter	getDefaultErpCommandSetter(Class<?> type) Pre-initializes a Hystrix Setter to be used to instantiate a Command.
static com.netflix.hystrix.HystrixCommand.Setter	getDefaultErpCommandSetter(Class<?> commandClass, com.netflix.hystrix.HystrixCommandProperties.Setter commandProperties) Pre-initializes a Hystrix Setter to be used to instantiate a Command.
static String	getDelimiter() The delimiter to be used between each component of the key.
static String	getGlobalKey(Class<?> commandClass) Returns a global command key without any isolation.
static String	getTenantAndUserIsolatedKey(Class<?> commandClass) Returns a tenant- and user-isolated command key.
static String	getTenantIsolatedKey(Class<?> commandClass) Returns a tenant-isolated command key.

Methods inherited from class java.lang.Object

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

Constructor Detail

HystrixUtil

public HystrixUtil()

Method Detail

getDelimiter

public static String getDelimiter()

The delimiter to be used between each component of the key.

Returns:

The delimiter used in the key.

getCommandKey

public static String getCommandKey(Class<?> commandClass,
                                   @Nullable
                                   String tenantId,
                                   @Nullable
                                   String userName)

Constructs a command key for the given tenant identifier and user name, independent of whether they are null or not. This provides the highest flexibility for defining different levels of isolation.

Parameters:

commandClass - Class of the command.

tenantId - The identifier of the tenant. If null, there is not tenant isolation.

userName - The name of the user. If null, there is no user isolation.

Returns:

A new command key constructed from the given tenant identifier and user name.

getGlobalKey

public static String getGlobalKey(Class<?> commandClass)

Returns a global command key without any isolation.

Parameters:

commandClass - The class of the command for which the key should be created.

Returns:

A global command key without any isolation.

getTenantAndUserIsolatedKey

public static String getTenantAndUserIsolatedKey(Class<?> commandClass)
                                          throws UserNotAuthenticatedException

Returns a tenant- and user-isolated command key.

Parameters:

commandClass - The class of the command for which the key should be created.

Returns:

A tenant- and user-isolated command key.

Throws:

UserNotAuthenticatedException - If the current User is not authenticated.

getTenantIsolatedKey

public static String getTenantIsolatedKey(Class<?> commandClass)
                                   throws TenantNotAvailableException

Returns a tenant-isolated command key.

Parameters:

commandClass - The class of the command for which the key should be created.

Returns:

A tenant-isolated command key.

Throws:

TenantNotAvailableException - If there is currently no Tenant available. This typically occurs when trying to access the tenant within code that is running outside any tenant context, e.g., within a background task.

getDefaultErpCommandSetter

public static com.netflix.hystrix.HystrixCommand.Setter getDefaultErpCommandSetter(Class<?> type)

Pre-initializes a Hystrix Setter to be used to instantiate a Command.

Parameters:

type - The class of the command to prepare the setter for.

Returns:

A Setter ready to initialize a Command.

getDefaultErpCommandSetter

public static com.netflix.hystrix.HystrixCommand.Setter getDefaultErpCommandSetter(Class<?> commandClass,
                                                                                   com.netflix.hystrix.HystrixCommandProperties.Setter commandProperties)

Pre-initializes a Hystrix Setter to be used to instantiate a Command.

Parameters:

commandClass - The class of the command to prepare the setter for.

commandProperties - Default properties for the command to execute.

Returns:

A Setter ready to initialize a Command.

getDefaultErpCommandProperties

public static com.netflix.hystrix.HystrixCommandProperties.Setter getDefaultErpCommandProperties()

Getter for default command properties to be used by a Hystrix Command.

Returns:

A pre-initialized HystrixCommandProperties.Setter.