LibreOffice Module ucbhelper (master) 1
Public Member Functions | Private Attributes | List of all members
ucbhelper::InteractionSupplyAuthentication Class Referencefinal

This class implements a standard interaction continuation, namely the interface XInteractionSupplyAuthentication. More...

#include <interactionrequest.hxx>

Inheritance diagram for ucbhelper::InteractionSupplyAuthentication:
[legend]
Collaboration diagram for ucbhelper::InteractionSupplyAuthentication:
[legend]

Public Member Functions

 InteractionSupplyAuthentication (InteractionRequest *pRequest, bool bCanSetRealm, bool bCanSetUserName, bool bCanSetPassword, bool bCanSetAccount, const css::uno::Sequence< css::ucb::RememberAuthentication > &rRememberPasswordModes, const css::ucb::RememberAuthentication eDefaultRememberPasswordMode, const css::uno::Sequence< css::ucb::RememberAuthentication > &rRememberAccountModes, const css::ucb::RememberAuthentication eDefaultRememberAccountMode, bool bCanUseSystemCredentials)
 Constructor. More...
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &rType) override
 
virtual void SAL_CALL acquire () noexcept override
 
virtual void SAL_CALL release () noexcept override
 
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes () override
 
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId () override
 
virtual void SAL_CALL select () override
 
virtual sal_Bool SAL_CALL canSetRealm () override
 
virtual void SAL_CALL setRealm (const OUString &Realm) override
 
virtual sal_Bool SAL_CALL canSetUserName () override
 
virtual void SAL_CALL setUserName (const OUString &UserName) override
 
virtual sal_Bool SAL_CALL canSetPassword () override
 
virtual void SAL_CALL setPassword (const OUString &Password) override
 
virtual css::uno::Sequence< css::ucb::RememberAuthentication > SAL_CALL getRememberPasswordModes (css::ucb::RememberAuthentication &Default) override
 
virtual void SAL_CALL setRememberPassword (css::ucb::RememberAuthentication Remember) override
 
virtual sal_Bool SAL_CALL canSetAccount () override
 
virtual void SAL_CALL setAccount (const OUString &Account) override
 
virtual css::uno::Sequence< css::ucb::RememberAuthentication > SAL_CALL getRememberAccountModes (css::ucb::RememberAuthentication &Default) override
 
virtual void SAL_CALL setRememberAccount (css::ucb::RememberAuthentication Remember) override
 
virtual sal_Bool SAL_CALL canUseSystemCredentials (sal_Bool &Default) override
 
virtual void SAL_CALL setUseSystemCredentials (sal_Bool UseSystemCredentials) override
 
const OUString & getRealm () const
 This method returns the realm that was supplied by the interaction handler. More...
 
const OUString & getUserName () const
 This method returns the username that was supplied by the interaction handler. More...
 
const OUString & getPassword () const
 This method returns the password that was supplied by the interaction handler. More...
 
const css::ucb::RememberAuthentication & getRememberPasswordMode () const
 This method returns the authentication remember-mode for the password that was supplied by the interaction handler. More...
 
bool getUseSystemCredentials () const
 
- Public Member Functions inherited from ucbhelper::InteractionContinuation
 InteractionContinuation (InteractionRequest *pRequest)
 
- Public Member Functions inherited from cppu::OWeakObject
 OWeakObject ()
 
 OWeakObject (const OWeakObject &)
 
OWeakObject &SAL_CALL operator= (const OWeakObject &)
 
virtual css::uno::Any SAL_CALL queryInterface (const css::uno::Type &rType) SAL_OVERRIDE
 
virtual void SAL_CALL acquire () SAL_NOEXCEPT SAL_OVERRIDE
 
virtual void SAL_CALL release () SAL_NOEXCEPT SAL_OVERRIDE
 
virtual css::uno::Reference< css::uno::XAdapter > SAL_CALL queryAdapter () SAL_OVERRIDE
 
SAL_CALL operator css::uno::Reference< css::uno::XInterface > ()
 

Private Attributes

css::uno::Sequence< css::ucb::RememberAuthentication > m_aRememberPasswordModes
 
css::uno::Sequence< css::ucb::RememberAuthentication > m_aRememberAccountModes
 
OUString m_aRealm
 
