Package org.keycloak.http
Interface HttpRequest
-
- All Known Implementing Classes:
HttpRequestImpl
public interface HttpRequest
Represents an incoming HTTP request.
Instances of this class can be obtained from
KeycloakContext.getHttpRequest()
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description X509Certificate[]
getClientCertificateChain()
Returns the client X509 certificate chain when processing TLS requests.javax.ws.rs.core.MultivaluedMap<String,String>
getDecodedFormParameters()
Returns the form parameters (e.g.: media typeapplication/x-www-form-urlencoded
) as aMultivaluedMap
where the key and its correspondent value maps to the parameter name and value, respectively.javax.ws.rs.core.HttpHeaders
getHttpHeaders()
Returns the HTTP headers.String
getHttpMethod()
Returns the HTTP method.javax.ws.rs.core.MultivaluedMap<String,FormPartValue>
getMultiPartFormParameters()
Parses the parts from a multipart form request (e.g.: multipart/form-data media type).javax.ws.rs.core.UriInfo
getUri()
Returns aUriInfo
instance for the path being requested.
-
-
-
Method Detail
-
getHttpMethod
String getHttpMethod()
Returns the HTTP method.- Returns:
- the HTTP method.
-
getDecodedFormParameters
javax.ws.rs.core.MultivaluedMap<String,String> getDecodedFormParameters()
Returns the form parameters (e.g.: media type
application/x-www-form-urlencoded
) as aMultivaluedMap
where the key and its correspondent value maps to the parameter name and value, respectively.The values are already decoded using HTML form decoding.
- Returns:
- the decoded form parameters
-
getMultiPartFormParameters
javax.ws.rs.core.MultivaluedMap<String,FormPartValue> getMultiPartFormParameters()
Parses the parts from a multipart form request (e.g.: multipart/form-data media type).- Returns:
- the parts from a multipart form request
-
getHttpHeaders
javax.ws.rs.core.HttpHeaders getHttpHeaders()
Returns the HTTP headers.- Returns:
- the HTTP headers
-
getClientCertificateChain
X509Certificate[] getClientCertificateChain()
Returns the client X509 certificate chain when processing TLS requests.- Returns:
- the client certificate chain
-
getUri
javax.ws.rs.core.UriInfo getUri()
Returns aUriInfo
instance for the path being requested.- Returns:
- the
UriInfo
for the current path
-
-