Automation Security Reference

Using Security in CORBA Applications

DITobj_PrincipalAuthenticator.logon

Synopsis

Logs in to the BEA Tuxedo domain. The correct input parameters depend on the authentication level.

MIDL Mapping

HRESULT logon(
  [in] BSTR 						user_name,
  [in] BSTR						client_name,
  [in] BSTR 						system_password,
  [in] BSTR 						user_password,
  [in] VARIANT 						user_data,
  [in,out,optional] VARIANT* 						exceptionInfo,
  [out,retval] Security_AuthenticationStatus*
 						returnValue);

Automation Mapping

Function logon(user_name As String, client_name As String, system_password As String, user_password As String, user_data, [exceptionInfo]) As Security_AuthenticationStatus

Description

For remote CORBA client applications, this method authenticates the client application via the IIOP Listener/Handler so that the remote client application can access a BEA Tuxedo domain. This method is functionally equivalent to DITobj_PrincipalAuthenticator.authenticate, but the parameters are oriented to security.

Arguments

user_name

The BEA Tuxedo username. This parameter is required for TOBJ_NOAUTH, TOBJ_SYSAUTH, and TOBJ_APPAUTH authentication levels.

client_name

The name of the CORBA client application. This parameter is required for TOBJ_NOAUTH, TOBJ_SYSAUTH, and TOBJ_APPAUTH authentication levels.

system_password

A password for the CORBA client application. This parameter is required for TOBJ_SYSAUTH and TOBJ_APPAUTH authentication levels.

user_password

The user password (default authentication service). This parameter is required for the TOBJ_APPAUTH authentication level.

user_data

Application-specific data (custom authentication service). This parameter is required for the TOBJ_APPAUTH authentication level.

Note: If user_name, client_name, or system_password is NULL or empty, or exceeds 30 characters, the subsequent authenticate method invocation raises the CORBA::BAD_PARAM exception.

Note: If the authorization level is TOBJ_APPAUTH, only one of user_password or user_data may be supplied.

exceptioninfo

An optional input argument that allows the client application to get additional exception data if an error occurs.

Return Values

The following table describes the valid return values.

Return Value	Meaning
`Security::AuthenticationStatus:: SecAuthSuccess`	The authentication succeeded.
`Security::AuthenticationStatus:: SecAuthFailure`	The authentication failed, or the client application was already authenticated and did not call one of the following methods: `Tobj::PrincipalAuthenticator:logoff` `Tobj_Bootstrap::destroy_current`

Return Value

Meaning

Security::AuthenticationStatus:: SecAuthSuccess

The authentication succeeded.

Security::AuthenticationStatus:: SecAuthFailure

The authentication failed, or the client application was already authenticated and did not call one of the following methods:

Tobj::PrincipalAuthenticator:logoff

Tobj_Bootstrap::destroy_current