AccessToken

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<java.lang.String,java.lang.Object>
    - - com.simplify.payments.PaymentsMap
      - com.simplify.payments.AccessToken

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public class AccessToken
extends PaymentsMap
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
Constructor and Description

AccessToken(java.lang.String token, java.lang.String refreshToken, java.lang.Long expires)

Constructors
Constructor and Description
`AccessToken(java.lang.String token, java.lang.String refreshToken, java.lang.Long expires)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static AccessToken`	`create(Authentication authentication, java.lang.String authorizationCode, java.lang.String redirectUri)`
`static AccessToken`	`create(java.lang.String scope)` Deprecated. Please use createClientCredentials instead.
`static AccessToken`	`create(java.lang.String authorizationCode, java.lang.String redirectUri)`
`static AccessToken`	`createClientCredentials(Authentication authentication, java.lang.String scope)`
`static AccessToken`	`createClientCredentials(java.lang.String scope)` Create a ClientCredentials granted Oauth AccessToken.
`void`	`refreshToken()`
`void`	`refreshToken(Authentication authentication)`
`void`	`revokeToken()`
`void`	`revokeToken(Authentication authentication)`

Methods inherited from class com.simplify.payments.PaymentsMap
containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

AccessToken

public AccessToken(java.lang.String token,
                   java.lang.String refreshToken,
                   java.lang.Long expires)

Method Detail

refreshToken

public void refreshToken()
                  throws ApiCommunicationException,
                         AuthenticationException,
                         InvalidRequestException,
                         ObjectNotFoundException,
                         NotAllowedException,
                         SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

refreshToken

public void refreshToken(Authentication authentication)
                  throws ApiCommunicationException,
                         AuthenticationException,
                         InvalidRequestException,
                         ObjectNotFoundException,
                         NotAllowedException,
                         SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

revokeToken

public void revokeToken()
                 throws ApiCommunicationException,
                        AuthenticationException,
                        InvalidRequestException,
                        ObjectNotFoundException,
                        NotAllowedException,
                        SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

revokeToken

public void revokeToken(Authentication authentication)
                 throws ApiCommunicationException,
                        AuthenticationException,
                        InvalidRequestException,
                        ObjectNotFoundException,
                        NotAllowedException,
                        SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

create

@Deprecated
public static AccessToken create(java.lang.String scope)
                                      throws ApiCommunicationException,
                                             AuthenticationException,
                                             InvalidRequestException,
                                             ObjectNotFoundException,
                                             NotAllowedException,
                                             SystemException

Deprecated. Please use createClientCredentials instead.

Parameters:: scope -
Returns:
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

createClientCredentials

public static AccessToken createClientCredentials(java.lang.String scope)
                                           throws ApiCommunicationException,
                                                  AuthenticationException,
                                                  InvalidRequestException,
                                                  ObjectNotFoundException,
                                                  NotAllowedException,
                                                  SystemException

Create a ClientCredentials granted Oauth AccessToken. This is seldomly used and is not the same as a AuthorizationCode granted access token. You most likely don't want this method and want one of the create methods.

Parameters:: scope -
Returns:
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

createClientCredentials

public static AccessToken createClientCredentials(Authentication authentication,
                                                  java.lang.String scope)
                                           throws ApiCommunicationException,
                                                  AuthenticationException,
                                                  InvalidRequestException,
                                                  ObjectNotFoundException,
                                                  NotAllowedException,
                                                  SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

create

public static AccessToken create(java.lang.String authorizationCode,
                                 java.lang.String redirectUri)
                          throws ApiCommunicationException,
                                 AuthenticationException,
                                 InvalidRequestException,
                                 ObjectNotFoundException,
                                 NotAllowedException,
                                 SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

create

public static AccessToken create(Authentication authentication,
                                 java.lang.String authorizationCode,
                                 java.lang.String redirectUri)
                          throws ApiCommunicationException,
                                 AuthenticationException,
                                 InvalidRequestException,
                                 ObjectNotFoundException,
                                 NotAllowedException,
                                 SystemException

Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

Class AccessToken

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class com.simplify.payments.PaymentsMap

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AccessToken

Method Detail

refreshToken

refreshToken

revokeToken

revokeToken

create

createClientCredentials

createClientCredentials

create

create