epoc32/include/authserver/auth_srv_errs.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/authserver/auth_srv_errs.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,183 @@
     1.4 +/*
     1.5 +* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +* Contains the list of error values that may be returned. 
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +/**
    1.24 + @file 
    1.25 + @publishedAll
    1.26 + @released
    1.27 +*/
    1.28 +
    1.29 +#ifndef AUTH_SRV_ERRS_H
    1.30 +#define AUTH_SRV_ERRS_H
    1.31 +
    1.32 +#include <e32def.h>
    1.33 +
    1.34 +/**
    1.35 +	Attempted to internalize an invalid authentication expression stream.
    1.36 +	
    1.37 +	If this error occurs on the server side because the client
    1.38 +	has sent an invalid externalization buffer they are panicked
    1.39 +	with "AUTHSERVER 3", instead of being completed with this
    1.40 +	error code.
    1.41 +
    1.42 +	This error should not occur if clients use the supplied
    1.43 +	RAuthClient API.
    1.44 + */
    1.45 +const TInt KErrAuthServInvalidInternalizeExpr = -10800;
    1.46 +
    1.47 +/**
    1.48 +	Attempted to internalize an authentication expression stream
    1.49 +	with an unsupported version.
    1.50 +	
    1.51 +	The authentication server will complete an authentication
    1.52 +	request with this value if the supplied stream has an
    1.53 +	unsupported version number.
    1.54 +
    1.55 +	This error code is rare and is caused by sending a corrupt
    1.56 +	externalized expression to the server, or if the expression
    1.57 +	was internalized with an older version of the client code.
    1.58 +	This error should not occur if clients use the supplied
    1.59 +	RAuthClient API.
    1.60 + */
    1.61 +const TInt KErrAuthServUnsupportedExprVersion = -10801;
    1.62 +
    1.63 +/**
    1.64 +    An attempt was made to reference a plugin by id number and no such 
    1.65 +    plugin exists  
    1.66 + **/
    1.67 +const TInt KErrAuthServNoSuchPlugin = -10802;
    1.68 +
    1.69 +
    1.70 +/**
    1.71 +    An attempt was made to reference an identity by id number and no such 
    1.72 +    identity exists  
    1.73 + **/
    1.74 +const TInt KErrAuthServNoSuchIdentity = -10803;
    1.75 +
    1.76 +/**
    1.77 +    A plugin returns this on behalf of a user wanting to skip it.
    1.78 + **/
    1.79 +const TInt KErrAuthServPluginCancelled = -10804;
    1.80 +
    1.81 +/**
    1.82 +    A plugin returns this on behalf of a user wanting to completely quit the
    1.83 +    current operation.
    1.84 + **/
    1.85 +const TInt KErrAuthServPluginQuit = -10805;
    1.86 +
    1.87 +
    1.88 +/**
    1.89 +    This error is reported when an operation is attempted for which an
    1.90 +    authentication must have already been performed.
    1.91 + **/
    1.92 +const TInt KErrAuthServAuthenticationRequired = -10806;
    1.93 +
    1.94 +/**
    1.95 +	Attempted to add a new identity to the authentication
    1.96 +	server database with an existing ID.
    1.97 + */
    1.98 +const TInt KErrAuthServIdentityAlreadyExists = -10807;
    1.99 +
   1.100 +/**
   1.101 +	Attempted to set or retrieve a description for an identity,
   1.102 +	or remove an identity which was not in the authentication database.
   1.103 + */
   1.104 +const TInt KErrAuthServIdentityNotFound = -10808;
   1.105 +
   1.106 +/**
   1.107 +	Attempted to remove or retrieve the key info for
   1.108 +	a training record that was not in the authentication
   1.109 +	database.
   1.110 + */
   1.111 +const TInt KErrAuthServTrainingNotFound = -10809;
   1.112 +
   1.113 +/**
   1.114 +    This error is reported when the authserver has not been able to register a
   1.115 +    new identity due to no plugins training successfully.
   1.116 + **/
   1.117 +const TInt KErrAuthServRegistrationFailed = -10810;
   1.118 +
   1.119 +
   1.120 +/**
   1.121 +    This error is reported when an authclient attempts to remove the last
   1.122 +    identity.
   1.123 + **/
   1.124 +const TInt KErrAuthServCanNotRemoveLastIdentity = -10811;
   1.125 +
   1.126 +
   1.127 +/**
   1.128 +    This error is reported when an authclient attempts to remove the last
   1.129 +    trained plugin for an identity.
   1.130 + **/
   1.131 +const TInt KErrAuthServCanNotRemoveLastPlugin = -10812;
   1.132 +
   1.133 +
   1.134 +/**
   1.135 +    This error is reported when an attempt to use an inactive plugin is made.
   1.136 + **/
   1.137 +const TInt KErrAuthServPluginNotActive = -10813;
   1.138 +
   1.139 +/**
   1.140 +	Client attempted to create an identity with a description
   1.141 +	longer than 255 characters, or to change an existing identity's
   1.142 +	description to use more than 255 characters.
   1.143 + */
   1.144 +const TInt KErrAuthServDescTooLong = -10814;
   1.145 +
   1.146 +/**
   1.147 +	This error is reported when the authentication strength alias
   1.148 +	supplied by the client is not found in the authserver's
   1.149 +	central repository file.
   1.150 + */
   1.151 +
   1.152 +const TInt KErrUnknownAuthStrengthAlias = -10815;
   1.153 +
   1.154 +/**
   1.155 +	This error is reported when an authentication strength in 
   1.156 +	the authserver's central repository file is undefined.
   1.157 + */
   1.158 +
   1.159 +const TInt KErrAuthStrengthAliasNotDefined = -10816;
   1.160 +
   1.161 +/**
   1.162 +	This error is reported when an alias string defining an
   1.163 +	authentication strength in the authserver's central repository 
   1.164 +	file contains expression other than plugin Id, plugin Types 
   1.165 +	and operators ("& and "|").
   1.166 + */
   1.167 +
   1.168 +const TInt KErrAuthServInvalidAliasStringExpression = -10817;
   1.169 +
   1.170 +
   1.171 +/**
   1.172 +    This error is reported when an authclient attempts to remove the default
   1.173 +    identity.
   1.174 + */
   1.175 +const TInt KErrAuthServCanNotRemoveDefaultIdentity = KErrAuthServCanNotRemoveLastIdentity;
   1.176 +
   1.177 +/**
   1.178 +    This error is reported when an authentication manager client attempts to 
   1.179 +    reset an identity and this may result in zero plugins registering the new identity data.
   1.180 +    This can happen if a reset request is issued for all plugins registered for an identity 
   1.181 +    and none of the plugins are of knowledge type.
   1.182 + */
   1.183 +const TInt KErrAuthServResetMayLoseIdentity = -10818;
   1.184 +
   1.185 +#endif	// #ifndef AUTH_SRV_ERRS_H
   1.186 +