OUString m_aUserName
 
OUString m_aPassword
 
css::ucb::RememberAuthentication m_eRememberPasswordMode
 
css::ucb::RememberAuthentication m_eDefaultRememberPasswordMode
 
css::ucb::RememberAuthentication m_eDefaultRememberAccountMode
 
bool m_bCanSetRealm: 1
 
bool m_bCanSetUserName: 1
 
bool m_bCanSetPassword: 1
 
bool m_bCanSetAccount: 1
 
bool m_bCanUseSystemCredentials: 1
 
bool m_bUseSystemCredentials: 1
 

Additional Inherited Members

- Protected Member Functions inherited from ucbhelper::InteractionContinuation
void recordSelection ()
 This method marks this continuation as "selected" at the request it belongs to. More...
 
virtual ~InteractionContinuation () override
 
- Protected Member Functions inherited from cppu::OWeakObject
virtual ~OWeakObject () COVERITY_NOEXCEPT_FALSE
 
void disposeWeakConnectionPoint ()
 
- Protected Attributes inherited from cppu::OWeakObject
oslInterlockedCount m_refCount
 

Detailed Description

This class implements a standard interaction continuation, namely the interface XInteractionSupplyAuthentication.

Instances of this class can be passed along with an authentication interaction request to enable the interaction handler to supply the missing authentication data.

Definition at line 291 of file interactionrequest.hxx.

Constructor & Destructor Documentation

◆ InteractionSupplyAuthentication()

ucbhelper::InteractionSupplyAuthentication::InteractionSupplyAuthentication ( InteractionRequest pRequest,
bool  bCanSetRealm,
bool  bCanSetUserName,
bool  bCanSetPassword,
bool  bCanSetAccount,
const css::uno::Sequence< css::ucb::RememberAuthentication > &  rRememberPasswordModes,
const css::ucb::RememberAuthentication  eDefaultRememberPasswordMode,
const css::uno::Sequence< css::ucb::RememberAuthentication > &  rRememberAccountModes,
const css::ucb::RememberAuthentication  eDefaultRememberAccountMode,
bool  bCanUseSystemCredentials 
)
inline

Constructor.

Note: The remember-authentication stuff is interesting only for clients implementing own password storage functionality.

Parameters
rxRequestis the interaction request that owns this continuation.
bCanSetRealmindicates, whether the realm given with the authentication request is read-only.
bCanSetUserNameindicates, whether the username given with the authentication request is read-only.
bCanSetPasswordindicates, whether the password given with the authentication request is read-only.
bCanSetAccountindicates, whether the account given with the authentication request is read-only.
rRememberPasswordModesspecifies the authentication-remember- modes for passwords supported by the requesting client.
eDefaultRememberPasswordModespecifies the default authentication-remember-mode for passwords preferred by the requesting client.
rRememberAccountModesspecifies the authentication-remember- modes for accounts supported by the requesting client.
eDefaultRememberAccountModespecifies the default authentication-remember-mode for accounts preferred by the requesting client.
bCanUseSystemCredentialsindicates whether issuer of the authentication request can obtain and use system credentials for authentication.
See also
css::ucb::AuthenticationRequest
css::ucb::RememberAuthentication

Definition at line 453 of file interactionrequest.hxx.

Member Function Documentation

◆ acquire()

virtual void SAL_CALL ucbhelper::InteractionSupplyAuthentication::acquire ( )
inlineoverridevirtualnoexcept

Reimplemented from cppu::OWeakObject.

Definition at line 361 of file interactionrequest.hxx.

◆ canSetAccount()

sal_Bool SAL_CALL InteractionSupplyAuthentication::canSetAccount ( )
overridevirtual

Definition at line 484 of file interactionrequest.cxx.

References m_bCanSetAccount.

◆ canSetPassword()

sal_Bool SAL_CALL InteractionSupplyAuthentication::canSetPassword ( )
overridevirtual

Definition at line 445 of file interactionrequest.cxx.

References m_bCanSetPassword.

◆ canSetRealm()

sal_Bool SAL_CALL InteractionSupplyAuthentication::canSetRealm ( )
overridevirtual

Definition at line 405 of file interactionrequest.cxx.

References m_bCanSetRealm.

◆ canSetUserName()

