authenticationservices/authenticationserver/inc/authserver/auth_srv_errs.h
changeset 29 ece3df019add
equal deleted inserted replaced
19:cd501b96611d 29:ece3df019add
       
     1 /*
       
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 * Contains the list of error values that may be returned. 
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 /**
       
    21  @file 
       
    22  @publishedAll
       
    23  @released
       
    24 */
       
    25 
       
    26 #ifndef AUTH_SRV_ERRS_H
       
    27 #define AUTH_SRV_ERRS_H
       
    28 
       
    29 #include <e32def.h>
       
    30 
       
    31 /**
       
    32 	Attempted to internalize an invalid authentication expression stream.
       
    33 	
       
    34 	If this error occurs on the server side because the client
       
    35 	has sent an invalid externalization buffer they are panicked
       
    36 	with "AUTHSERVER 3", instead of being completed with this
       
    37 	error code.
       
    38 
       
    39 	This error should not occur if clients use the supplied
       
    40 	RAuthClient API.
       
    41  */
       
    42 const TInt KErrAuthServInvalidInternalizeExpr = -10800;
       
    43 
       
    44 /**
       
    45 	Attempted to internalize an authentication expression stream
       
    46 	with an unsupported version.
       
    47 	
       
    48 	The authentication server will complete an authentication
       
    49 	request with this value if the supplied stream has an
       
    50 	unsupported version number.
       
    51 
       
    52 	This error code is rare and is caused by sending a corrupt
       
    53 	externalized expression to the server, or if the expression
       
    54 	was internalized with an older version of the client code.
       
    55 	This error should not occur if clients use the supplied
       
    56 	RAuthClient API.
       
    57  */
       
    58 const TInt KErrAuthServUnsupportedExprVersion = -10801;
       
    59 
       
    60 /**
       
    61     An attempt was made to reference a plugin by id number and no such 
       
    62     plugin exists  
       
    63  **/
       
    64 const TInt KErrAuthServNoSuchPlugin = -10802;
       
    65 
       
    66 
       
    67 /**
       
    68     An attempt was made to reference an identity by id number and no such 
       
    69     identity exists  
       
    70  **/
       
    71 const TInt KErrAuthServNoSuchIdentity = -10803;
       
    72 
       
    73 /**
       
    74     A plugin returns this on behalf of a user wanting to skip it.
       
    75  **/
       
    76 const TInt KErrAuthServPluginCancelled = -10804;
       
    77 
       
    78 /**
       
    79     A plugin returns this on behalf of a user wanting to completely quit the
       
    80     current operation.
       
    81  **/
       
    82 const TInt KErrAuthServPluginQuit = -10805;
       
    83 
       
    84 
       
    85 /**
       
    86     This error is reported when an operation is attempted for which an
       
    87     authentication must have already been performed.
       
    88  **/
       
    89 const TInt KErrAuthServAuthenticationRequired = -10806;
       
    90 
       
    91 /**
       
    92 	Attempted to add a new identity to the authentication
       
    93 	server database with an existing ID.
       
    94  */
       
    95 const TInt KErrAuthServIdentityAlreadyExists = -10807;
       
    96 
       
    97 /**
       
    98 	Attempted to set or retrieve a description for an identity,
       
    99 	or remove an identity which was not in the authentication database.
       
   100  */
       
   101 const TInt KErrAuthServIdentityNotFound = -10808;
       
   102 
       
   103 /**
       
   104 	Attempted to remove or retrieve the key info for
       
   105 	a training record that was not in the authentication
       
   106 	database.
       
   107  */
       
   108 const TInt KErrAuthServTrainingNotFound = -10809;
       
   109 
       
   110 /**
       
   111     This error is reported when the authserver has not been able to register a
       
   112     new identity due to no plugins training successfully.
       
   113  **/
       
   114 const TInt KErrAuthServRegistrationFailed = -10810;
       
   115 
       
   116 
       
   117 /**
       
   118     This error is reported when an authclient attempts to remove the last
       
   119     identity.
       
   120  **/
       
   121 const TInt KErrAuthServCanNotRemoveLastIdentity = -10811;
       
   122 
       
   123 
       
   124 /**
       
   125     This error is reported when an authclient attempts to remove the last
       
   126     trained plugin for an identity.
       
   127  **/
       
   128 const TInt KErrAuthServCanNotRemoveLastPlugin = -10812;
       
   129 
       
   130 
       
   131 /**
       
   132     This error is reported when an attempt to use an inactive plugin is made.
       
   133  **/
       
   134 const TInt KErrAuthServPluginNotActive = -10813;
       
   135 
       
   136 /**
       
   137 	Client attempted to create an identity with a description
       
   138 	longer than 255 characters, or to change an existing identity's
       
   139 	description to use more than 255 characters.
       
   140  */
       
   141 const TInt KErrAuthServDescTooLong = -10814;
       
   142 
       
   143 /**
       
   144 	This error is reported when the authentication strength alias
       
   145 	supplied by the client is not found in the authserver's
       
   146 	central repository file.
       
   147  */
       
   148 
       
   149 const TInt KErrUnknownAuthStrengthAlias = -10815;
       
   150 
       
   151 /**
       
   152 	This error is reported when an authentication strength in 
       
   153 	the authserver's central repository file is undefined.
       
   154  */
       
   155 
       
   156 const TInt KErrAuthStrengthAliasNotDefined = -10816;
       
   157 
       
   158 /**
       
   159 	This error is reported when an alias string defining an
       
   160 	authentication strength in the authserver's central repository 
       
   161 	file contains expression other than plugin Id, plugin Types 
       
   162 	and operators ("& and "|").
       
   163  */
       
   164 
       
   165 const TInt KErrAuthServInvalidAliasStringExpression = -10817;
       
   166 
       
   167 
       
   168 /**
       
   169     This error is reported when an authclient attempts to remove the default
       
   170     identity.
       
   171  */
       
   172 const TInt KErrAuthServCanNotRemoveDefaultIdentity = KErrAuthServCanNotRemoveLastIdentity;
       
   173 
       
   174 /**
       
   175     This error is reported when an authentication manager client attempts to 
       
   176     reset an identity and this may result in zero plugins registering the new identity data.
       
   177     This can happen if a reset request is issued for all plugins registered for an identity 
       
   178     and none of the plugins are of knowledge type.
       
   179  */
       
   180 const TInt KErrAuthServResetMayLoseIdentity = -10818;
       
   181 
       
   182 #endif	// #ifndef AUTH_SRV_ERRS_H
       
   183