Package org.wildfly.security.http
Interface HttpServerResponse
-
- All Known Implementing Classes:
HttpAuthenticator.AuthenticationExchange
public interface HttpServerResponse
Server side representation of a HTTP response.- Author:
- Darran Lofthouse
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addResponseHeader(String headerName, String headerValue)
Add the specified header and value to the end of the current response headers,boolean
forward(String path)
Forward the current request to a different path.OutputStream
getOutputStream()
Returns the output stream.void
setResponseCookie(HttpServerCookie cookie)
Sets a response cookievoid
setStatusCode(int statusCode)
Set the desired status code for the current request.
-
-
-
Method Detail
-
addResponseHeader
void addResponseHeader(String headerName, String headerValue)
Add the specified header and value to the end of the current response headers,- Parameters:
headerName
- the name of the header.headerValue
- the value of the header.
-
setStatusCode
void setStatusCode(int statusCode)
Set the desired status code for the current request. Note: If multiple mechanisms call this method then a resolution process will begin to decide which one to use.- Parameters:
statusCode
- the response code.
-
setResponseCookie
void setResponseCookie(HttpServerCookie cookie)
Sets a response cookie- Parameters:
cookie
- the cookie
-
getOutputStream
OutputStream getOutputStream()
Returns the output stream.- Returns:
- the output stream or
null
if not supported.
-
forward
boolean forward(String path)
Forward the current request to a different path.- Returns:
true
if forwarding was supported and successful,false
otherwise.
-
-