• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
AuthState Class Reference

This class provides detailed information about the state of the authentication process. More...

Description

Author
Oleg Kalnichevski
Since
4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 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.
 */

Public Member Functions

 AuthState ()
 Default constructor.
 
void invalidate ()
 Invalidates the authentication state by resetting its parameters.
 
void setAuthScheme (final AuthScheme authScheme)
 Assigns the given authentication scheme . More...
 
AuthScheme getAuthScheme ()
 Returns the authentication scheme . More...
 
Credentials getCredentials ()
 Returns user com.good.gd.apache.http.auth.Credentials selected for authentication if available. More...
 
void setCredentials (final Credentials credentials)
 Sets user com.good.gd.apache.http.auth.Credentials to be used for authentication. More...
 
AuthScope getAuthScope ()
 Returns actual com.good.gd.apache.http.auth.AuthScope if available. More...
 
void setAuthScope (final AuthScope authScope)
 Sets actual com.good.gd.apache.http.auth.AuthScope. More...
 

Member Function Documentation

◆ setAuthScheme()

void setAuthScheme ( final AuthScheme  authScheme)
Parameters
authSchemethe authentication scheme

◆ getAuthScheme()

AuthScheme getAuthScheme ( )

◆ getCredentials()

Credentials getCredentials ( )
Returns
user credentials if available, null otherwise

◆ setCredentials()

void setCredentials ( final Credentials  credentials)
Parameters
credentialsUser credentials

◆ getAuthScope()

AuthScope getAuthScope ( )
Returns
actual authentication scope if available, null otherwise

◆ setAuthScope()

void setAuthScope ( final AuthScope  authScope)
Parameters
authScopeAuthentication scope