Class Reference.Builder

java.lang.Object

is.galia.http.Reference.Builder

Enclosing class:

Reference

public static final class Reference.Builder
extends Object

Builds new instances from scratch and also builds new instances based on existing ones.

Method Summary

Modifier and Type	Method	Description
Reference.Builder	appendPath(String path)
Reference.Builder	applyProxyHeaders(Headers headers)	Applies any reverse proxying-related request headers present in the argument.
Reference	build()
Reference.Builder	prependPath(String path)
Reference.Builder	withFragment(String fragment)
Reference.Builder	withHost(String host)
Reference.Builder	withoutFragment()
Reference.Builder	withoutPath()
Reference.Builder	withoutPort()
Reference.Builder	withoutQuery()
Reference.Builder	withoutSecret()
Reference.Builder	withoutTrailingSlashInPath()
Reference.Builder	withoutUser()
Reference.Builder	withPath(String path)
Reference.Builder	withPathSegment(int segmentIndex, String pathSegment)	Updates a segment (token between slashes) of the path.
Reference.Builder	withPort(int port)
Reference.Builder	withQuery(Query query)
Reference.Builder	withScheme(String scheme)
Reference.Builder	withSecret(String secret)
Reference.Builder	withUser(String user)

Methods inherited from class java.lang.Object

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

Method Details

appendPath

public Reference.Builder appendPath(String path)

Parameters:

path - Path segment(s) to add to the end of the current path. If a leading slash is missing, it is added.

applyProxyHeaders

public Reference.Builder applyProxyHeaders(Headers headers)

Applies any reverse proxying-related request headers present in the argument. The supported headers are:

• X-Forwarded-Proto
• X-Forwarded-Host
• X-Forwarded-Port
• X-Forwarded-BasePath

Parameters:

headers - Request headers.

prependPath

public Reference.Builder prependPath(String path)

Parameters:

path - Path to prepend to the current path.

withFragment

public Reference.Builder withFragment(String fragment)

withHost

public Reference.Builder withHost(String host)

withPath

public Reference.Builder withPath(String path)

Parameters:

path - New path. Any trailing slash is stripped.

See Also:

• prependPath(String)

withPathSegment

public Reference.Builder withPathSegment(int segmentIndex,
 String pathSegment)

Updates a segment (token between slashes) of the path.

Parameters:

segmentIndex - Zero-based path segment index.

pathSegment - Path segment.

Throws:

IndexOutOfBoundsException - if the given index is greater than the number of path segments.

withPort

public Reference.Builder withPort(int port)

withQuery

public Reference.Builder withQuery(Query query)

withScheme

public Reference.Builder withScheme(String scheme)

withSecret

public Reference.Builder withSecret(String secret)

withUser

public Reference.Builder withUser(String user)

withoutFragment

public Reference.Builder withoutFragment()

withoutPath

public Reference.Builder withoutPath()

withoutPort

public Reference.Builder withoutPort()

withoutQuery

public Reference.Builder withoutQuery()

withoutTrailingSlashInPath

public Reference.Builder withoutTrailingSlashInPath()

withoutSecret

public Reference.Builder withoutSecret()

withoutUser

public Reference.Builder withoutUser()

build

public Reference build()