com.amazon.simplesignin.ssitoken

Class SSITokenV1Generator

java.lang.Object

com.amazon.simplesignin.ssitoken.SSITokenV1Generator

All Implemented Interfaces:

ISSITokenGenerator<SSITokenV1Metadata>

public class SSITokenV1Generator
extends Object
implements ISSITokenGenerator<SSITokenV1Metadata>

Generates SSITokens following the schema "SSI-1.0" in which SSIToken is encoded as a JSON Web Token (JWT). See https://jwt.io/introduction/.

Constructor Summary

Constructors

Constructor and Description
SSITokenV1Generator()

Method Summary

Modifier and Type	Method and Description
SSIToken	generateToken(@NonNull Link link, @NonNull ProductInfo productInfo) Generates SSIToken for the given Link.
SSIToken	generateToken(@NonNull Link link, @NonNull ProductInfo productInfo, @NonNull SSITokenV1Metadata tokenMetadata) Generates SSIToken for the given Link using the values supplied explicitly by the caller for token metadata fields.
Map<String,SSIToken>	generateTokens(@NonNull List<Link> links, @NonNull ProductInfo productInfo) Bulk variant of ISSITokenGenerator.generateToken(Link, ProductInfo) method which supports generation of SSITokens for multiple links.
SSITokenSchema	getTokenSchema() Returns SSITokenSchema implemented by an instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSITokenV1Generator

public SSITokenV1Generator()

Method Detail

getTokenSchema

public SSITokenSchema getTokenSchema()

Description copied from interface: ISSITokenGenerator

Returns SSITokenSchema implemented by an instance.

Specified by:

getTokenSchema in interface ISSITokenGenerator<SSITokenV1Metadata>

Returns:

SSITokenSchema.

generateToken

public SSIToken generateToken(@NonNull
                              @NonNull Link link,
                              @NonNull
                              @NonNull ProductInfo productInfo)
                       throws TokenException

Description copied from interface: ISSITokenGenerator

Generates SSIToken for the given Link.

Specified by:

generateToken in interface ISSITokenGenerator<SSITokenV1Metadata>

Parameters:

link - Link object to generate SSIToken for.

productInfo - ProductInfo object that identifies the target application.

Returns:

SSIToken.

Throws:

TokenException - is thrown to indicate unexpected errors encountered while generating token.

generateTokens

public Map<String,SSIToken> generateTokens(@NonNull
                                           @NonNull List<Link> links,
                                           @NonNull
                                           @NonNull ProductInfo productInfo)
                                    throws TokenException

Description copied from interface: ISSITokenGenerator

Bulk variant of ISSITokenGenerator.generateToken(Link, ProductInfo) method which supports generation of SSITokens for multiple links.

The operation is considered to be a failure in entirety even if SSIToken generation fails for a single Link in the batch.

Specified by:

generateTokens in interface ISSITokenGenerator<SSITokenV1Metadata>

Parameters:

links - Collection of Link objects to generate SSITokens for. All links passed in the input are expected to belong to the same Amazon user and the linked partner user accounts must all belong to the same identity provider.

productInfo - ProductInfo object that identifies the target application.

Returns:

Map of linkId to SSIToken generated for the corresponding Link.

Throws:

TokenException - is thrown to indicate unexpected errors encountered while generating token.

generateToken

public SSIToken generateToken(@NonNull
                              @NonNull Link link,
                              @NonNull
                              @NonNull ProductInfo productInfo,
                              @NonNull
                              @NonNull SSITokenV1Metadata tokenMetadata)
                       throws TokenException

Description copied from interface: ISSITokenGenerator

Generates SSIToken for the given Link using the values supplied explicitly by the caller for token metadata fields.

At this point, with "SSI-1.0" being the only supported token schema, this method is expected to be used for testing purpose only, for eg: to generate a token with expiration time in the past.

Specified by:

generateToken in interface ISSITokenGenerator<SSITokenV1Metadata>

Parameters:

link - Link object to generate SSIToken for.

productInfo - ProductInfo object that identifies the target application.

tokenMetadata - SSITokenMetadata object holding custom values to use for token metadata fields.

Returns:

SSIToken.

Throws:

TokenException - is thrown to indicate unexpected errors encountered while generating token.