com.oracle.bmc.loadbalancer.model

Class LBCookieSessionPersistenceConfigurationDetails.Builder

java.lang.Object

com.oracle.bmc.loadbalancer.model.LBCookieSessionPersistenceConfigurationDetails.Builder

Enclosing class:

LBCookieSessionPersistenceConfigurationDetails

public static class LBCookieSessionPersistenceConfigurationDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LBCookieSessionPersistenceConfigurationDetails	build()
LBCookieSessionPersistenceConfigurationDetails.Builder	cookieName(String cookieName) The name of the cookie inserted by the load balancer.
LBCookieSessionPersistenceConfigurationDetails.Builder	copy(LBCookieSessionPersistenceConfigurationDetails model)
LBCookieSessionPersistenceConfigurationDetails.Builder	disableFallback(Boolean disableFallback) Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable.
LBCookieSessionPersistenceConfigurationDetails.Builder	domain(String domain) The domain in which the cookie is valid.
LBCookieSessionPersistenceConfigurationDetails.Builder	isHttpOnly(Boolean isHttpOnly) Whether the Set-cookie header should contain the HttpOnly attribute.
LBCookieSessionPersistenceConfigurationDetails.Builder	isSecure(Boolean isSecure) Whether the Set-cookie header should contain the Secure attribute.
LBCookieSessionPersistenceConfigurationDetails.Builder	maxAgeInSeconds(Integer maxAgeInSeconds) The amount of time the cookie remains valid.
LBCookieSessionPersistenceConfigurationDetails.Builder	path(String path) The path in which the cookie is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cookieName

public LBCookieSessionPersistenceConfigurationDetails.Builder cookieName(String cookieName)

The name of the cookie inserted by the load balancer. If this field is not configured, the cookie name defaults to “X-Oracle-BMC-LBS-Route”.

Example: example_cookie

Notes:**

Ensure that the cookie name used at the backend application servers is different from the cookie name used at the load balancer. To minimize the chance of name collision, Oracle recommends that you use a prefix such as "X-Oracle-OCI-" for this field.

If a backend server and the load balancer both insert cookies with the same name, the client or browser behavior can vary depending on the domain and path values associated with the cookie. If the name, domain, and path values of the Set-cookie generated by a backend server and the Set-cookie generated by the load balancer are all the same, the client or browser treats them as one cookie and returns only one of the cookie values in subsequent requests. If both Set-cookie names are the same, but the domain and path names are different, the client or browser treats them as two different cookies.

Parameters:

cookieName - the value to set

Returns:

this builder

disableFallback

public LBCookieSessionPersistenceConfigurationDetails.Builder disableFallback(Boolean disableFallback)

Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false.

Example: false

Parameters:

disableFallback - the value to set

Returns:

this builder

domain

public LBCookieSessionPersistenceConfigurationDetails.Builder domain(String domain)

The domain in which the cookie is valid. The Set-cookie header inserted by the load balancer contains a domain attribute with the specified value.

This attribute has no default value. If you do not specify a value, the load balancer does not insert the domain attribute into the Set-cookie header.

Notes:**

[RFC 6265 - HTTP State Management Mechanism](https://www.ietf.org/rfc/rfc6265.txt) describes client and browser behavior when the domain attribute is present or not present in the Set-cookie header.

If the value of the Domain attribute is example.com in the Set-cookie header, the client includes the same cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.abc.example.com. If the Domain attribute is not present, the client returns the cookie only for the domain to which the original request was made.

Ensure that this attribute specifies the correct domain value. If the Domain attribute in the Set-cookie header does not include the domain to which the original request was made, the client or browser might reject the cookie. As specified in RFC 6265, the client accepts a cookie with the Domain attribute value example.com or www.example.com sent from www.example.com. It does not accept a cookie with the Domain attribute abc.example.com or www.abc.example.com sent from www.example.com.

Example: example.com

Parameters:

domain - the value to set

Returns:

this builder

path

public LBCookieSessionPersistenceConfigurationDetails.Builder path(String path)

The path in which the cookie is valid. The Set-cookie header inserted by the load balancer contains a Path attribute with the specified value.

Clients include the cookie in an HTTP request only if the path portion of the request-uri matches, or is a subdirectory of, the cookie's Path attribute.

The default value is /.

Example: /example

Parameters:

path - the value to set

Returns:

this builder

maxAgeInSeconds

public LBCookieSessionPersistenceConfigurationDetails.Builder maxAgeInSeconds(Integer maxAgeInSeconds)

The amount of time the cookie remains valid. The Set-cookie header inserted by the load balancer contains a Max-Age attribute with the specified value.

The specified value must be at least one second. There is no default value for this attribute. If you do not specify a value, the load balancer does not include the Max-Age attribute in the Set-cookie header. In most cases, the client or browser retains the cookie until the current session ends, as defined by the client.

Example: 3600

Parameters:

maxAgeInSeconds - the value to set

Returns:

this builder

isSecure

public LBCookieSessionPersistenceConfigurationDetails.Builder isSecure(Boolean isSecure)

Whether the Set-cookie header should contain the Secure attribute. If true, the Set-cookie header inserted by the load balancer contains the Secure attribute, which directs the client or browser to send the cookie only using a secure protocol.

Note:** If you set this field to true, you cannot associate the corresponding backend set with an HTTP listener.

Example: true

Parameters:

isSecure - the value to set

Returns:

this builder

isHttpOnly

public LBCookieSessionPersistenceConfigurationDetails.Builder isHttpOnly(Boolean isHttpOnly)

Whether the Set-cookie header should contain the HttpOnly attribute. If true, the Set-cookie header inserted by the load balancer contains the HttpOnly attribute, which limits the scope of the cookie to HTTP requests. This attribute directs the client or browser to omit the cookie when providing access to cookies through non-HTTP APIs. For example, it restricts the cookie from JavaScript channels.

Example: true

Parameters:

isHttpOnly - the value to set

Returns:

this builder

build

public LBCookieSessionPersistenceConfigurationDetails build()

copy

public LBCookieSessionPersistenceConfigurationDetails.Builder copy(LBCookieSessionPersistenceConfigurationDetails model)