org.apache.hadoop.fs.azurebfs.services

Class AbfsHttpOperation

java.lang.Object

org.apache.hadoop.fs.azurebfs.services.AbfsHttpOperation

All Implemented Interfaces:

AbfsPerfLoggable

Direct Known Subclasses:

AbfsHttpOperation.AbfsHttpOperationWithFixedResult

public class AbfsHttpOperation
extends Object
implements AbfsPerfLoggable

Represents an HTTP operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbfsHttpOperation.AbfsHttpOperationWithFixedResult

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIGNATURE_QUERY_PARAM_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbfsHttpOperation(URL url, String method, int httpStatus) Constructor for FixedResult instance, avoiding connection init.
	AbfsHttpOperation(URL url, String method, List<AbfsHttpHeader> requestHeaders) Initializes a new HTTP request and opens the connection.

Method Summary

Modifier and Type	Method and Description
static String	encodedUrlStr(String url)
static AbfsHttpOperation	getAbfsHttpOperationWithFixedResult(URL url, String method, int httpStatus)
long	getBytesReceived()
int	getBytesSent()
String	getClientRequestId()
protected HttpURLConnection	getConnection()
String	getExpectedAppendPos()
String	getHost()
ListResultSchema	getListResultSchema()
String	getLogString() Gets the string to log to the Abfs Logging API.
String	getMethod()
String	getRequestId()
String	getResponseHeader(String httpHeader)
String	getSignatureMaskedEncodedUrl()
String	getSignatureMaskedUrl()
static String	getSignatureMaskedUrl(String url)
int	getStatusCode()
String	getStatusDescription()
String	getStorageErrorCode()
String	getStorageErrorMessage()
void	processResponse(byte[] buffer, int offset, int length) Gets and processes the HTTP response.
void	sendRequest(byte[] buffer, int offset, int length) Sends the HTTP request.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SIGNATURE_QUERY_PARAM_KEY

public static final String SIGNATURE_QUERY_PARAM_KEY

See Also:

Constant Field Values

Constructor Detail

AbfsHttpOperation

protected AbfsHttpOperation(URL url,
                            String method,
                            int httpStatus)

Constructor for FixedResult instance, avoiding connection init.

Parameters:

url - request url

method - Http method

httpStatus - HttpStatus

AbfsHttpOperation

public AbfsHttpOperation(URL url,
                         String method,
                         List<AbfsHttpHeader> requestHeaders)
                  throws IOException

Initializes a new HTTP request and opens the connection.

Parameters:

url - The full URL including query string parameters.

method - The HTTP method (PUT, PATCH, POST, GET, HEAD, or DELETE).

requestHeaders - The HTTP request headers.READ_TIMEOUT

Throws:

IOException - if an error occurs.

Method Detail

getAbfsHttpOperationWithFixedResult

public static AbfsHttpOperation getAbfsHttpOperationWithFixedResult(URL url,
                                                                    String method,
                                                                    int httpStatus)

getConnection

protected HttpURLConnection getConnection()

getMethod

public String getMethod()

getHost

public String getHost()

getStatusCode

public int getStatusCode()

getStatusDescription

public String getStatusDescription()

getStorageErrorCode

public String getStorageErrorCode()

getStorageErrorMessage

public String getStorageErrorMessage()

getClientRequestId

public String getClientRequestId()

getExpectedAppendPos

public String getExpectedAppendPos()

getRequestId

public String getRequestId()

getBytesSent

public int getBytesSent()

getBytesReceived

public long getBytesReceived()

getListResultSchema

public ListResultSchema getListResultSchema()

getResponseHeader

public String getResponseHeader(String httpHeader)

toString

public String toString()

Overrides:

toString in class Object

getLogString

public String getLogString()

Description copied from interface: AbfsPerfLoggable

Gets the string to log to the Abfs Logging API.

Specified by:

getLogString in interface AbfsPerfLoggable

Returns:

the string that will be logged.

sendRequest

public void sendRequest(byte[] buffer,
                        int offset,
                        int length)
                 throws IOException

Sends the HTTP request. Note that HttpUrlConnection requires that an empty buffer be sent in order to set the "Content-Length: 0" header, which is required by our endpoint.

Parameters:

buffer - the request entity body.

offset - an offset into the buffer where the data beings.

length - the length of the data in the buffer.

Throws:

IOException - if an error occurs.

processResponse

public void processResponse(byte[] buffer,
                            int offset,
                            int length)
                     throws IOException

Gets and processes the HTTP response.

Parameters:

buffer - a buffer to hold the response entity body

offset - an offset in the buffer where the data will being.

length - the number of bytes to be written to the buffer.

Throws:

IOException - if an error occurs.

getSignatureMaskedUrl

public static String getSignatureMaskedUrl(String url)

encodedUrlStr

public static String encodedUrlStr(String url)

getSignatureMaskedUrl

public String getSignatureMaskedUrl()

getSignatureMaskedEncodedUrl

public String getSignatureMaskedEncodedUrl()