com.yahoo.container.jdisc

Class VespaHeaders

java.lang.Object

com.yahoo.container.jdisc.VespaHeaders

public final class VespaHeaders
extends Object

Static helper methods which implement the mapping between the ErrorMessage API and HTTP headers and return codes.

Author:

Einar M R Rosenvinge, Steinar Knutsen, Simon Thoresen, bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private static int	BAD_GATEWAY
private static int	GATEWAY_TIMEOUT
private static int	NETWORK_AUTHENTICATION_REQUIRED
private static com.yahoo.collections.Tuple2<Boolean,Integer>	NO_MATCH
private static int	PRECONDITION_REQUIRED
private static int	REQUEST_HEADER_FIELDS_TOO_LARGE
private static int	TOO_MANY_REQUESTS

Constructor Summary

Constructors

Constructor and Description
VespaHeaders()

Method Summary

Modifier and Type	Method and Description
static boolean	benchmarkCoverage(boolean benchmarkOutput, com.yahoo.jdisc.HeaderFields headers)
static void	benchmarkOutput(com.yahoo.jdisc.HeaderFields responseHeaders, boolean benchmarkCoverage, Timing t, com.yahoo.container.logging.HitCounts c, int errorCount, Coverage coverage) Add search benchmark output to the HTTP getHeaders
static boolean	benchmarkOutput(HttpRequest request)
private static com.yahoo.collections.Tuple2<Boolean,Integer>	chooseStatusFromError(com.yahoo.processing.request.ErrorMessage error)
private static com.yahoo.collections.Tuple2<Boolean,Integer>	chooseWebServiceStatus(com.yahoo.processing.request.ErrorMessage error)
static int	getEagerErrorStatus(com.yahoo.processing.request.ErrorMessage mainError, Iterator<? extends com.yahoo.processing.request.ErrorMessage> allErrors) Returns 5xx or 4xx if there is any error present in the result, 200 otherwise
static int	getStatus(boolean isSuccess, com.yahoo.processing.request.ErrorMessage mainError, Iterator<? extends com.yahoo.processing.request.ErrorMessage> allErrors) (during normal execution) return 200 unless this is not a success or a 4xx error is requested.
private static boolean	isHttpStatusCode(int code)
private static com.yahoo.collections.Tuple2<Boolean,Integer>	webServiceCodes(com.yahoo.processing.request.ErrorMessage mainError, Iterator<? extends com.yahoo.processing.request.ErrorMessage> allErrors)

Methods inherited from class java.lang.Object

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

Field Detail

GATEWAY_TIMEOUT

private static final int GATEWAY_TIMEOUT

See Also:

Constant Field Values

BAD_GATEWAY

private static final int BAD_GATEWAY

See Also:

Constant Field Values

PRECONDITION_REQUIRED

private static final int PRECONDITION_REQUIRED

See Also:

Constant Field Values

TOO_MANY_REQUESTS

private static final int TOO_MANY_REQUESTS

See Also:

Constant Field Values

REQUEST_HEADER_FIELDS_TOO_LARGE

private static final int REQUEST_HEADER_FIELDS_TOO_LARGE

See Also:

Constant Field Values

NETWORK_AUTHENTICATION_REQUIRED

private static final int NETWORK_AUTHENTICATION_REQUIRED

See Also:

Constant Field Values

NO_MATCH

private static final com.yahoo.collections.Tuple2<Boolean,Integer> NO_MATCH

Constructor Detail

VespaHeaders

public VespaHeaders()

Method Detail

benchmarkCoverage

public static boolean benchmarkCoverage(boolean benchmarkOutput,
                                        com.yahoo.jdisc.HeaderFields headers)

benchmarkOutput

public static boolean benchmarkOutput(HttpRequest request)

benchmarkOutput

public static void benchmarkOutput(com.yahoo.jdisc.HeaderFields responseHeaders,
                                   boolean benchmarkCoverage,
                                   Timing t,
                                   com.yahoo.container.logging.HitCounts c,
                                   int errorCount,
                                   Coverage coverage)

Add search benchmark output to the HTTP getHeaders

Parameters:

responseHeaders - The response to write the headers to.

benchmarkCoverage - True to include coverage headers.

t - The Timing to read data from.

c - The Counts to read data from.

errorCount - The error count.

coverage - The Coverage to read data from.

getStatus

public static int getStatus(boolean isSuccess,
                            com.yahoo.processing.request.ErrorMessage mainError,
                            Iterator<? extends com.yahoo.processing.request.ErrorMessage> allErrors)

(during normal execution) return 200 unless this is not a success or a 4xx error is requested.

Parameters:

isSuccess - Whether or not the response represents a success.

mainError - The main error of the response, if any.

allErrors - All the errors of the response, if any.

Returns:

The status code of the given response.

webServiceCodes

private static com.yahoo.collections.Tuple2<Boolean,Integer> webServiceCodes(com.yahoo.processing.request.ErrorMessage mainError,
                                                                             Iterator<? extends com.yahoo.processing.request.ErrorMessage> allErrors)

chooseWebServiceStatus

private static com.yahoo.collections.Tuple2<Boolean,Integer> chooseWebServiceStatus(com.yahoo.processing.request.ErrorMessage error)

isHttpStatusCode

private static boolean isHttpStatusCode(int code)

getEagerErrorStatus

public static int getEagerErrorStatus(com.yahoo.processing.request.ErrorMessage mainError,
                                      Iterator<? extends com.yahoo.processing.request.ErrorMessage> allErrors)

Returns 5xx or 4xx if there is any error present in the result, 200 otherwise

Parameters:

mainError - The main error of the response.

allErrors - All the errors of the response, if any.

Returns:

The error status code of the given response.

chooseStatusFromError

private static com.yahoo.collections.Tuple2<Boolean,Integer> chooseStatusFromError(com.yahoo.processing.request.ErrorMessage error)