com.atlassian.oauth2.client.api.lib.token

Interface TokenService

public interface TokenService

Service for obtaining and refreshing ClientToken.

Method Summary

Modifier and Type	Method and Description
ClientToken	forceRefresh(ClientConfiguration config, ClientToken token) Refreshes provided token.
boolean	isRefreshNeeded(ClientToken token, Duration margin) Provides check to see if refresh is needed.
ClientToken	refreshIfNeeded(ClientConfiguration config, ClientToken token, Duration margin) Refreshes provided token if needed.

Method Detail

forceRefresh

ClientToken forceRefresh(ClientConfiguration config,
                         ClientToken token)
                  throws TokenServiceException,
                         IllegalArgumentException

Refreshes provided token.

Parameters:

config - OAuth client config for the given token

token - original token

Returns:

refreshed token

Throws:

TokenServiceException - if there was an error while calling token endpoint

IllegalArgumentException - if token has no refresh token

refreshIfNeeded

ClientToken refreshIfNeeded(ClientConfiguration config,
                            ClientToken token,
                            Duration margin)
                     throws TokenServiceException

Refreshes provided token if needed. For tokens without refresh token original token will be returned.

Parameters:

config - OAuth client config for the given token

token - original token

margin - max lifetime of the token that should be refreshed

Returns:

refreshed token or original token (if refresh wasn't needed)

Throws:

TokenServiceException

isRefreshNeeded

boolean isRefreshNeeded(ClientToken token,
                        Duration margin)

Provides check to see if refresh is needed. For token with no refresh token this method will always return false.

Parameters:

token - original token

margin - max lifetime of the token that should be refreshed

Returns:

whether a refresh is required