Class Context.Builder (3.8.0)

public static final class Context.Builder

A builder for {@see Context} objects.

Inheritance

java.lang.Object > Context.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public Context build()

Creates a {@see Context} object for this builder.

Returns

Type	Description
Context

loadCloudTraceContext(String cloudTrace)

public Context.Builder loadCloudTraceContext(String cloudTrace)

Sets the trace id and span id values by parsing the string which represents xCloud Trace Context. The Cloud Trace Context is passed as x-cloud-trace-context header (can be in Pascal case format). The string format is TRACE_ID/SPAN_ID;o=TRACE_TRUE. See Also: Cloud Trace header format.

Parameter

Name	Description
cloudTrace	`String`

Returns

Type	Description
Context.Builder

loadW3CTraceParentContext(String traceParent)

public Context.Builder loadW3CTraceParentContext(String traceParent)

Sets the trace id and span id values by parsing the string which represents the standard W3C trace context propagation header. The context propagation header is passed as traceparent header. The method currently supports ONLY version "00". The string format is 00-TRACE_ID-SPAN_ID-FLAGS. field of the version-format value. See Also: traceparent header value format

Parameter

Name	Description
traceParent	`String`

Returns

Type	Description
Context.Builder

Exceptions

Type	Description
IllegalArgumentException	if passed argument does not follow the @W3C trace format or the format version is not supported.

setReferer(String referer)

public Context.Builder setReferer(String referer)

Sets the referer URL of the request, as defined in HTTP/1.1 Header Field Definitions. See Also: HTTP/1.1 Header Field Definitions

Parameter

Name	Description
referer	`String`

Returns

Type	Description
Context.Builder

setRemoteIp(String remoteIp)

public Context.Builder setRemoteIp(String remoteIp)

Sets the IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: 192.168.1.1, FE80::0202:B3FF:FE1E:8329.

Parameter

Name	Description
remoteIp	`String`

Returns

Type	Description
Context.Builder

setRequest(HttpRequest request)

public Context.Builder setRequest(HttpRequest request)

Sets the HTTP request.

Parameter

Name	Description
request	`HttpRequest`

Returns

Type	Description
Context.Builder

setRequestMethod(HttpRequest.RequestMethod method)

public Context.Builder setRequestMethod(HttpRequest.RequestMethod method)

Sets the HTTP request method.

Parameter

Name	Description
method	`HttpRequest.RequestMethod`

Returns

Type	Description
Context.Builder

setRequestUrl(String url)

public Context.Builder setRequestUrl(String url)

Parameter

Name	Description
url	`String`

Returns

Type	Description
Context.Builder

setServerIp(String serverIp)

public Context.Builder setServerIp(String serverIp)

Sets the IP address (IPv4 or IPv6) of the origin server that the request was sent to. Examples: 192.168.1.1, FE80::0202:B3FF:FE1E:8329.

Parameter

Name	Description
serverIp	`String`

Returns

Type	Description
Context.Builder

setSpanId(String spanId)

public Context.Builder setSpanId(String spanId)

Sets the string as a span id value.

Parameter

Name	Description
spanId	`String`

Returns

Type	Description
Context.Builder

setTraceId(String traceId)

public Context.Builder setTraceId(String traceId)

Sets the string as a trace id value.

Parameter

Name	Description
traceId	`String`

Returns

Type	Description
Context.Builder