zipkin

Class Endpoint.Builder

java.lang.Object

zipkin.Endpoint.Builder

Enclosing class:

Endpoint

public static final class Endpoint.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Endpoint	build()
Endpoint.Builder	ipv4(int ipv4)
Endpoint.Builder	ipv6(byte[] ipv6) When not null, this sets the Endpoint.ipv6, unless the input is an IPv4-Compatible or IPv4-Mapped Embedded IPv6 Address.
boolean	parseIp(InetAddress addr) Returns true if ipv4(int) or ipv6(byte[]) could be parsed from the input.
boolean	parseIp(String ipString) Returns true if ipv4(int) or ipv6(byte[]) could be parsed from the input.
Endpoint.Builder	port(int port) Use this to set the port to an externally defined value.
Endpoint.Builder	port(Short port)
Endpoint.Builder	serviceName(String serviceName)

Methods inherited from class java.lang.Object

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

Method Detail

serviceName

public Endpoint.Builder serviceName(String serviceName)

See Also:

Endpoint.serviceName

parseIp

public boolean parseIp(@Nullable
                       InetAddress addr)

Returns true if ipv4(int) or ipv6(byte[]) could be parsed from the input.

Returns boolean not this for conditional parsing. For example:

 if (!builder.parseIp(input.getHeader("X-Forwarded-For"))) {
   builder.parseIp(input.getRemoteAddr());
 }
 

Since:

1.24

See Also:

parseIp(String)

parseIp

public boolean parseIp(@Nullable
                       String ipString)

Returns true if ipv4(int) or ipv6(byte[]) could be parsed from the input.

Returns boolean not this for conditional parsing. For example:

 if (!builder.parseIp(input.getHeader("X-Forwarded-For"))) {
   builder.parseIp(input.getRemoteAddr());
 }
 

Since:

1.24

See Also:

parseIp(InetAddress)

ipv4

public Endpoint.Builder ipv4(int ipv4)

See Also:

Endpoint.ipv4

ipv6

public Endpoint.Builder ipv6(@Nullable
                             byte[] ipv6)

When not null, this sets the Endpoint.ipv6, unless the input is an IPv4-Compatible or IPv4-Mapped Embedded IPv6 Address. In such case, ipv4(int) is called with the embedded address.

See Also:

Endpoint.ipv6

port

public Endpoint.Builder port(int port)

Use this to set the port to an externally defined value.

Don't pass Endpoint.port to this method, as it may result in a NullPointerException. Instead, use Endpoint.toBuilder() or port(Short).

Parameters:

port - port associated with the endpoint. zero coerces to null (unknown)

See Also:

Endpoint.port

port

public Endpoint.Builder port(@Nullable
                             Short port)

See Also:

Endpoint.port

build

public Endpoint build()