Package org.apache.hadoop.fs.azure

Class WasbRemoteCallHelper

java.lang.Object

org.apache.hadoop.fs.azure.WasbRemoteCallHelper

Direct Known Subclasses:

SecureWasbRemoteCallHelper

public class WasbRemoteCallHelper
extends java.lang.Object

Helper class the has constants and helper methods used in WASB when integrating with a remote http cred service. Currently, remote service will be used to generate SAS keys.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG
static int	REMOTE_CALL_SUCCESS_CODE	Return code when the remote call is successful.

Constructor Summary

Constructors

Constructor	Description
WasbRemoteCallHelper(org.apache.hadoop.io.retry.RetryPolicy retryPolicy)

Method Summary

Modifier and Type	Method	Description
protected org.apache.http.client.methods.HttpUriRequest	getHttpRequest(java.lang.String[] urls, java.lang.String path, java.util.List<org.apache.http.NameValuePair> queryParams, int urlIndex, java.lang.String httpMethod, boolean requiresNewAuth)
java.lang.String	makeRemoteRequest(java.lang.String[] urls, java.lang.String path, java.util.List<org.apache.http.NameValuePair> queryParams, java.lang.String httpMethod)	Helper method to make remote HTTP Get request.
protected java.lang.String	retryableRequest(java.lang.String[] urls, java.lang.String path, java.util.List<org.apache.http.NameValuePair> queryParams, java.lang.String httpMethod)
void	updateHttpClient(org.apache.http.client.HttpClient client)

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

REMOTE_CALL_SUCCESS_CODE

public static final int REMOTE_CALL_SUCCESS_CODE

Return code when the remote call is successful. 0

See Also:

Constant Field Values

Constructor Detail

WasbRemoteCallHelper

public WasbRemoteCallHelper(org.apache.hadoop.io.retry.RetryPolicy retryPolicy)

Method Detail

updateHttpClient

@VisibleForTesting
public void updateHttpClient(org.apache.http.client.HttpClient client)

makeRemoteRequest

public java.lang.String makeRemoteRequest(java.lang.String[] urls,
                                          java.lang.String path,
                                          java.util.List<org.apache.http.NameValuePair> queryParams,
                                          java.lang.String httpMethod)
                                   throws java.io.IOException

Helper method to make remote HTTP Get request.

Parameters:

urls - - Service urls to be used, if one fails try another.

path - - URL endpoint for the resource.

queryParams - - list of query parameters

httpMethod - - http Method to be used.

Returns:

Http Response body returned as a string. The caller is expected to semantically understand the response.

Throws:

java.io.IOException - when there an error in executing the remote http request.

retryableRequest

protected java.lang.String retryableRequest(java.lang.String[] urls,
                                            java.lang.String path,
                                            java.util.List<org.apache.http.NameValuePair> queryParams,
                                            java.lang.String httpMethod)
                                     throws java.io.IOException

Throws:

java.io.IOException

getHttpRequest

protected org.apache.http.client.methods.HttpUriRequest getHttpRequest(java.lang.String[] urls,
                                                                       java.lang.String path,
                                                                       java.util.List<org.apache.http.NameValuePair> queryParams,
                                                                       int urlIndex,
                                                                       java.lang.String httpMethod,
                                                                       boolean requiresNewAuth)
                                                                throws java.net.URISyntaxException,
                                                                       java.io.IOException

Throws:

java.net.URISyntaxException

java.io.IOException