sal_Bool SAL_CALL InteractionSupplyAuthentication::canSetUserName ( )
overridevirtual

Definition at line 425 of file interactionrequest.cxx.

References m_bCanSetUserName.

◆ canUseSystemCredentials()

sal_Bool SAL_CALL InteractionSupplyAuthentication::canUseSystemCredentials ( sal_Bool Default)
overridevirtual

Definition at line 521 of file interactionrequest.cxx.

References Default, and m_bCanUseSystemCredentials.

◆ getImplementationId()

uno::Sequence< sal_Int8 > SAL_CALL InteractionSupplyAuthentication::getImplementationId ( )
overridevirtual

Definition at line 373 of file interactionrequest.cxx.

◆ getPassword()

const OUString & ucbhelper::InteractionSupplyAuthentication::getPassword ( ) const
inline

This method returns the password that was supplied by the interaction handler.

Returns
the password.

Definition at line 437 of file interactionrequest.hxx.

References m_aPassword.

◆ getRealm()

const OUString & ucbhelper::InteractionSupplyAuthentication::getRealm ( ) const
inline

This method returns the realm that was supplied by the interaction handler.

Returns
the realm.

Definition at line 421 of file interactionrequest.hxx.

◆ getRememberAccountModes()

uno::Sequence< ucb::RememberAuthentication > SAL_CALL InteractionSupplyAuthentication::getRememberAccountModes ( css::ucb::RememberAuthentication &  Default)
overridevirtual

◆ getRememberPasswordMode()

const css::ucb::RememberAuthentication & ucbhelper::InteractionSupplyAuthentication::getRememberPasswordMode ( ) const
inline

This method returns the authentication remember-mode for the password that was supplied by the interaction handler.

Returns
the remember-mode for the password.

Definition at line 446 of file interactionrequest.hxx.

◆ getRememberPasswordModes()

uno::Sequence< ucb::RememberAuthentication > SAL_CALL InteractionSupplyAuthentication::getRememberPasswordModes ( css::ucb::RememberAuthentication &  Default)
overridevirtual

◆ getTypes()

uno::Sequence< uno::Type > SAL_CALL InteractionSupplyAuthentication::getTypes ( )
overridevirtual

Definition at line 380 of file interactionrequest.cxx.

References cppu::OTypeCollection::getTypes().

◆ getUserName()

const OUString & ucbhelper::InteractionSupplyAuthentication::getUserName ( ) const
inline

This method returns the username that was supplied by the interaction handler.

Returns
the username.

Definition at line 429 of file interactionrequest.hxx.

◆ getUseSystemCredentials()

bool ucbhelper::InteractionSupplyAuthentication::getUseSystemCredentials ( ) const
inline

Definition at line 448 of file interactionrequest.hxx.

◆ queryInterface()

uno::Any SAL_CALL InteractionSupplyAuthentication::queryInterface ( const css::uno::Type &  rType)
overridevirtual

◆ release()

virtual void SAL_CALL ucbhelper::InteractionSupplyAuthentication::release ( )
inlineoverridevirtualnoexcept

Reimplemented from cppu::OWeakObject.

Definition at line 363 of file interactionrequest.hxx.

◆ select()

void SAL_CALL InteractionSupplyAuthentication::select ( )
overridevirtual

◆ setAccount()

void SAL_CALL InteractionSupplyAuthentication::setAccount ( const OUString &  Account)
overridevirtual

Definition at line 492 of file interactionrequest.cxx.

References m_bCanSetAccount.

◆ setPassword()

void SAL_CALL InteractionSupplyAuthentication::setPassword ( const OUString &  Password)
overridevirtual

Definition at line 453 of file interactionrequest.cxx.

References m_aPassword, m_bCanSetPassword, and Password.

◆ setRealm()

void SAL_CALL InteractionSupplyAuthentication::setRealm ( const OUString &  Realm)
overridevirtual

Definition at line 413 of file interactionrequest.cxx.

References m_aRealm, m_bCanSetPassword, and m_bCanSetRealm.

◆ setRememberAccount()

void SAL_CALL InteractionSupplyAuthentication::setRememberAccount ( css::ucb::RememberAuthentication  Remember)
overridevirtual

Definition at line 510 of file interactionrequest.cxx.

◆ setRememberPassword()

