aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/com/android/volley/toolbox/Authenticator.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com/android/volley/toolbox/Authenticator.java')
-rw-r--r--src/main/java/com/android/volley/toolbox/Authenticator.java32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/main/java/com/android/volley/toolbox/Authenticator.java b/src/main/java/com/android/volley/toolbox/Authenticator.java
new file mode 100644
index 0000000..2ba43db
--- /dev/null
+++ b/src/main/java/com/android/volley/toolbox/Authenticator.java
@@ -0,0 +1,32 @@
+/*
+ * 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 com.android.volley.toolbox;
+
+import com.android.volley.AuthFailureError;
+
+/** An interface for interacting with auth tokens. */
+public interface Authenticator {
+ /**
+ * Synchronously retrieves an auth token.
+ *
+ * @throws AuthFailureError If authentication did not succeed
+ */
+ String getAuthToken() throws AuthFailureError;
+
+ /** Invalidates the provided auth token. */
+ void invalidateAuthToken(String authToken);
+}