MCL/sf/os/security: cryptomgmtlibs/cryptotokenfw/inc/ct/tcttokenhandle.h@2c201484c85f (annotated)

0 2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	1	/*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	2	* Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	3	* All rights reserved.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	4	* This component and the accompanying materials are made available
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	5	* under the terms of the License "Eclipse Public License v1.0"
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	6	* which accompanies this distribution, and is available
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	8	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	9	* Initial Contributors:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	10	* Nokia Corporation - initial contribution.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	11	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	12	* Contributors:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	13	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	14	* Description:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	15	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	16	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	17
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	18
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	19
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	20
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	21	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	22	@file
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	23	@publishedAll
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	24	@released
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	25	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	26
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	27	#ifndef __TCTTOKENHANDLE_H__
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	28	#define __TCTTOKENHANDLE_H__
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	29
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	30	#include <e32std.h>
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	31
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	32
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	33	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	34	* Defines a handle to a subclass of the MCTToken class.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	35	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	36	* The handle identifies the class, not a particular instance of that class.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	37	* It is guaranteed to be unique within the context of a specific device (e.g.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	38	* mobile phone, etc.).
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	39	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	40	* The handle is especially useful for communication across process boundaries.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	41	* For example: a process (A) can open a token (T), get a handle to it and then
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	42	* give the handle to another process (B). This process (B) can then try to open
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	43	* the token (T) using that handle.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	44	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	45	* @since v7.0
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	46	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	47	class TCTTokenHandle
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	48	{
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	49	public:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	50	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	51	* Creates an invalid handle for the token.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	52	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	53	* An invalid handle has a iTokenTypeUid and a iTokenId equal to 0.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	54	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	55	IMPORT_C TCTTokenHandle();
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	56
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	57	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	58	* Creates a handle for the token.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	59	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	60	* @param aTokenTypeUid The value of the TokenType Uid.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	61	* @param aTokenId The identity of the Token.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	62	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	63	IMPORT_C TCTTokenHandle(TUid aTokenTypeUid, TInt aTokenId);
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	64
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	65	/** The copy constructor.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	66	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	67	* @param aTokenHandle The Token Handle object to copy
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	68	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	69	IMPORT_C TCTTokenHandle(const TCTTokenHandle& aTokenHandle);
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	70
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	71	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	72	* Equality operator.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	73	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	74	* Tests whether this Token Handle object is equal to the specified
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	75	* Token Handle object.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	76	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	77	* @param aTokenHandle The Token Handle object to be compared.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	78	* @return ETrue, if this Token Handle object is equal to
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	79	* the specified Token Handle object; EFalse otherwise.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	80	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	81	IMPORT_C TBool operator ==(const TCTTokenHandle& aTokenHandle) const;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	82
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	83	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	84	* Inequality operator.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	85	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	86	* Tests whether this Token Handle object is not equal to the specified
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	87	* Token Handle object.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	88	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	89	* @param aTokenHandle The Token Handle object to be compared.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	90	* @return ETrue, if this Token Handle object is not equal to
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	91	* the specified Token Handle object; EFalse, otherwise.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	92	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	93	inline TBool operator !=(const TCTTokenHandle& aTokenHandle) const;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	94
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	95	public:
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	96	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	97	* The UID of the TokenType.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	98	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	99	* This identifies to which TokenType the Token belongs.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	100	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	101	TUid iTokenTypeUid;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	102
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	103	/**
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	104	* The identity of the Token.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	105	*
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	106	* This Id is unique within the context of a TokenType.
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	107	*/
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	108	TInt iTokenId;
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	109	};
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	110
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	111	inline TBool TCTTokenHandle::operator !=(const TCTTokenHandle& aTokenHandle) const
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	112	{
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	113	return !(*this == aTokenHandle);
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	114	}
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	115
2c201484c85f Move the Security package to EPL, and add the implementations of the cryptographic algorithms Santosh Patil <santosh.v.patil@nokia.com> parents: diff changeset	116	#endif

author	Santosh Patil <santosh.v.patil@nokia.com>
	Wed, 08 Jul 2009 11:25:26 +0100
changeset 0	2c201484c85f
child 8	35751d3474b7
permissions	-rw-r--r--