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:

AbfsAHCHttpOperation, AbfsHttpOperation.AbfsHttpOperationWithFixedResult, AbfsJdkHttpOperation

public abstract class AbfsHttpOperation
extends Object
implements AbfsPerfLoggable

Base Http operation class for orchestrating server IO calls. Child classes would define the certain orchestration implementation on the basis of network library used.

For JDK netlib usage, the child class would be AbfsJdkHttpOperation.
For ApacheHttpClient netlib usage, the child class would be AbfsAHCHttpOperation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbfsHttpOperation.AbfsHttpOperationWithFixedResult

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbfsHttpOperation(org.slf4j.Logger log, URL url, String method, List<AbfsHttpHeader> requestHeaders, Duration connectionTimeout, Duration readTimeout)
protected	AbfsHttpOperation(URL url, String method, int httpStatus) Constructor for FixedResult instance, avoiding connection init.

Method Summary

Modifier and Type	Method and Description
static AbfsHttpOperation	getAbfsHttpOperationWithFixedResult(URL url, String method, int httpStatus)
long	getBytesReceived()
int	getBytesSent()
String	getClientRequestId()
protected abstract InputStream	getContentInputStream() Get the response stream from the connection.
protected abstract InputStream	getErrorStream() Get the error stream from the connection.
String	getExpectedAppendPos()
int	getExpectedBytesToBeSent()
String	getHost()
ListResultSchema	getListResultSchema()
String	getLogString() Gets the string to log to the Abfs Logging API.
String	getMaskedEncodedUrl()
String	getMaskedUrl()
String	getMethod()
long	getRecvLatency()
String	getRequestId()
abstract String	getResponseHeader(String httpHeader) Get response header value for the given headerKey.
long	getSendLatency()
int	getStatusCode()
String	getStatusDescription()
String	getStorageErrorCode()
String	getStorageErrorMessage()
abstract String	getTracingContextSuffix() Get the suffix to add to the tracing context that defines what http-client is used to make the network call
URL	getUrl()
protected boolean	isConnectionDisconnectedOnError()
abstract void	processResponse(byte[] buffer, int offset, int length) Gets and processes the HTTP response.
abstract void	sendPayload(byte[] buffer, int offset, int length) Sends the HTTP request.
protected void	setBytesSent(int bytesSent) Sets byteSent metric.
protected void	setConnectionDisconnectedOnError() Marks network error and expect100 failures for send-payload phase.
protected void	setConnectionTimeMs(long connectionTimeMs) Sets connection time in milliseconds taken to establish the connection.
protected void	setExpectedBytesToBeSent(int expectedBytesToBeSent) Sets expected bytes to be sent.
void	setMaskForSAS()
protected void	setRecvResponseTimeMs(long recvResponseTimeMs) Sets receive response time in milliseconds.
protected void	setRequestId() Set x-ms-request-id value from the server call response header.
abstract void	setRequestProperty(String key, String value) Set request header.
protected void	setSendRequestTimeMs(long sendRequestTimeMs) Sets send request time in milliseconds.
protected void	setStatusCode(int statusCode) Set response status code for the server call.
protected void	setStatusDescription(String statusDescription) Sets response status description for the server call.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbfsHttpOperation

public AbfsHttpOperation(org.slf4j.Logger log,
                         URL url,
                         String method,
                         List<AbfsHttpHeader> requestHeaders,
                         Duration connectionTimeout,
                         Duration readTimeout)

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

Method Detail

getAbfsHttpOperationWithFixedResult

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

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()

setMaskForSAS

public void setMaskForSAS()

getBytesSent

public int getBytesSent()

getExpectedBytesToBeSent

public int getExpectedBytesToBeSent()

getBytesReceived

public long getBytesReceived()

getUrl

public URL getUrl()

getListResultSchema

public ListResultSchema getListResultSchema()

getResponseHeader

public abstract String getResponseHeader(String httpHeader)

Get response header value for the given headerKey.

Parameters:

httpHeader - header key.

Returns:

header value.

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.

getMaskedUrl

@VisibleForTesting
public String getMaskedUrl()

getMaskedEncodedUrl

public final String getMaskedEncodedUrl()

sendPayload

public abstract void sendPayload(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 abstract 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.

setRequestProperty

public abstract void setRequestProperty(String key,
                                        String value)

Set request header.

Parameters:

key - header key.

value - header value.

getContentInputStream

protected abstract InputStream getContentInputStream()
                                              throws IOException

Get the response stream from the connection.

Returns:

InputStream: response stream from the connection after network call.

Throws:

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

getErrorStream

protected abstract InputStream getErrorStream()
                                       throws IOException

Get the error stream from the connection.

Returns:

InputStream

Throws:

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

getTracingContextSuffix

public abstract String getTracingContextSuffix()

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

Returns:

the suffix to distinguish http client

getSendLatency

public final long getSendLatency()

getRecvLatency

public final long getRecvLatency()

setStatusCode

protected void setStatusCode(int statusCode)

Set response status code for the server call.

Parameters:

statusCode - status code.

setStatusDescription

protected void setStatusDescription(String statusDescription)

Sets response status description for the server call.

Parameters:

statusDescription - status description.

setRequestId

protected void setRequestId()

Set x-ms-request-id value from the server call response header.

setBytesSent

protected void setBytesSent(int bytesSent)

Sets byteSent metric.

Parameters:

bytesSent - bytes sent.

setExpectedBytesToBeSent

protected void setExpectedBytesToBeSent(int expectedBytesToBeSent)

Sets expected bytes to be sent.

Parameters:

expectedBytesToBeSent - expected bytes to be sent.

setConnectionTimeMs

protected void setConnectionTimeMs(long connectionTimeMs)

Sets connection time in milliseconds taken to establish the connection.

Parameters:

connectionTimeMs - connection time in milliseconds.

setSendRequestTimeMs

protected void setSendRequestTimeMs(long sendRequestTimeMs)

Sets send request time in milliseconds.

Parameters:

sendRequestTimeMs - send request time in milliseconds.

setRecvResponseTimeMs

protected void setRecvResponseTimeMs(long recvResponseTimeMs)

Sets receive response time in milliseconds.

Parameters:

recvResponseTimeMs - receive response time in milliseconds.

setConnectionDisconnectedOnError

protected void setConnectionDisconnectedOnError()

Marks network error and expect100 failures for send-payload phase.

isConnectionDisconnectedOnError

protected boolean isConnectionDisconnectedOnError()

Returns:

value of connectionDisconnectedOnError