org.apache.hc.client5.http

Class ProxyStatus

java.lang.Object

org.apache.hc.client5.http.ProxyStatus

@Contract(threading=IMMUTABLE)
public final class ProxyStatus
extends Object

A single member of the Proxy-Status response field defined by RFC 9209. Each member identifies one intermediary and carries the parameters that describe how that intermediary handled the request.

This type is a passive, immutable data holder. It neither interprets nor acts on the reported values; callers decide whether and how to use them. Parameter values keep their Structured Fields (RFC 8941) types: a ProxyStatus.Token for tokens, a String for strings, a Long for integers, a BigDecimal for decimals, a Boolean for booleans and a byte[] for byte sequences. Byte-sequence values are defensively copied on the way in and out, so instances remain immutable. Parsing of the field value is performed by ProxyStatusSupport.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyStatus.Token An RFC 8941 Token value, kept distinct from String so that Token and String parameter values are not conflated.

Constructor Summary

Constructors

Constructor and Description
ProxyStatus(String name, Map<String,Object> parameters) Creates a member with the given intermediary identity and parameters.

Method Summary

Modifier and Type	Method and Description
String	getDetails() Returns the free-form details string, or null when the parameter is absent.
ProxyStatusError	getError() Returns the standardized error, or null when the parameter is absent or its token is not registered by RFC 9209.
String	getErrorToken() Returns the raw error token, or null when the parameter is absent or not a token.
String	getName() Returns the identity of the intermediary, that is, the value of the list member.
String	getNextHop() Returns the next-hop value, or null when the parameter is absent.
String	getNextProtocol() Returns the next-protocol ALPN identifier when it is expressed as a token, or null when the parameter is absent or expressed as a byte sequence.
Object	getParameter(String name) Returns the value of the named parameter, or null when it is absent.
Map<String,Object>	getParameters() Returns the parameters attached to this member as an unmodifiable map in parsed order.
Integer	getReceivedStatus() Returns the received-status code, or null when the parameter is absent or not an integer.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyStatus

public ProxyStatus(String name,
                   Map<String,Object> parameters)

Creates a member with the given intermediary identity and parameters. The parameter map is deep-copied and byte[] values are cloned, so the instance cannot be mutated through the supplied map. To keep the instance immutable, each value must be one of the supported Structured Fields types (ProxyStatus.Token, String, Long, BigDecimal, Boolean or byte[]); any other value is rejected.

Parameters:

name - the identity of the intermediary; must not be null.

parameters - the member parameters, or null for none.

Throws:

IllegalArgumentException - if a parameter value is not a supported type.

Method Detail

getName

public String getName()

Returns the identity of the intermediary, that is, the value of the list member.

getParameters

public Map<String,Object> getParameters()

Returns the parameters attached to this member as an unmodifiable map in parsed order. Any byte[] value is cloned, so mutating it does not affect this instance.

getParameter

public Object getParameter(String name)

Returns the value of the named parameter, or null when it is absent. A byte[] value is cloned before being returned.

getErrorToken

public String getErrorToken()

Returns the raw error token, or null when the parameter is absent or not a token.

getError

public ProxyStatusError getError()

Returns the standardized error, or null when the parameter is absent or its token is not registered by RFC 9209.

getNextHop

public String getNextHop()

Returns the next-hop value, or null when the parameter is absent. The parameter may be a string or a token; both are returned as their character value.

getNextProtocol

public String getNextProtocol()

Returns the next-protocol ALPN identifier when it is expressed as a token, or null when the parameter is absent or expressed as a byte sequence. A byte-sequence identifier is available as a byte[] through getParameter(String).

getReceivedStatus

public Integer getReceivedStatus()

Returns the received-status code, or null when the parameter is absent or not an integer. The value is validated as an HTTP status code during parsing, so it always fits in an int.

getDetails

public String getDetails()

Returns the free-form details string, or null when the parameter is absent.

toString

public String toString()

Overrides:

toString in class Object