com.sap.smp.client.supportability

Interface E2ETraceRequest

public interface E2ETraceRequest

End-To-End trace request. Instances of this type are thread-safe. All the parameters that are accessible via getters are initialized upon instantiation of an object of this type. Hence, getter invocations are not disturbed by potential concurrent finishing of the enclosing step/transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	E2ETraceRequest.RequestStatus Status of the Request.

Method Summary

Modifier and Type	Method and Description
void	endRequest() Ends the request.
java.lang.String	getCorrelationIDHttpHeader() Returns the X-CorrelationID header.
java.lang.String	getPassportHttpHeader() Retrieves the SAP passport header.
E2ETraceRequest.RequestStatus	getStatus() Returns the status of the request.
TraceInfo	getTraceInfo() Returns the trace info object.
java.lang.String	getTransactionID() Returns the transaction ID.
void	markReceived() Should be called as soon as data was completely received.
void	markReceiving() Should be called upon receiving first data bytes.
void	markSending() Should be called before data is sent.
void	markSent() Should be called as soon as the data was sent.
void	setByteCountReceived(long count) Sets the size of received data in bytes.
void	setByteCountSent(long count) Sets the size of sent data in bytes.
void	setDuration(long duration) Sets the duration.
void	setRequestHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets the request headers as key value pairs.
void	setRequestHeaders(java.lang.String headers) Sets the request headers.
void	setRequestLine(java.lang.String requestLine) Sets the request line.
void	setResponseHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets the response headers as key value pairs.
void	setResponseHeaders(java.lang.String headers) Sets the response headers.
void	setReturnCode(java.lang.String returnCode) Sets the return code.

Method Detail

endRequest

void endRequest()

Ends the request. Does nothing in case the request has already ended.

getTraceInfo

TraceInfo getTraceInfo()

Returns the trace info object.

Returns:

the trace info, always non-null

getPassportHttpHeader

java.lang.String getPassportHttpHeader()

Retrieves the SAP passport header.

Returns:

SAP Passport, always non-null

getCorrelationIDHttpHeader

java.lang.String getCorrelationIDHttpHeader()

Returns the X-CorrelationID header.

Returns:

Correlation-ID, always non-null

getTransactionID

java.lang.String getTransactionID()

Returns the transaction ID.

Returns:

transaction ID, always non-null

markSending

void markSending()

Should be called before data is sent. Timestamp generated internally, hence no additional parameter required.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

markSent

void markSent()

Should be called as soon as the data was sent. Timestamp generated internally, hence no additional parameter required.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

markReceiving

void markReceiving()

Should be called upon receiving first data bytes. Timestamp generated internally, hence no additional parameter required.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

markReceived

void markReceived()

Should be called as soon as data was completely received. Timestamp generated internally, hence no additional parameter required.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

setByteCountSent

void setByteCountSent(long count)

Sets the size of sent data in bytes. If the argument is negative then zero is set.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

Parameters:

count - the byte count

setByteCountReceived

void setByteCountReceived(long count)

Sets the size of received data in bytes. If the argument is negative then zero is set.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

Parameters:

count -

setRequestHeaders

void setRequestHeaders(java.lang.String headers)

Sets the request headers. The value passed must consist of lines delimited by "\r\n" characters. The first line shall be the request-line, and the headers must follow the format: 'name: value'.

This method does nothing in case this request and/or its enclosing step/transaction has been ended or in case the arugment is null.

TODO To be discussed w/ arch.

Parameters:

headers - the header string, can be null

setRequestHeaders

void setRequestHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Sets the request headers as key value pairs.

This method does nothing in case this request and/or its enclosing step/transaction has been ended or in case the argument is null.

Parameters:

headers - the header map, can be null

setResponseHeaders

void setResponseHeaders(java.lang.String headers)

Sets the response headers. The value passed must be consist of lines delimited by "\r\n" characters, and the headers must follow the format: 'name: value'.

This method does nothing in case this request and/or its enclosing step/transaction has been ended or in case the arugment is null.

TODO To be discussed w/ arch.

Parameters:

headers - the header string, can be null

setResponseHeaders

void setResponseHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Sets the response headers as key value pairs.

This method does nothing in case this request and/or its enclosing step/transaction has been ended or in case the argument is null.

Parameters:

headers - the header map, can be null

setRequestLine

void setRequestLine(java.lang.String requestLine)

Sets the request line. It should follow the following pattern: {action} {uri} {protocol}.

This method does nothing in case this request and/or its enclosing step/transaction has been ended or in case the argument is null.

Parameters:

requestLine - the request line, can be null

setReturnCode

void setReturnCode(java.lang.String returnCode)

Sets the return code.

This method does nothing in case this request and/or its enclosing step/transaction has been ended or in case the argument is null.

Parameters:

returnCode - the return code, can be null

setDuration

void setDuration(long duration)

Sets the duration.

This method does nothing in case this request and/or its enclosing step/transaction has been ended.

Parameters:

duration -

getStatus

E2ETraceRequest.RequestStatus getStatus()

Returns the status of the request.

Returns:

the status, always non-null