Package org.apache.hadoop.yarn.server.federation.store.utils

Class FederationStateStoreUtils

java.lang.Object

org.apache.hadoop.yarn.server.federation.store.utils.FederationStateStoreUtils

public final class FederationStateStoreUtils
extends java.lang.Object

Common utility methods used by the store implementations.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FEDERATION_STORE_URL
static org.slf4j.Logger	LOG

Method Summary

Modifier and Type	Method	Description
static org.apache.hadoop.security.token.delegation.DelegationKey	convertMasterKeyToDelegationKey(RouterMasterKeyRequest request)	Convert MasterKey to DelegationKey.
static void	decodeWritable(org.apache.hadoop.io.Writable w, java.lang.String idStr)	Decode Base64 string to Writable object.
static java.lang.String	encodeWritable(org.apache.hadoop.io.Writable key)	Encode for Writable objects.
static boolean	filterHomeSubCluster(SubClusterId filterSubCluster, SubClusterId homeSubCluster)	Filter HomeSubCluster based on Filter SubCluster.
static void	logAndThrowException(org.slf4j.Logger log, java.lang.String errMsg, java.lang.Throwable t)	Throws an exception due to an error in FederationStateStore.
static void	logAndThrowInvalidInputException(org.slf4j.Logger log, java.lang.String errMsg)	Throws an FederationStateStoreInvalidInputException due to an error in FederationStateStore.
static void	logAndThrowRetriableException(java.lang.Throwable t, org.slf4j.Logger log, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an FederationStateStoreRetriableException due to an error in FederationStateStore.
static void	logAndThrowRetriableException(org.slf4j.Logger log, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an FederationStateStoreRetriableException due to an error in FederationStateStore.
static void	logAndThrowRetriableException(org.slf4j.Logger log, java.lang.String errMsg, java.lang.Throwable t)	Throws an FederationStateStoreRetriableException due to an error in FederationStateStore.
static void	logAndThrowStoreException(java.lang.Throwable t, org.slf4j.Logger log, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an FederationStateStoreException due to an error in FederationStateStore.
static void	logAndThrowStoreException(org.slf4j.Logger log, java.lang.String errMsg)	Throws an FederationStateStoreException due to an error in FederationStateStore.
static void	logAndThrowStoreException(org.slf4j.Logger log, java.lang.String errMsgFormat, java.lang.Object... args)	Throws an FederationStateStoreException due to an error in FederationStateStore.
static void	returnToPool(org.slf4j.Logger log, java.sql.CallableStatement cstmt)	Returns the SQL FederationStateStore connections to the pool.
static void	returnToPool(org.slf4j.Logger log, java.sql.CallableStatement cstmt, java.sql.Connection conn)	Returns the SQL FederationStateStore connections to the pool.
static void	returnToPool(org.slf4j.Logger log, java.sql.CallableStatement cstmt, java.sql.Connection conn, java.sql.ResultSet rs)	Returns the SQL FederationStateStore connections to the pool.
static void	setPassword(com.zaxxer.hikari.HikariDataSource dataSource, java.lang.String password)	Sets a specific password for HikariDataSource SQL connections.
static void	setProperty(com.zaxxer.hikari.HikariDataSource dataSource, java.lang.String property, java.lang.String value)	Sets a specific value for a specific property of HikariDataSource SQL connections.
static void	setUsername(com.zaxxer.hikari.HikariDataSource dataSource, java.lang.String userNameDB)	Sets a specific username for HikariDataSource SQL connections.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

FEDERATION_STORE_URL

public static final java.lang.String FEDERATION_STORE_URL

See Also:

Constant Field Values

Method Detail

returnToPool

public static void returnToPool(org.slf4j.Logger log,
                                java.sql.CallableStatement cstmt,
                                java.sql.Connection conn,
                                java.sql.ResultSet rs)
                         throws org.apache.hadoop.yarn.exceptions.YarnException

Returns the SQL FederationStateStore connections to the pool.

Parameters:

log - the logger interface

cstmt - the interface used to execute SQL stored procedures

conn - the SQL connection

rs - the ResultSet interface used to execute SQL stored procedures

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

returnToPool

public static void returnToPool(org.slf4j.Logger log,
                                java.sql.CallableStatement cstmt,
                                java.sql.Connection conn)
                         throws org.apache.hadoop.yarn.exceptions.YarnException

Returns the SQL FederationStateStore connections to the pool.

Parameters:

log - the logger interface

cstmt - the interface used to execute SQL stored procedures

conn - the SQL connection

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

returnToPool

public static void returnToPool(org.slf4j.Logger log,
                                java.sql.CallableStatement cstmt)
                         throws org.apache.hadoop.yarn.exceptions.YarnException

Returns the SQL FederationStateStore connections to the pool.

Parameters:

log - the logger interface

cstmt - the interface used to execute SQL stored procedures

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowException

public static void logAndThrowException(org.slf4j.Logger log,
                                        java.lang.String errMsg,
                                        java.lang.Throwable t)
                                 throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an exception due to an error in FederationStateStore.

Parameters:

log - the logger interface

errMsg - the error message

t - the throwable raised in the called class.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowStoreException

public static void logAndThrowStoreException(org.slf4j.Logger log,
                                             java.lang.String errMsg)
                                      throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreException due to an error in FederationStateStore.

Parameters:

log - the logger interface

errMsg - the error message

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowStoreException

public static void logAndThrowStoreException(org.slf4j.Logger log,
                                             java.lang.String errMsgFormat,
                                             java.lang.Object... args)
                                      throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreException due to an error in FederationStateStore.

Parameters:

log - the logger interface

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowStoreException

public static void logAndThrowStoreException(java.lang.Throwable t,
                                             org.slf4j.Logger log,
                                             java.lang.String errMsgFormat,
                                             java.lang.Object... args)
                                      throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreException due to an error in FederationStateStore.

Parameters:

t - the throwable raised in the called class.

log - the logger interface.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowInvalidInputException

public static void logAndThrowInvalidInputException(org.slf4j.Logger log,
                                                    java.lang.String errMsg)
                                             throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreInvalidInputException due to an error in FederationStateStore.

Parameters:

log - the logger interface

errMsg - the error message

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowRetriableException

public static void logAndThrowRetriableException(org.slf4j.Logger log,
                                                 java.lang.String errMsg,
                                                 java.lang.Throwable t)
                                          throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreRetriableException due to an error in FederationStateStore.

Parameters:

log - the logger interface

errMsg - the error message

t - the throwable raised in the called class.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowRetriableException

public static void logAndThrowRetriableException(java.lang.Throwable t,
                                                 org.slf4j.Logger log,
                                                 java.lang.String errMsgFormat,
                                                 java.lang.Object... args)
                                          throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreRetriableException due to an error in FederationStateStore.

Parameters:

t - the throwable raised in the called class.

log - the logger interface.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

logAndThrowRetriableException

public static void logAndThrowRetriableException(org.slf4j.Logger log,
                                                 java.lang.String errMsgFormat,
                                                 java.lang.Object... args)
                                          throws org.apache.hadoop.yarn.exceptions.YarnException

Throws an FederationStateStoreRetriableException due to an error in FederationStateStore.

Parameters:

log - the logger interface.

errMsgFormat - the error message format string.

args - referenced by the format specifiers in the format string.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - on failure

setProperty

public static void setProperty(com.zaxxer.hikari.HikariDataSource dataSource,
                               java.lang.String property,
                               java.lang.String value)

Sets a specific value for a specific property of HikariDataSource SQL connections.

Parameters:

dataSource - the HikariDataSource connections

property - the property to set

value - the value to set

setUsername

public static void setUsername(com.zaxxer.hikari.HikariDataSource dataSource,
                               java.lang.String userNameDB)

Sets a specific username for HikariDataSource SQL connections.

Parameters:

dataSource - the HikariDataSource connections

userNameDB - the value to set

setPassword

public static void setPassword(com.zaxxer.hikari.HikariDataSource dataSource,
                               java.lang.String password)

Sets a specific password for HikariDataSource SQL connections.

Parameters:

dataSource - the HikariDataSource connections

password - the value to set

filterHomeSubCluster

public static boolean filterHomeSubCluster(SubClusterId filterSubCluster,
                                           SubClusterId homeSubCluster)

Filter HomeSubCluster based on Filter SubCluster.

Parameters:

filterSubCluster - filter query conditions

homeSubCluster - homeSubCluster

Returns:

return true, if match filter conditions, return false, if not match filter conditions.

encodeWritable

public static java.lang.String encodeWritable(org.apache.hadoop.io.Writable key)
                                       throws java.io.IOException

Encode for Writable objects. This method will convert the writable object to a base64 string.

Parameters:

key - Writable Key.

Returns:

base64 string.

Throws:

java.io.IOException - raised on errors performing I/O.

decodeWritable

public static void decodeWritable(org.apache.hadoop.io.Writable w,
                                  java.lang.String idStr)
                           throws java.io.IOException

Decode Base64 string to Writable object.

Parameters:

w - Writable Key.

idStr - base64 string.

Throws:

java.io.IOException - raised on errors performing I/O.

convertMasterKeyToDelegationKey

public static org.apache.hadoop.security.token.delegation.DelegationKey convertMasterKeyToDelegationKey(RouterMasterKeyRequest request)

Convert MasterKey to DelegationKey. Before using this function, please use FederationRouterRMTokenInputValidator to verify the request. By default, the request is not empty, and the internal object is not empty.

Parameters:

request - RouterMasterKeyRequest

Returns:

DelegationKey.