Authenticator.java

/*
 * Copyright (C) 2014 Neal
 *
 * 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 neal.http.base;

/**
 * Created by Neal on 2014/10/28.
 */

import neal.http.impl.HttpErrorCollection;

/**
 * An interface for interacting with auth tokens.
 */
public interface Authenticator {

    /**
     * Synchronously retrieves an auth token.
     *
     * @throws neal.http.impl.HttpErrorCollection.AuthFailureError If authentication did not succeed
     */
    public String getAuthToken() throws HttpErrorCollection.AuthFailureError;

    /**
     * Invalidates the provided auth token.
     */
    public void invalidateAuthToken(String authToken);
}