FCL/sf/os/security: cryptomgmtlibs/cryptotokenfw/inc/ct/MCTTokenInterface.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 __MCTTOKENINTERFACE_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 __MCTTOKENINTERFACE_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	class MCTToken;
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	* The base class for all token interfaces.
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	*
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	* This class provides functionality to interact with the token's reference counting
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	* framework. (Interfaces themselves are not reference counted, but 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	37	* must remain open while it has open interfaces.)
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	*
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	* @publishedPartner
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	* @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	41	* @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	42	*/
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	class MCTTokenInterface
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	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	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	* Gets the associated 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	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	* @return The associated 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	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	virtual MCTToken& Token() = 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	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	/**
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	* Destroys the 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	55	*
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	* The interface should be destroyed via this method as the destructor is protected.
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	* Also takes care of reference counting 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	IMPORT_C void Release();
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
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	protected:
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	/**
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	* This function should release the interface and all its owned resources.
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	*
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	* It is called by Release(). The default implementation simply does a 'delete
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	* this'. If other behaviour is required (for instance to implement a reference
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	* counting system for the interfaces themselves, the interfaces can override
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	* this function.)
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	IMPORT_C virtual void DoRelease();
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
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	* The interface should be destroyed via the Release()
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	* function. Hence, this destructor is protected.
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	inline virtual ~MCTTokenInterface() = 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	78	};
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
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	/** Destructor */
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	inline MCTTokenInterface::~MCTTokenInterface()
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
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	#endif // __MCTTOKENINTERFACE_H__

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--