test

Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Method: Logon

Purpose

Augment or override the authentication procedure for plain text login.

Syntax

PRUint32 Login (char* aUser, char* aPassword, PRInt32 *aReturnCode)=0;

Parameters

The method has the following three parameters:

aUser

The user’s login name. 

aPassword

The plain text password. 

aReturnCode

On return, contains a constant that determines whether the server should continue with the default authentication procedure. 

One of the following constants: 

  • NS_CONTINUE_DEFAULT_PROCESSING

  • NS_OVERRIDE_DEFAULT_PROCESSING

Returns

On success, NS_AUTHENTICATION_LOGON_SUCCESS.

On failure, NS_AUTHENTICATION_LOGON_FAILURE.

Description

Use this method to specify your own authentication procedure on login to Calendar Server. You can augment the native authentication mechanism, performing your own processing first, then continuing with the default process, or you can completely replace the native authentication mechanism