void SAL_CALL InteractionSupplyAuthentication::setRememberPassword ( css::ucb::RememberAuthentication  Remember)
overridevirtual

Definition at line 475 of file interactionrequest.cxx.

References m_eRememberPasswordMode.

◆ setUserName()

void SAL_CALL InteractionSupplyAuthentication::setUserName ( const OUString &  UserName)
overridevirtual

Definition at line 433 of file interactionrequest.cxx.

References m_aUserName, and m_bCanSetUserName.

◆ setUseSystemCredentials()

void SAL_CALL InteractionSupplyAuthentication::setUseSystemCredentials ( sal_Bool  UseSystemCredentials)
overridevirtual

Definition at line 530 of file interactionrequest.cxx.

References m_bCanUseSystemCredentials, and m_bUseSystemCredentials.

Member Data Documentation

◆ m_aPassword

OUString ucbhelper::InteractionSupplyAuthentication::m_aPassword
private

Definition at line 302 of file interactionrequest.hxx.

Referenced by setPassword().

◆ m_aRealm

OUString ucbhelper::InteractionSupplyAuthentication::m_aRealm
private

Definition at line 300 of file interactionrequest.hxx.

Referenced by setRealm().

◆ m_aRememberAccountModes

css::uno::Sequence< css::ucb::RememberAuthentication > ucbhelper::InteractionSupplyAuthentication::m_aRememberAccountModes
private

Definition at line 299 of file interactionrequest.hxx.

Referenced by getRememberAccountModes().

◆ m_aRememberPasswordModes

css::uno::Sequence< css::ucb::RememberAuthentication > ucbhelper::InteractionSupplyAuthentication::m_aRememberPasswordModes
private

Definition at line 297 of file interactionrequest.hxx.

Referenced by getRememberPasswordModes().

◆ m_aUserName

OUString ucbhelper::InteractionSupplyAuthentication::m_aUserName
private

Definition at line 301 of file interactionrequest.hxx.

Referenced by setUserName().

◆ m_bCanSetAccount

bool ucbhelper::InteractionSupplyAuthentication::m_bCanSetAccount
private

Definition at line 309 of file interactionrequest.hxx.

Referenced by canSetAccount(), and setAccount().

◆ m_bCanSetPassword

bool ucbhelper::InteractionSupplyAuthentication::m_bCanSetPassword
private

Definition at line 308 of file interactionrequest.hxx.

Referenced by canSetPassword(), setPassword(), and setRealm().

◆ m_bCanSetRealm

bool ucbhelper::InteractionSupplyAuthentication::m_bCanSetRealm
private

Definition at line 306 of file interactionrequest.hxx.

Referenced by canSetRealm(), and setRealm().

◆ m_bCanSetUserName

bool ucbhelper::InteractionSupplyAuthentication::m_bCanSetUserName
private

Definition at line 307 of file interactionrequest.hxx.

Referenced by canSetUserName(), and setUserName().

◆ m_bCanUseSystemCredentials

bool ucbhelper::InteractionSupplyAuthentication::m_bCanUseSystemCredentials
private

Definition at line 310 of file interactionrequest.hxx.

Referenced by canUseSystemCredentials(), and setUseSystemCredentials().

◆ m_bUseSystemCredentials

bool ucbhelper::InteractionSupplyAuthentication::m_bUseSystemCredentials
private

Definition at line 311 of file interactionrequest.hxx.

Referenced by setUseSystemCredentials().

◆ m_eDefaultRememberAccountMode

css::ucb::RememberAuthentication ucbhelper::InteractionSupplyAuthentication::m_eDefaultRememberAccountMode
private

Definition at line 305 of file interactionrequest.hxx.

Referenced by getRememberAccountModes().

◆ m_eDefaultRememberPasswordMode

css::ucb::RememberAuthentication ucbhelper::InteractionSupplyAuthentication::m_eDefaultRememberPasswordMode
private

Definition at line 304 of file interactionrequest.hxx.

Referenced by getRememberPasswordModes().

◆ m_eRememberPasswordMode

css::ucb::RememberAuthentication ucbhelper::InteractionSupplyAuthentication::m_eRememberPasswordMode
private

Definition at line 303 of file interactionrequest.hxx.

Referenced by setRememberPassword().


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