com.amazonaws.mobileconnectors.cognitoidentityprovider.tokens.CognitoIdToken Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-android-sdk-cognitoidentityprovider Show documentation

The AWS Android SDK for Amazon Cognito Identity Provider module holds the client classes that are used for communicating with Amazon Cognito Identity Provider Service

There is a newer version: 2.79.0

Show newest version

/*
 * Copyright 2013-2016 Amazon.com,
 * Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Amazon Software License (the "License").
 * You may not use this file except in compliance with the
 * License. A copy of the License is located at
 *
 *     http://aws.amazon.com/asl/
 *
 * or in the "license" file accompanying this file. This file is
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, express or implied. See the License
 * for the specific language governing permissions and
 * limitations under the License.
 */

package com.amazonaws.mobileconnectors.cognitoidentityprovider.tokens;

import com.amazonaws.mobileconnectors.cognitoidentityprovider.exceptions.CognitoInternalErrorException;
import com.amazonaws.mobileconnectors.cognitoidentityprovider.util.CognitoJWTParser;

import java.util.Date;

/**
 * Represents an id-token and provides methods to read token claims.
 */
public class CognitoIdToken extends CognitoUserToken {

    /**
     * Create a new id token.
     *
     * @param jwtToken      REQUIRED: Valid JWT as a String.
     */
    public CognitoIdToken(String jwtToken) {
        super(jwtToken);
    }

    /**
     * Returns the id token formatted as JWT.
     *
     * @return
     */
    public String getJWTToken() {
        return super.getToken();
    }

    /**
     * Returns expiration of this id token.
     *
     * @return id token expiration claim as {@link java.util.Date} in UTC.
     */
    public Date getExpiration() {
        try {
            String claim = CognitoJWTParser.getClaim(super.getToken(), "exp");
            if (claim == null) {
                return null;
            }
            long epocTimeSec = Long.parseLong(claim);
            long epocTimeMilliSec = epocTimeSec*1000;
            return new Date(epocTimeMilliSec);
        } catch(Exception e) {
            throw new CognitoInternalErrorException(e.getMessage(), e);
        }
    }

    /**
     * Returns "not before" claim of this id token
     *
     * @return not before claim as {@link java.util.Date} in UTC.
     */
    public Date getNotBefore() {
        try{
            String claim = CognitoJWTParser.getClaim(super.getToken(), "nbf");
            if (claim == null) {
                return null;
            }
            long epocTimeSec = Long.parseLong(claim);
            long epocTimeMilliSec = epocTimeSec*1000;
            return new Date(epocTimeMilliSec);
        } catch(Exception e) {
            throw new CognitoInternalErrorException(e.getMessage(), e);
        }
    }

    /**
     * Returns "issued at" claim of this id token
     *
     * @return issue at claim as {@link java.util.Date} in UTC.
     */
    public Date getIssuedAt() {
        try{
            String claim = CognitoJWTParser.getClaim(super.getToken(), "iat");
            if (claim == null) {
                return null;
            }
            long epocTimeSec = Long.parseLong(claim);
            long epocTimeMilliSec = epocTimeSec*1000;
            return new Date(epocTimeMilliSec);
        } catch(Exception e) {
            throw new CognitoInternalErrorException(e.getMessage(), e);
        }
    }
}