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 17 package com.android.volley.toolbox; 18 19 import com.android.volley.AuthFailureError; 20 21 /** 22 * An interface for interacting with auth tokens. 23 */ 24 public interface Authenticator { 25 /** 26 * Synchronously retrieves an auth token. 27 * 28 * @throws AuthFailureError If authentication did not succeed 29 */ 30 public String getAuthToken() throws AuthFailureError; 31 32 /** 33 * Invalidates the provided auth token. 34 */ 35 public void invalidateAuthToken(String authToken); 36 } 37