SetCookie (PingAccess Addon SDK)

java.lang.Object
- com.pingidentity.pa.sdk.http.SetCookie

```
public final class SetCookie
extends Object
```
A utility class used to create a SetCookie header

Constructor Summary

Constructors
Constructor and Description

SetCookie()

Constructors
Constructor and Description
`SetCookie()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SetCookie`	`domain(String domain)` Sets the domain
`boolean`	`equals(Object o)` Two `SetCookie` objects are equal if their `toString()` representations are equal
`SetCookie`	`expired()` Expires the cookie
`SetCookie`	`expiresAt(Instant expiresAt)` Sets the cookie's expiresAt value, overriding any set previously via `expiresAtRawStr(String)`.
`SetCookie`	`expiresAtRawStr(String expiresAtRawStr)` Sets the cookie's expiresAt value to the specified raw date/time string.
`String`	`getDomain()` Retrieves the domain
`String`	`getName()` Retrieves the Name
`String`	`getPath()` Retrieves the path
`String`	`getSameSite()` Retrieves the SameSite cookie attribute value
`String`	`getValue()` Retrieves the value
`int`	`hashCode()`
`SetCookie`	`httpOnly()` Sets the HttpOnly flag to true
`SetCookie`	`httpOnly(boolean httpOnly)` Sets the HttpOnly flag
`boolean`	`isHttpOnly()` Retrieves the HttpOnly flag
`boolean`	`isSecure()` Retrieves the Secure flag
`SetCookie`	`maxAge(long duration, TimeUnit unit)` Sets the cookie's MaxAge The duration value has second granularity
`SetCookie`	`name(String name)` Sets the Name
`SetCookie`	`path(String path)` Sets the path
`SetCookie`	`sameSite(String sameSite)` Sets the SameSite cookie attribute value
`SetCookie`	`secure()` Sets the Secure flag to true
`SetCookie`	`secure(boolean secure)` Sets the Secure flag
`HeaderField`	`toHeaderField()` Method to convert this to a HeaderField.
`String`	`toString()`
`SetCookie`	`value(String value)` Sets the value

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SetCookie
```
public SetCookie()
```
- Method Detail
  - getName
```
public String getName()
```
    Retrieves the Name
    
    Returns:
    
    the name
  - name
```
public SetCookie name(String name)
```
    Sets the Name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this SetCookie instance
  - getValue
```
public String getValue()
```
    Retrieves the value
    
    Returns:
    
    the value
  - value
```
public SetCookie value(String value)
```
    Sets the value
    
    Parameters:
    
    value - the value
    
    Returns:
    
    this SetCookie instance
  - getPath
```
public String getPath()
```
    Retrieves the path
    
    Returns:
    
    the path
  - path
```
public SetCookie path(String path)
```
    Sets the path
    
    Parameters:
    
    path - the path
    
    Returns:
    
    this SetCookie instance
  - getDomain
```
public String getDomain()
```
    Retrieves the domain
    
    Returns:
    
    the domain
  - domain
```
public SetCookie domain(String domain)
```
    Sets the domain
    
    Parameters:
    
    domain - the domain
    
    Returns:
    
    this SetCookie instance
  - getSameSite
```
public String getSameSite()
```
    Retrieves the SameSite cookie attribute value
    
    Returns:
    
    the SameSite value
  - sameSite
```
public SetCookie sameSite(String sameSite)
```
    Sets the SameSite cookie attribute value
    
    Parameters:
    
    sameSite - the SameSite value
    
    Returns:
    
    this SetCookie instance
  - httpOnly
```
public SetCookie httpOnly(boolean httpOnly)
```
    Sets the HttpOnly flag
    
    Parameters:
    
    httpOnly - the HttpOnly flag
    
    Returns:
    
    this SetCookie instance
  - isHttpOnly
```
public boolean isHttpOnly()
```
    Retrieves the HttpOnly flag
    
    Returns:
    
    the HttpOnly flag
  - httpOnly
```
public SetCookie httpOnly()
```
    Sets the HttpOnly flag to true
    
    Returns:
    
    this SetCookie instance
  - secure
```
public SetCookie secure(boolean secure)
```
    Sets the Secure flag
    
    Parameters:
    
    secure - true if secure
    
    Returns:
    
    this SetCookie instance
  - secure
```
public SetCookie secure()
```
    Sets the Secure flag to true
    
    Returns:
    
    this SetCookie instance
  - isSecure
```
public boolean isSecure()
```
    Retrieves the Secure flag
    
    Returns:
    
    true if secure
  - maxAge
```
public SetCookie maxAge(long duration,
                        TimeUnit unit)
```
    Sets the cookie's MaxAge The duration value has second granularity
    
    Parameters:
    
    duration - the duration
    
    unit - the TimeUnit
    
    Returns:
    
    this SetCookie instance
  - expiresAt
```
public SetCookie expiresAt(Instant expiresAt)
```
    Sets the cookie's expiresAt value, overriding any set previously via expiresAtRawStr(String).
    
    Parameters:
    
    expiresAt - the time when cookie expires
    
    Returns:
    
    this SetCookie instance
  - expiresAtRawStr
```
public SetCookie expiresAtRawStr(String expiresAtRawStr)
```
    Sets the cookie's expiresAt value to the specified raw date/time string. No validation is performed, and the value will override any set previously via expiresAt(Instant).
    
    Parameters:
    
    expiresAtRawStr - the time when cookie expires
    
    Returns:
    
    this SetCookie instance
  - expired
```
public SetCookie expired()
```
    Expires the cookie
    
    Returns:
    
    this SetCookie instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Two SetCookie objects are equal if their toString() representations are equal
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to compare
    
    Returns:
    
    true if the object is equal to this SetCookie
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toHeaderField
```
public HeaderField toHeaderField()
```
    Method to convert this to a HeaderField.
    
    Returns:
    
    this SetCookie converted into a HeaderField

Class SetCookie

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SetCookie

Method Detail

getName

name

getValue

value

getPath

path

getDomain

domain

getSameSite

sameSite

httpOnly

isHttpOnly

httpOnly

secure

secure

isSecure

maxAge

expiresAt

expiresAtRawStr

expired

toString

equals

hashCode

toHeaderField