Class AuthenticationApi.Refresh

java.lang.Object

de.xima.fc.api.rest.pub.client.security.ApiCall<AuthenticationApi.Refresh>

de.xima.fc.api.rest.pub.client.security.EndpointCategoryCall<AuthenticationApi.Refresh>

de.xima.fc.api.rest.pub.client.security.api.AuthenticationApi.Refresh

Enclosing class:

AuthenticationApi

public final class AuthenticationApi.Refresh
extends EndpointCategoryCall<AuthenticationApi.Refresh>

Handler for the refresh API method that lets you choose the content type via the Accept header.

Field Summary

Fields inherited from class ApiCall

accept, apiCallInterceptor, authentications, authNames, body, cookieParams, headerParams, method, path, properties, queryParams, returnTypes

Method Summary

Modifier and Type	Method	Description
Class<? extends EndpointCategory>	endpointCategory()
ApiInvocation<AuthenticationTokenResponse>	requestJson()	Calls the API with the Accept header set to application/json; charset=utf-8.
ApiInvocation<AuthenticationTokenResponse>	requestJson_v1_0()	Calls the API with the Accept header set to application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8.
protected AuthenticationApi.Refresh	self()

Methods inherited from class ApiCall

accept, accept, apiCallInterceptor, apiCallInterceptor, authentication, authentications, authentications, authNames, authNames, body, body, body, cookieParam, cookieParams, cookieParams, headerParam, headerParams, headerParams, method, method, path, path, properties, properties, property, queryParam, queryParams, queryParams, returnTypes, returnTypes

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

self

protected AuthenticationApi.Refresh self()

Specified by:

self in class ApiCall<AuthenticationApi.Refresh>

endpointCategory

public Class<? extends EndpointCategory> endpointCategory()

Specified by:

endpointCategory in class EndpointCategoryCall<AuthenticationApi.Refresh>

Returns:

The endpoint category that created this API call.

requestJson

public ApiInvocation<AuthenticationTokenResponse> requestJson()

Calls the API with the Accept header set to application/json; charset=utf-8.

Refreshes an access token. Refreshes an access token with a refresh token. Also returns a new refresh token.

Status codes that may be returned by this API call:

• 200 - An JSON with access and refresh token and necessary metadata after successful refresh.

Returns:

A completion stage that resolves with the data returned by the API.

requestJson_v1_0

public ApiInvocation<AuthenticationTokenResponse> requestJson_v1_0()

Calls the API with the Accept header set to application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8.

Refreshes an access token. Refreshes an access token with a refresh token. Also returns a new refresh token.

Status codes that may be returned by this API call:

• 200 - An JSON with access and refresh token and necessary metadata after successful refresh.

Returns:

A completion stage that resolves with the data returned by the API.