io.personium.common.auth.token.PasswordChangeAccessToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of personium-lib-common Show documentation
Common libraries used in personium-core module and personium-engine module.
The newest version!
/**
 * Personium
 * Copyright 2014-2022 Personium Project Authors
 * - FUJITSU LIMITED
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.personium.common.auth.token;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Class for generating / parsing account password change access Token.
 */
public final class PasswordChangeAccessToken extends AbstractLocalAccessToken {

    static Logger log = LoggerFactory.getLogger(PasswordChangeAccessToken.class);

    /** Token prefix. */
    public static final String PREFIX_ACCESS = "AP~";


    /**
     * constructor.
     * Set an explicit validity period to generate a token.
     *
     * @param issuedAt Issued at(UNIXtime)
     * @param lifespan Lifespan(msec)
     * @param issuer Issuer
     * @param subject Subject
     * @param schema Schema
     * @param scope scopes in the form of String array
     */
    public PasswordChangeAccessToken(final long issuedAt, final long lifespan, final String issuer,
            final String subject, final String schema, final String[] scope) {
        super(issuedAt, lifespan, issuer, subject, schema, scope);
    }

    /**
     * constructor.
     * Set the validity period of the default value to generate a token.
     *
     * @param issuedAt Issued at(UNIXtime)
     * @param issuer Issuer
     * @param subject Subject
     * @param schema Schema
     * @param scope scopes in the form of String array
     */
    public PasswordChangeAccessToken(final long issuedAt, final String issuer, final String subject,
            final String schema, final String[] scope) {
        this(issuedAt, ACCESS_TOKEN_EXPIRES_MILLISECS, issuer, subject, schema, scope);
    }

    public PasswordChangeAccessToken() {
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toTokenString() {
        StringBuilder ret = new StringBuilder(PREFIX_ACCESS);
        ret.append(this.doCreateTokenString(null));
        return ret.toString();
    }

    /**
     * parse a given token string as a Cell specified with the issuer parameter.
     * @param token Token String
     * @param issuer Cell Root URL
     * @return token object
     * @throws AbstractOAuth2Token.TokenParseException when failed to parse the string
     */
    public static PasswordChangeAccessToken parse(final String token, final String issuer)
            throws AbstractOAuth2Token.TokenParseException {
        if (!token.startsWith(PREFIX_ACCESS) || issuer == null) {
            throw AbstractOAuth2Token.PARSE_EXCEPTION;
        }
        PasswordChangeAccessToken ret = new PasswordChangeAccessToken();
        ret.populate(token.substring(PREFIX_ACCESS.length()), issuer, 0);
        return ret;
    }

    @Override
    public String getTarget() {
        return null;
    }

    @Override
    int getType() {
        return AbstractLocalToken.Type.AccessToken.PASSWORDCHANGE;
    }
}