Package org.apache.hadoop.fs.azurebfs.services

Class AbfsHttpOperation.AbfsHttpOperationWithFixedResult

java.lang.Object

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

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

All Implemented Interfaces:

AbfsPerfLoggable

Enclosing class:

AbfsHttpOperation

public static class AbfsHttpOperation.AbfsHttpOperationWithFixedResult
extends AbfsHttpOperation

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.fs.azurebfs.services.AbfsHttpOperation

AbfsHttpOperation.AbfsHttpOperationWithFixedResult

Constructor Summary

Constructors

Constructor	Description
AbfsHttpOperationWithFixedResult(java.net.URL url, java.lang.String method, int httpStatus)	Creates an instance to represent fixed results.

Method Summary

Modifier and Type	Method	Description
protected java.io.InputStream	getContentInputStream()	Get the response stream from the connection.
protected java.io.InputStream	getErrorStream()	Get the error stream from the connection.
java.lang.String	getResponseHeader(java.lang.String httpHeader)	Get response header value for the given headerKey.
java.lang.String	getTracingContextSuffix()	Get the suffix to add to the tracing context that defines what http-client is used to make the network call
void	processResponse(byte[] buffer, int offset, int length)	Gets and processes the HTTP response.
void	sendPayload(byte[] buffer, int offset, int length)	Sends the HTTP request.
void	setRequestProperty(java.lang.String key, java.lang.String value)	Set request header.

Methods inherited from class org.apache.hadoop.fs.azurebfs.services.AbfsHttpOperation

getAbfsHttpOperationWithFixedResult, getBytesReceived, getBytesSent, getClientRequestId, getExpectedAppendPos, getExpectedBytesToBeSent, getHost, getListResultSchema, getLogString, getMaskedEncodedUrl, getMaskedUrl, getMethod, getRecvLatency, getRequestId, getSendLatency, getStatusCode, getStatusDescription, getStorageErrorCode, getStorageErrorMessage, getUrl, isConnectionDisconnectedOnError, setBytesSent, setConnectionDisconnectedOnError, setConnectionTimeMs, setExpectedBytesToBeSent, setMaskForSAS, setRecvResponseTimeMs, setRequestId, setSendRequestTimeMs, setStatusCode, setStatusDescription, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbfsHttpOperationWithFixedResult

public AbfsHttpOperationWithFixedResult(java.net.URL url,
                                        java.lang.String method,
                                        int httpStatus)

Creates an instance to represent fixed results. This is used in idempotency handling.

Parameters:

url - The full URL including query string parameters.

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

httpStatus - StatusCode to hard set

Method Detail

processResponse

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

Description copied from class: AbfsHttpOperation

Gets and processes the HTTP response.

Specified by:

processResponse in class AbfsHttpOperation

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:

java.io.IOException - if an error occurs.

setRequestProperty

public void setRequestProperty(java.lang.String key,
                               java.lang.String value)

Description copied from class: AbfsHttpOperation

Set request header.

Specified by:

setRequestProperty in class AbfsHttpOperation

Parameters:

key - header key.

value - header value.

getContentInputStream

protected java.io.InputStream getContentInputStream()
                                             throws java.io.IOException

Description copied from class: AbfsHttpOperation

Get the response stream from the connection.

Specified by:

getContentInputStream in class AbfsHttpOperation

Returns:

InputStream: response stream from the connection after network call.

Throws:

java.io.IOException - if the response stream could not be created from the connection.

getErrorStream

protected java.io.InputStream getErrorStream()
                                      throws java.io.IOException

Description copied from class: AbfsHttpOperation

Get the error stream from the connection.

Specified by:

getErrorStream in class AbfsHttpOperation

Returns:

InputStream

Throws:

java.io.IOException - if the error stream could not be created from the response stream.

getTracingContextSuffix

public java.lang.String getTracingContextSuffix()

Description copied from class: AbfsHttpOperation

Get the suffix to add to the tracing context that defines what http-client is used to make the network call

Specified by:

getTracingContextSuffix in class AbfsHttpOperation

Returns:

the suffix to distinguish http client

getResponseHeader

public java.lang.String getResponseHeader(java.lang.String httpHeader)

Description copied from class: AbfsHttpOperation

Get response header value for the given headerKey.

Specified by:

getResponseHeader in class AbfsHttpOperation

Parameters:

httpHeader - header key.

Returns:

header value.

sendPayload

public void sendPayload(byte[] buffer,
                        int offset,
                        int length)
                 throws java.io.IOException

Description copied from class: AbfsHttpOperation

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.

Specified by:

sendPayload in class AbfsHttpOperation

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:

java.io.IOException - if an error occurs.