SignOn::AuthService Class Reference

Represents signon for client application. More...

#include <SignOn/AuthService>

Inheritance diagram for SignOn::AuthService:

Classes

class  IdentityRegExp
 The class represents a regular expression. More...
 

Public Types

enum  ServiceError {
  UnknownError = 1, InternalServerError = 2, InternalCommunicationError = 3, PermissionDeniedError = 4,
  AuthServiceErr = 100, MethodNotKnownError, NotAvailableError, InvalidQueryError
}
 Codes for errors that may be reported by AuthService objects. More...
 
enum  IdentityFilterCriteria { AuthMethod = 0, Username, Realm, Caption }
 Criterias for idetity query filtering. More...
 
typedef QMap
< IdentityFilterCriteria,
IdentityRegExp
IdentityFilter
 Map to hold different filtering options.
 

Signals

void error (const SignOn::Error &err)
 Emitted when an error occurs while using the AuthService. More...
 
void methodsAvailable (const QStringList &methods)
 Emitted when the list of available authentication methods have been obtained from the service. More...
 
void mechanismsAvailable (const QString &method, const QStringList &mechanisms)
 Emitted when the list of available mechanisms have been obtained from the service. More...
 
void identities (const QList< SignOn::IdentityInfo > &identityList)
 Lists identities available on the server matching query parameters. More...
 
void cleared ()
 Database is cleared and reset to initial state. More...
 

Public Member Functions

 AuthService (QObject *parent=0)
 Basic constructor. More...
 
 ~AuthService ()
 Destructor.
 
void queryMethods ()
 Requests the information on available authentication methods. More...
 
void queryMechanisms (const QString &method)
 Requests the information on mechanisms which are available for certain authentication type. More...
 
void queryIdentities (const IdentityFilter &filter=IdentityFilter())
 Requests information on identities which are stored. More...
 
void clear ()
 Clears credentials database. More...
 

Detailed Description

Represents signon for client application.

The class is for managing identities. Most applications can use this by using widgets from libSignOnUI.

Definition at line 49 of file authservice.h.

Member Enumeration Documentation

Criterias for idetity query filtering.

See Also
AuthService::queryIdentities()

Definition at line 78 of file authservice.h.

Codes for errors that may be reported by AuthService objects.

Deprecated:
This enum is deprecated. Replaced by Error::ErrorType.
Enumerator
UnknownError 

Catch-all for errors not distinguished by another code.

InternalServerError 

Signon Daemon internal error.

InternalCommunicationError 

Communication with Signon Daemon error.

PermissionDeniedError 

The operation cannot be performed due to insufficient client permissions.

MethodNotKnownError 

The method with this name is not found.

NotAvailableError 

The service is temporarily unavailable.

InvalidQueryError 

Parameters for the query are invalid.

Definition at line 62 of file authservice.h.

Constructor & Destructor Documentation

SignOn::AuthService::AuthService ( QObject *  parent = 0)

Basic constructor.

Parameters
parentParent object

Definition at line 28 of file authservice.cpp.

Member Function Documentation

void SignOn::AuthService::clear ( )

Clears credentials database.

All identity entries are removed from database. Signal cleared() is emitted when operation is completed. Error is reported by emitting signal error(). If the application does not have keychain-access credential, Error::type() is Error::PermissionDenied.

See Also
AuthService::cleared()
AuthService::error() keychain-access key-chain application can clear database.

Definition at line 58 of file authservice.cpp.

void SignOn::AuthService::cleared ( )
signal

Database is cleared and reset to initial state.

This signal is emitted in response to clear().

void SignOn::AuthService::error ( const SignOn::Error err)
signal

Emitted when an error occurs while using the AuthService.

Typical error types are generic errors, where Error::type() < Error::AuthServiceErr and AuthService specific, where Error::AuthServiceErr < Error::type() < Error::IdentityErr

See Also
SignOn::Error
SignOn::Error::ErrorType
Parameters
errThe error object
void SignOn::AuthService::identities ( const QList< SignOn::IdentityInfo > &  identityList)
signal

Lists identities available on the server matching query parameters.

This signal is emitted in response to queryIdentities().

Parameters
identityListlist of identities information
void SignOn::AuthService::mechanismsAvailable ( const QString &  method,
const QStringList &  mechanisms 
)
signal

Emitted when the list of available mechanisms have been obtained from the service.

Parameters
methodName of authentication method that was queried
mechanismsList of available mechanisms
void SignOn::AuthService::methodsAvailable ( const QStringList &  methods)
signal

Emitted when the list of available authentication methods have been obtained from the service.

Parameters
methodsList of available authentication method names
void SignOn::AuthService::queryIdentities ( const IdentityFilter filter = IdentityFilter())

Requests information on identities which are stored.

The list of identities retrieved from the service is emitted with signal identities(). Error is reported by emitting signal error(). If filter is not valid, Error::type() is Error::InvalidQuery. If the application does not have keychain-access credential, Error::type() is Error::PermissionDenied.

See Also
AuthService::identities()
AuthService::error()
Parameters
filterShows only identities specified in filter - filtering not implemented for the moment. If default parameter is passed, all the identities are returned. keychain-access key-chain application can access list of identities.

Definition at line 53 of file authservice.cpp.

void SignOn::AuthService::queryMechanisms ( const QString &  method)

Requests the information on mechanisms which are available for certain authentication type.

The list of mechanisms retrieved from the service is emitted with signal mechanismsAvailable(). Error is reported by emitting signal error(). If method is not a valid method, Error::type() is Error::MethodNotKnown.

See Also
AuthService::mechanismsAvailable()
AuthService::error()
Parameters
methodauthetication method name

Definition at line 48 of file authservice.cpp.

void SignOn::AuthService::queryMethods ( )

Requests the information on available authentication methods.

The list of service types retrieved is emitted with signal methodsAvailable(). Error is reported by emitting signal error().

See Also
AuthService::methodsAvailable()
AuthService::error()

Definition at line 43 of file authservice.cpp.


The documentation for this class was generated from the following files: