Exchange (PingAccess Addon SDK)

```
public interface Exchange
```
The Exchange represents a request / response.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Instant`	`getCreationTime()` Gets the time the `Exchange` was created.
`Identity`	`getIdentity()` Returns the user identity or null if no identity is associated with the Exchange.
`String`	`getOriginalRequestUri()` The Request URI provided in the Request's start line.
`PolicyConfiguration`	`getPolicyConfiguration()` Returns the `PolicyConfiguration` containing details about the policy configuration for the current Exchange
`<T> Optional<T>`	`getProperty(ExchangeProperty<T> property)` Retrieves a property from this exchange.
`Request`	`getRequest()` Gets the Request Object.
`<T> T`	`getRequiredProperty(ExchangeProperty<T> property)` Retrieves a property from this exchange, throwing an unchecked exception if no value is present.
`Locale`	`getResolvedLocale()` Get the resolved Locale of the request, as determined by the `LocaleOverrideService` and the request data.
`Response`	`getResponse()` Gets the response.
`String`	`getSourceIp()` The source IP address for the socket over which the `Request` was received.
`SslData`	`getSslData()` Returns SslData from the SSL/TLS connection.
`List<TargetHost>`	`getTargetHosts()`
`String`	`getTargetScheme()`
`String`	`getUserAgentHost()` Returns the value of the Host header field from the HTTP request sent by the user agent, as determined by the PingAccess HTTP requests configuration and the `Request` data.
`String`	`getUserAgentIp()` Returns the IP of the user agent, as determined by the PingAccess HTTP requests configuration and the `Request` data.
`String`	`getUserAgentProtocol()` Returns the protocol used by the user agent to initiate the associated `Request`, as determined by the PingAccess HTTP requests configuration and the `Request` data.
`default boolean`	`isPropertyTrue(ExchangeProperty<Boolean> property)` Determines if a boolean property is set to `true`.
`default void`	`removeProperty(ExchangeProperty<?> property)` Removes a property from this exchange, which is equivalent to setting the property to a null value.
`<T> void`	`setProperty(ExchangeProperty<T> property, T value)` Stores a property in this exchange.
`void`	`setRequest(Request req)` Sets the Request.
`void`	`setResponse(Response res)` Sets the `Response` on this `Exchange`.

- Method Detail
  - getIdentity
```
Identity getIdentity()
```
    Returns the user identity or null if no identity is associated with the Exchange.
    
    Returns:
    
    the user Identity
  - getSslData
```
SslData getSslData()
```
    Returns SslData from the SSL/TLS connection.
    
    Returns:
    
    SslData
  - getRequest
```
Request getRequest()
```
    Gets the Request Object.
    
    Returns:
    
    Request
  - setRequest
```
void setRequest(Request req)
```
    Sets the Request.
    
    Parameters:
    
    req - Request
  - getResponse
```
Response getResponse()
```
    Gets the response.
    
    Returns:
    
    Response
  - setResponse
```
void setResponse(Response res)
```
    Sets the Response on this Exchange. If a response is already set for this exchange, its body will be read/consumed and discarded.
    
    Parameters:
    
    res - Response.
    
    Throws:
    
    IllegalArgumentException - if the specified Response was not created with a ResponseBuilder provided by the SDK. See ResponseBuilder.newInstance(HttpStatus).
  - getCreationTime
```
Instant getCreationTime()
```
    Gets the time the Exchange was created.
    
    Returns:
    
    the time the Exchange was created.
  - getProperty
```
<T> Optional<T> getProperty(ExchangeProperty<T> property)
```
    Retrieves a property from this exchange.
    
    Type Parameters:
    
    T - the value type of the property to be retrieved
    
    Parameters:
    
    property - the property (key) to be retrieved
    
    Returns:
    
    the property value, or an empty Optional if no value is present
  - getRequiredProperty
```
<T> T getRequiredProperty(ExchangeProperty<T> property)
```
    Retrieves a property from this exchange, throwing an unchecked exception if no value is present.
    
    Type Parameters:
    
    T - the value type of the property to be retrieved
    
    Parameters:
    
    property - the property (key) to be retrieved
    
    Returns:
    
    the property value
    
    Throws:
    
    IllegalStateException - if the required property is not set
  - isPropertyTrue
```
default boolean isPropertyTrue(ExchangeProperty<Boolean> property)
```
    Determines if a boolean property is set to true.
    
    Parameters:
    
    property - the property (key) to be retrieved/checked
    
    Returns:
    
    true if the specified property is set and has a value of Boolean.TRUE
  - setProperty
```
<T> void setProperty(ExchangeProperty<T> property,
                     T value)
