Package com.cumulocity.sdk.client.messaging.notifications

Class TokenApiImpl

java.lang.Object

com.cumulocity.sdk.client.messaging.notifications.TokenApiImpl

All Implemented Interfaces:

TokenApi

public class TokenApiImpl
extends Object
implements TokenApi

Field Summary

Fields

Modifier and Type	Field	Description
static final CumulocityMediaType	TOKEN_MEDIA_TYPE
static final String	TOKEN_REQUEST_URI
static final String	UNSUBSCRIBE_REQUEST_URI

Constructor Summary

Constructors

Constructor	Description
TokenApiImpl()

Method Summary

Modifier and Type	Method	Description
Token	create(NotificationTokenRequestRepresentation tokenRequest)	Creates new access Token.
Token	refresh(Token expiredToken)	Refreshes an expired Token.
void	unsubscribe(Token token)	Unsubscribe a subscriber using supplied Token.
TokenClaims	verify(Token token)	Verifies supplied Token.

Methods inherited from class java.lang.Object

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

Field Details

TOKEN_MEDIA_TYPE

public static final CumulocityMediaType TOKEN_MEDIA_TYPE

TOKEN_REQUEST_URI

public static final String TOKEN_REQUEST_URI

See Also:

• Constant Field Values

UNSUBSCRIBE_REQUEST_URI

public static final String UNSUBSCRIBE_REQUEST_URI

See Also:

• Constant Field Values

Constructor Details

TokenApiImpl

public TokenApiImpl()

Method Details

create

public Token create(NotificationTokenRequestRepresentation tokenRequest)
             throws IllegalArgumentException,
SDKException

Description copied from interface: TokenApi

Creates new access Token.

Specified by:

create in interface TokenApi

Parameters:

tokenRequest - containing claim - subscriber, subscription and desired validity duration for the Token.

Returns:

generated Token with JWT Token string

Throws:

IllegalArgumentException - if the tokenClaim is null

SDKException - if the Token could not be created

verify

public TokenClaims verify(Token token)
                   throws SDKException

Description copied from interface: TokenApi

Verifies supplied Token.

Specified by:

verify in interface TokenApi

Parameters:

token - to be verified

Returns:

TokenClaim if the supplied Token was successfully verified

Throws:

SDKException - if the Token failed verification or could not be verified

refresh

public Token refresh(Token expiredToken)
              throws IllegalArgumentException,
SDKException

Description copied from interface: TokenApi

Refreshes an expired Token.

Specified by:

refresh in interface TokenApi

Parameters:

expiredToken - to be refreshed

Returns:

refreshed Token, valid for the same duration of time as the original Token

Throws:

IllegalArgumentException - if the supplied Token is null

SDKException - if the Token wasn't valid or the operation fails

unsubscribe

public void unsubscribe(Token token)
                 throws SDKException

Description copied from interface: TokenApi

Unsubscribe a subscriber using supplied Token.

Specified by:

unsubscribe in interface TokenApi

Throws:

SDKException