com.beasys.Tobj
Interface PrincipalAuthenticator

public interface PrincipalAuthenticator

extends org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, PrincipalAuthenticator

The PrincipalAuthenticator interface is used to log on to and log off of the BEA Tuxedo domain.

Method Summary

void	build_auth_data(java.lang.String user_name, java.lang.String client_name, java.lang.String system_password, java.lang.String user_password, byte[] user_data, OpaqueHolder auth_data, AttributeListHolder privileges) Creates authentication data and attributes for use by the SecurityLevel2.PrincipalAuthenticator.authenticate method.
AuthType	get_auth_type() Gets the type of authentication expected by the BEA Tuxedo domain.
void	logoff() Discards the BEA Tuxedo CORBA client authentication context, but does not close the network connections to the BEA Tuxedo domain.
AuthenticationStatus	logon(java.lang.String user_name, java.lang.String client_name, java.lang.String system_password, java.lang.String user_password, byte[] user_data) Authenticates the client.

Methods inherited from interface org.omg.SecurityLevel2.PrincipalAuthenticator

authenticate, continue_authentication

Method Detail

get_auth_type

public AuthType get_auth_type()

Gets the type of authentication expected by the BEA Tuxedo domain.

Note: This method raises the org.omg.CORBA.BAD_INV_ORDER exception if it is called with an invalid SecurityCurrent object.

Returns:

Returns the type of authentication required to access the BEA Tuxedo domain.

logon

public AuthenticationStatus logon(java.lang.String user_name,
                                  java.lang.String client_name,
                                  java.lang.String system_password,
                                  java.lang.String user_password,
                                  byte[] user_data)

Authenticates the client. For remote BEA Tuxedo CORBA clients, this method authenticates the client via the IIOP Server Listener/Handler so that the remote client can access an BEA Tuxedo domain. This method is functionally equivalent to the org.omg.SecurityLevel2.PrincipalAuthenticator.authenticate method, but the parameters are oriented to BEA Tuxedo CORBA security.

Note: This method raises the org.omg.CORBA.BAD_INV_ORDER exception if it is called with an invalid SecurityCurrent object.

Parameters:

user_name - The BEA Tuxedo CORBA user name. The authentication level is com.beasys.Tobj.AuthType.TOBJ_NOAUTH. If user_name is null or empty, or exceeds 30 characters, logon raises the org.omg.CORBA.BAD_PARAM exception.

client_name - The BEA Tuxedo CORBA client name. The authentication level is TOBJ_NOAUTH. If the client_name is NULL or empty, or exceeds 30 characters, logon raises the org.omg.CORBA.BAD_PARAM exception.

system_password - The BEA Tuxedo CORBA client application password. The authentication level is com.beasys.Tobj.AuthType.TOBJ_SYSAUTH. If the client name is NULL or empty, logon raises the org.omg.CORBA.BAD_PARAM exception.

Note: The system_password must not exceed eight characters.

user_password - The user password (needed for use by the default BEA Tuxedo CORBA authentication service). The authentication level is com.beasys.Tobj.AuthType.TOBJ_APPAUTH.

user_data - Data that is specific to the client application (needed for use by a custom BEA Tuxedo CORBA authentication service). The authentication level is com.beasys.Tobj.AuthType.TOBJ_APPAUTH.

Note: The TOBJ_SYSAUTH authentication type includes the requirements of the TOBJ_NOAUTH type, plus a client application password. The TOBJ_APPAUTH authentication type includes the requirements of the TOBJ_SYSAUTH authentication type, plus additional information, such as a user password or user data.

Note: The user_password and user_data parameters are mutually exclusive, depending on the requirements of the authentication service used in the configuration of the BEA Tuxedo domain. The BEA Tuxedo CORBA default authentication service expects a user password. A customized authentication service may require user data. The logon call raises the org.omg.CORBA.BAD_PARAM exception if both user_password and user_data are specified.

Returns:

org.omg.Security.AuthenticationStatus.SecAuthSuccess if the authentication succeeded.

org.omg.Security.AuthenticationStatus.SecAuthFailure if the authentication failed, or if the client was already authenticated and did not invoke the com.beasys.Tobj.PrincipalAuthenticator.logoff or com.beasys.Tobj_Bootstrap.destroy_current methods.

logoff

public void logoff()

Discards the BEA Tuxedo CORBA client authentication context, but does not close the network connections to the BEA Tuxedo domain. Logoff also invalidates the current credentials. After logging off, invocations using existing object references fail if the authentication type is not com.beasys.Tobj.AuthType.TOBJ_NOAUTH.

If the client is currently authenticated to a BEA Tuxedo CORBA domain, invoking the com.beasys.Tobj_Bootstrap.destroy_current method invokes logoff implicitly.

Note: This method raises the org.omg.CORBA.BAD_INV_ORDER exception if it is called with an invalid SecurityCurrent object.

build_auth_data

public void build_auth_data(java.lang.String user_name,
                            java.lang.String client_name,
                            java.lang.String system_password,
                            java.lang.String user_password,
                            byte[] user_data,
                            OpaqueHolder auth_data,
                            AttributeListHolder privileges)

Creates authentication data and attributes for use by the SecurityLevel2.PrincipalAuthenticator.authenticate method.

Note: This method raises the org.omg.CORBA.BAD_INV_ORDER exception if it is called with an invalid SecurityCurrent object.

Parameters:

user_name - The BEA Tuxedo CORBA user name.

client_name - The BEA Tuxedo CORBA client name.

system_password - The BEA Tuxedo CORBA client application password.

user_password - The user password (default BEA Tuxedo CORBA authentication service).

user_data - Client application-specific data (custom BEA Tuxedo CORBA authentication service).

auth_data - For use by authenticate.

privileges - For use by authenticate.

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

Note: The user_password and user_data parameters are mutually exclusive, depending on the requirements of the authentication service used in the configuration of the BEA Tuxedo domain. The BEA Tuxedo default authentication service expects a user password. A customized authentication service may require user data. If both user_password and user_data are specified, the subsequent authentication call raises the org.omg.CORBA.BAD_PARAM exception.