```
    Stores a property in this exchange.
    
    Type Parameters:
    
    T - the value type of the property
    
    Parameters:
    
    property - the property (key) to be stored
    
    value - the property value (may be null)
  - removeProperty
```
default void removeProperty(ExchangeProperty<?> property)
```
    Removes a property from this exchange, which is equivalent to setting the property to a null value.
    
    Parameters:
    
    property - the property (key) to be removed
  - getOriginalRequestUri
```
String getOriginalRequestUri()
```
    The Request URI provided in the Request's start line.
    
    Returns:
    
    The request URI
  - getTargetHosts
```
List<TargetHost> getTargetHosts()
```
    Returns:
    
    an unmodifiable list of hostname:port combinations for the site which will handle the request.
  - getTargetScheme
```
String getTargetScheme()
```
    Returns:
    
    the scheme for the site which will handle the Request, or null if the target for Request has not been determined yet. The returned String (when non-null) will be either "http" or "https".
  - getSourceIp
```
String getSourceIp()
```
    The source IP address for the socket over which the Request was received.
    
    Returns:
    
    the source IP
  - getUserAgentIp
```
String getUserAgentIp()
```
    Returns the IP of the user agent, as determined by the PingAccess HTTP requests configuration and the Request data.
    
    Returns:
    
    The user agent address or null if the address cannot be resolved.
  - getUserAgentHost
```
String getUserAgentHost()
```
    Returns the value of the Host header field from the HTTP request sent by the user agent, as determined by the PingAccess HTTP requests configuration and the Request data. For example, if the user agent used a URL of https://example.com:8443, this method is expected to return "example.com:8443". The actual value can vary depending on the PingAccess HTTP requests configuration.
    
    Returns:
    
    the value of the Host header field from the HTTP request sent by the user agent
  - getUserAgentProtocol
```
String getUserAgentProtocol()
```
    Returns the protocol used by the user agent to initiate the associated Request, as determined by the PingAccess HTTP requests configuration and the Request data. For example, if the user agent used HTTPS, this method is expected to return "https". The actual value can vary depending on the PingAccess HTTP requests configuration.
    
    Returns:
    
    the protocol used by the user agent to initiate the associated Request.
  - getResolvedLocale
```
Locale getResolvedLocale()
```
    Get the resolved Locale of the request, as determined by the LocaleOverrideService and the request data.
    The provided default LocaleOverrideService will first look for the 'ping-accept-language' cookie to resolve the locale. This behavior can be overridden by implementing a custom LocaleOverrideService.
    
    If the LocaleOverrideService getLocale() method returns null, the Locale will be resolved from the Accept-Language header in the request. As a fallback, the ROOT (undefined) Locale will be returned.
    
    Returns:
    
    The resolved locale of the request
  - getPolicyConfiguration
```
PolicyConfiguration getPolicyConfiguration()
```
    Returns the PolicyConfiguration containing details about the policy configuration for the current Exchange
    
    Returns:
    
    policy details for the current Exchange

Interface Exchange

Method Summary

Method Detail

getIdentity

getSslData

getRequest

setRequest

getResponse

setResponse

getCreationTime

getProperty

getRequiredProperty

isPropertyTrue

setProperty

removeProperty

getOriginalRequestUri

getTargetHosts

getTargetScheme

getSourceIp

getUserAgentIp

getUserAgentHost

getUserAgentProtocol

getResolvedLocale

getPolicyConfiguration