Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: security :: auth :: login ::

interface XLoginContext

Base Interface
com::sun::star::uno::XInterface

Description

WARNING: this is just a draft and may be changed!

The XLoginContext interface describes a generic way to authenticate Subjects.

Callers perform login() calls providing the name of their application and a callback handler to eventually raise dialogs for user/ password input. The application name indexes into an underlying configuration of the LoginContext, which is part of the application deployment, thus separating the authentication mechanism from application logic.



Known Services which Export this Interface

com::sun::star::security::auth::login::LoginContext
com::sun::star::security::auth::login::LoginContext

Methods' Summary

login Performs the authentication and, if successful, associate principals and credentials with the authenticated subject and returns it.

Methods' Details

login
 
com::sun::star::security::auth::XSubject
login(
[ in ] string applicationName,
[ in ] com::sun::star::security::auth::callback::XCallbackHandler handler )
raises ( com::sun::star::security::auth::login::LoginException );

Description
Performs the authentication and, if successful, associate principals and credentials with the authenticated subject and returns it.
Parameter applicationName
name of application
Parameter handler
callback handler to be used for password dialogs etc.
Returns
an authenticated subject
Throws
LoginException if login failed

Top of Page