com.amazon.simplesignin.ssitoken

Interface ISSITokenGenerator<T extends SSITokenMetadata>

All Known Implementing Classes:

SSITokenV1Generator

public interface ISSITokenGenerator<T extends SSITokenMetadata>

ISSITokenGenerator defines contract for SSI token generation APIs.

Method Summary

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

Method Detail

getTokenSchema

SSITokenSchema getTokenSchema()

Returns SSITokenSchema implemented by an instance.

Returns:

SSITokenSchema.

generateToken

SSIToken generateToken(Link link,
                       ProductInfo productInfo)
                throws TokenException

Generates SSIToken for the given Link.

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

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

Bulk variant of 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.

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

SSIToken generateToken(Link link,
                       ProductInfo productInfo,
                       T tokenMetadata)
                throws TokenException

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.

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.