com.oracle.bmc.loadbalancer.model

Class SessionPersistenceConfigurationDetails

java.lang.Object

com.oracle.bmc.loadbalancer.model.SessionPersistenceConfigurationDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170115")
public final class SessionPersistenceConfigurationDetails
extends Object

The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).

Session persistence enables the Load Balancing service to direct any number of 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).

With application cookie stickiness, the load balancer enables session persistence only when the response from a backend application server includes a `Set-cookie` header with the user-specified cookie name.

To disable application cookie stickiness on a running load balancer, use the updateBackendSet operation and specify `null` for the `SessionPersistenceConfigurationDetails` object.

Example: `SessionPersistenceConfigurationDetails: 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 SessionPersistenceConfigurationDetails.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 SessionPersistenceConfigurationDetails.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionPersistenceConfigurationDetails.Builder

Constructor Summary

Constructors

Constructor and Description
SessionPersistenceConfigurationDetails(String cookieName, Boolean disableFallback) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SessionPersistenceConfigurationDetails.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCookieName() The name of the cookie used to detect a session initiated by the backend server.
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.
int	hashCode()
SessionPersistenceConfigurationDetails.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionPersistenceConfigurationDetails

@ConstructorProperties(value={"cookieName","disableFallback"})
 @Deprecated
public SessionPersistenceConfigurationDetails(String cookieName,
                                                                                                                          Boolean disableFallback)

Deprecated.

Method Detail

builder

public static SessionPersistenceConfigurationDetails.Builder builder()

Create a new builder.

toBuilder

public SessionPersistenceConfigurationDetails.Builder toBuilder()

getCookieName

public String getCookieName()

The name of the cookie used to detect a session initiated by the backend server. Use ‘*’ to specify that any cookie set by the backend causes the session to persist.

Example: `example_cookie`

getDisableFallback

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`

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object