LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XSSOInitiatorContext Interface Referencepublished

represents an initiator side security context. More...

import"XSSOInitiatorContext.idl";

Inheritance diagram for XSSOInitiatorContext:
XSSOContext XInterface

Public Member Functions

sequence< byte > init ([in] sequence< byte > Token) raises ( InvalidArgumentException, InvalidCredentialException, InvalidContextException, AuthenticationFailedException )
 initializes an SSO Token to send to the acceptor side and authenticates an SSO Token returned by the acceptor if the context supports mutual authentication. More...
 
- Public Member Functions inherited from XSSOContext
string getSource ()
 retrieves the principal name of the source/initiator of the context. More...
 
string getTarget ()
 retrieves the principal name of the target/acceptor of the context. More...
 
string getMechanism ()
 retrieves the mechanism associated with the context. More...
 
boolean getMutual ()
 retrieves whether or not the context supports mutual authentication More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

represents an initiator side security context.

This context may be used to initialize authentication tokens to send to an acceptor and to authenticate any token sent back in response.

Since
OOo 1.1.2

Member Function Documentation

sequence< byte > init ( [in] sequence< byte >  Token)
raises ( InvalidArgumentException,
InvalidCredentialException,
InvalidContextException,
AuthenticationFailedException
)

initializes an SSO Token to send to the acceptor side and authenticates an SSO Token returned by the acceptor if the context supports mutual authentication.

init should be called only once for contexts which don't support mutual authentication and at most twice for contexts which do support mutual authentication. Additional calls produce undefined results.

Parameters
Tokenthe SSO token received from the acceptor side in response to an authentication request. This token is ignored on the first call to init and should only be specified for the second call on a context supporting mutual authentication.
Returns
the sequence of bytes to be sent to the acceptor side as part of an authentication request. This sequence will be non zero length for the first call to init, zero length for the second call to init on a context supporting mutual authentication and undefined in all other cases.

The documentation for this interface was generated from the following file: