Authenticator.java revision 3713094c56d25e25df2a508dbee4aea869ffdea1
1/* 2 * Copyright (C) 2011 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package com.android.volley.toolbox; 18 19import com.android.volley.AuthFailureError; 20 21/** 22 * An interface for interacting with auth tokens. 23 * 24 * Authenticators can support multiple auth types by implementing {@link #getAuthToken(String)}. 25 */ 26public interface Authenticator { 27 /** 28 * Synchronously retrieves an auth token with default type. 29 * @throws AuthFailureError If authentication did not succeed 30 */ 31 public String getAuthToken() throws AuthFailureError; 32 33 /** 34 * Synchronously retrieves an auth token of the given type. 35 * 36 * If not supported, {@link UnsupportedOperationException} should be thrown. 37 * @throws AuthFailureError If authentication did not succeed 38 */ 39 public String getAuthToken(String authTokenType) throws AuthFailureError; 40 41 /** 42 * Invalidates the provided auth token. 43 */ 44 public void invalidateAuthToken(String authToken); 45} 46