HttpResponse (Keycloak Docs Distribution 21.1.2 API)

All Known Implementing Classes:

HttpResponseImpl
```
public interface HttpResponse
```
Represents an out coming HTTP response.
Instances of this class can be obtained from KeycloakContext.getHttpResponse().

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addHeader(String name, String value)`	Add a value to the current list of values for the header with the given `name`.
`void`	`setCookieIfAbsent(HttpCookie cookie)`	Sets a new cookie only if not yet set.
`void`	`setHeader(String name, String value)`	Set a header.
`void`	`setStatus(int statusCode)`	Sets a status code.
`void`	`setWriteCookiesOnTransactionComplete()`	Adding cookies at the end of the transaction helps when retrying a transaction might add the cookie multiple times.

- Method Detail
  - setStatus
```
void setStatus(int statusCode)
```
    Sets a status code.
    
    Parameters:
    
    statusCode - the status code
  - addHeader
```
void addHeader(String name,
               String value)
```
    Add a value to the current list of values for the header with the given name.
    
    Parameters:
    
    name - the header name
    
    value - the header value
  - setHeader
```
void setHeader(String name,
               String value)
```
    Set a header. Any existing values will be replaced.
    
    Parameters:
    
    name - the header name
    
    value - the header value
  - setCookieIfAbsent
```
void setCookieIfAbsent(HttpCookie cookie)
```
    Sets a new cookie only if not yet set.
    
    Parameters:
    
    cookie - the cookie
  - setWriteCookiesOnTransactionComplete
```
void setWriteCookiesOnTransactionComplete()
```
    Adding cookies at the end of the transaction helps when retrying a transaction might add the cookie multiple times. In some scenarios it must not be added at the end of the transaction, as at that time the response has already been sent to the caller ("committed"), so the code needs to make a choice. As retrying transactions is the exception, adding cookies at the end of the transaction is also the exception and needs to be switched on where necessary.