public interface RequestBuilder
Resource
based request to any Okta endpoint. Not all Okta endpoints are
implemented by this SDK currently, this interface allow to make requests with:
body
// create a resource
Resource userPasswordRequest = client.instantiate(ExtensibleResource)
userPasswordRequest.put("credentials", client.instantiate(ExtensibleResource)
.put("password", client.instantiate(ExtensibleResource)
.put("value", "aPassword1!".toCharArray())))
// make a POST request to `/api/v1/users/{userId}` and return a User resource
User result = client.getDataStore().http()
.setBody(userPasswordRequest)
.post("/api/v1/users/"+ userId, User.class)
Modifier and Type | Method and Description |
---|---|
RequestBuilder |
addHeaderParameter(java.lang.String key,
java.util.List<java.lang.String> values)
Adds a header parameter to the request builder.
|
RequestBuilder |
addHeaderParameter(java.lang.String key,
java.lang.String value)
Adds a header parameter to the request builder.
|
RequestBuilder |
addQueryParameter(java.lang.String key,
java.lang.String value)
Adds a query parameter to the request builder.
|
void |
delete(java.lang.String href)
Executes a
DELETE request. |
<T extends Resource> |
get(java.lang.String href,
java.lang.Class<T> type)
Executes a
GET request and returns a Resource. |
default void |
post(java.lang.String href)
Executes a
POST request. |
<T extends Resource> |
post(java.lang.String href,
java.lang.Class<T> type)
Executes a
POST request and returns a Resource. |
void |
put(java.lang.String href)
Executes a
PUT request and updates the resource used as the body . |
RequestBuilder |
setBody(Resource resource)
Sets the Resource body for the request.
|
RequestBuilder |
setHeaderParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerParams)
Sets the header parameters to be used for the request.
|
RequestBuilder |
setQueryParameters(java.util.Map<java.lang.String,java.lang.String> queryParams)
Sets the query parameters to be used for the request.
|
RequestBuilder setBody(Resource resource)
resource
- the request bodyRequestBuilder addQueryParameter(java.lang.String key, java.lang.String value)
key
- the query parameter field namevalue
- the query parameter field valueRequestBuilder setQueryParameters(java.util.Map<java.lang.String,java.lang.String> queryParams)
queryParams
- the query parameters to be used for the requestRequestBuilder addHeaderParameter(java.lang.String key, java.lang.String value)
key
- the header parameter field namevalue
- the header parameter field valueRequestBuilder addHeaderParameter(java.lang.String key, java.util.List<java.lang.String> values)
key
- the header parameter field namevalues
- the header parameter field valuesRequestBuilder setHeaderParameters(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerParams)
headerParams
- the header parameters to be used for the request<T extends Resource> T get(java.lang.String href, java.lang.Class<T> type)
GET
request and returns a Resource.T
- the Resource type to returnhref
- an absolute or partial HREFtype
- the Resource type to returnvoid put(java.lang.String href)
PUT
request and updates the resource used as the body
.href
- an absolute or partial HREF<T extends Resource> T post(java.lang.String href, java.lang.Class<T> type)
POST
request and returns a Resource.T
- the Resource type to returnhref
- an absolute or partial HREFtype
- the Resource type to returndefault void post(java.lang.String href)
POST
request.href
- an absolute or partial HREFvoid delete(java.lang.String href)
DELETE
request.href
- an absolute or partial HREFCopyright © 2017-2021 Okta. All Rights Reserved.