@Generated(value="OracleSDKGenerator",
comments="API Version: 20170115")
public final class LBCookieSessionPersistenceConfigurationDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The configuration details for implementing load balancer cookie session persistence (LB cookie stickiness).
Session persistence enables the Load Balancing service to direct all requests that originate from a single logical client to a single backend web server. For more information, see [Session Persistence](https://docs.cloud.oracle.com/Content/Balance/Reference/sessionpersistence.htm).
When you configure LB cookie stickiness, the load balancer inserts a cookie into the response. The parameters configured in the cookie enable session stickiness. This method is useful when you have applications and Web backend services that cannot generate their own cookies.
Path route rules take precedence to determine the target backend server. The load balancer verifies that session stickiness is enabled for the backend server and that the cookie configuration (domain, path, and cookie hash) is valid for the target. The system ignores invalid cookies.
To disable LB cookie stickiness on a running load balancer, use the updateBackendSet operation and specify null
for the LBCookieSessionPersistenceConfigurationDetails object.
Example: LBCookieSessionPersistenceConfigurationDetails: null
*Note:** SessionPersistenceConfigurationDetails (application cookie stickiness) and
LBCookieSessionPersistenceConfigurationDetails (LB cookie stickiness) are mutually
exclusive. An error results if you try to enable both types of session persistence.
*Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
Note: Objects should always be created or deserialized using the LBCookieSessionPersistenceConfigurationDetails.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the LBCookieSessionPersistenceConfigurationDetails.Builder, which maintain a
set of all explicitly set fields called LBCookieSessionPersistenceConfigurationDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
LBCookieSessionPersistenceConfigurationDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
LBCookieSessionPersistenceConfigurationDetails(String cookieName,
Boolean disableFallback,
String domain,
String path,
Integer maxAgeInSeconds,
Boolean isSecure,
Boolean isHttpOnly)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static LBCookieSessionPersistenceConfigurationDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCookieName()
The name of the cookie inserted by the load balancer.
|
Boolean |
getDisableFallback()
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.
|
String |
getDomain()
The domain in which the cookie is valid.
|
Boolean |
getIsHttpOnly()
Whether the
Set-cookie header should contain the HttpOnly attribute. |
Boolean |
getIsSecure()
Whether the
Set-cookie header should contain the Secure attribute. |
Integer |
getMaxAgeInSeconds()
The amount of time the cookie remains valid.
|
String |
getPath()
The path in which the cookie is valid.
|
int |
hashCode() |
LBCookieSessionPersistenceConfigurationDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"cookieName","disableFallback","domain","path","maxAgeInSeconds","isSecure","isHttpOnly"}) public LBCookieSessionPersistenceConfigurationDetails(String cookieName, Boolean disableFallback, String domain, String path, Integer maxAgeInSeconds, Boolean isSecure, Boolean isHttpOnly)
public static LBCookieSessionPersistenceConfigurationDetails.Builder builder()
Create a new builder.
public LBCookieSessionPersistenceConfigurationDetails.Builder toBuilder()
public String getCookieName()
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.
public Boolean getDisableFallback()
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
public String getDomain()
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
public String getPath()
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
public Integer getMaxAgeInSeconds()
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
public Boolean getIsSecure()
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
public Boolean getIsHttpOnly()
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
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.