io.apptik.comm.jus.auth.TokenAuthenticator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jus-java Show documentation

Communication library for Android and Java

The newest version!

/*
 * Copyright (C) 2015 Apptik Project
 * Copyright (C) 2014 Kalin Maldzhanski
 * Copyright (C) 2011 The Android Open Source Project
 *
 * 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.apptik.comm.jus.auth;

import io.apptik.comm.jus.error.AuthError;

/**
 * An interface for interacting with auth tokens.
 */
public abstract class TokenAuthenticator implements Authenticator {

    @Override
    public String getAuthValue() throws AuthError {
        return "Bearer " + getToken();
    }

    /**
     * Synchronously retrieves an auth token.
     * It should handle refreshing the token if needed (evaluating its lifetime for example).
     * Implementations must have into consideration that this can be a
     * called from different threads at the same time.
     *
     * @throws AuthError If authentication did not succeed
     */
    abstract public String getToken() throws AuthError;

    /**
     * Invalidates the provided auth token.
     */
    abstract public void invalidateToken();
}