epoc32/include/cauthentication.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// Authentication class for storing login information
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/**
williamr@2
    21
 @file cauthentication.h
williamr@2
    22
 @publishedPartner
williamr@2
    23
 @released
williamr@2
    24
*/
williamr@2
    25
williamr@2
    26
#ifndef __CAUTHENTICATION_H__
williamr@2
    27
#define __CAUTHENTICATION_H__
williamr@2
    28
williamr@2
    29
#include <uri8.h>
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
CAuthentication encapsulates username and login information. 
williamr@2
    33
Uses 8-bit descriptors. Unicode text must be tranformed into UTF8 for storage.
williamr@2
    34
@publishedPartner
williamr@2
    35
@released
williamr@2
    36
*/
williamr@2
    37
class CAuthentication: public CBase
williamr@2
    38
	{
williamr@2
    39
public:
williamr@2
    40
	/**
williamr@2
    41
	   enum for TMethod
williamr@2
    42
	*/
williamr@2
    43
	enum TMethod
williamr@2
    44
		{
williamr@2
    45
		/** Basic */
williamr@2
    46
		EBasic,
williamr@2
    47
		/** Digest */
williamr@2
    48
		EDigest
williamr@2
    49
		};
williamr@2
    50
public:
williamr@2
    51
	IMPORT_C static CAuthentication* NewL(const TDesC8& aName, const TDesC8& aPassword, TMethod aMethod = EDigest);
williamr@2
    52
	IMPORT_C static CAuthentication* NewL(const TUriC8& aUri, TMethod aMethod = EDigest);
williamr@2
    53
	IMPORT_C ~CAuthentication();
williamr@2
    54
	IMPORT_C const TDesC8& Name() const;
williamr@2
    55
	IMPORT_C const TDesC8& Password() const;
williamr@2
    56
	IMPORT_C TMethod Method() const;
williamr@2
    57
	IMPORT_C void SetNameL(const TDesC8& aName);
williamr@2
    58
	IMPORT_C void SetPasswordL(const TDesC8& aPassword);
williamr@2
    59
	IMPORT_C void SetMethod(TMethod aMethod);
williamr@2
    60
private:
williamr@2
    61
	CAuthentication(TMethod aMethod);
williamr@2
    62
	void ConstructL(const TDesC8& aName, const TDesC8& aPassword);
williamr@2
    63
	void ConstructL(const TUriC8& aUri);
williamr@2
    64
private:
williamr@2
    65
	/** 
williamr@2
    66
		The descriptor buffer that contains the Name.
williamr@2
    67
	 */
williamr@2
    68
	HBufC8*		iName;
williamr@2
    69
	/** 
williamr@2
    70
		The descriptor buffer that contains the Password.
williamr@2
    71
	 */
williamr@2
    72
	HBufC8*		iPassword;
williamr@2
    73
	/** 
williamr@2
    74
		The enum of type TMethod.
williamr@2
    75
	 */
williamr@2
    76
	TMethod		iMethodType;
williamr@2
    77
	};
williamr@2
    78
williamr@2
    79
#endif //__CAUTHENTICATION_H__