sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // PlatSecResolver.h
sl@0: // 
sl@0: //
sl@0: 
sl@0: 
sl@0: #ifndef __PLATSECRESOLVER_H__
sl@0: #define __PLATSECRESOLVER_H__
sl@0: 
sl@0: #include "Resolver.h"
sl@0: #include "RegistryData.h"
sl@0: 
sl@0: class TEComResolverParams;
sl@0: 
sl@0: /**
sl@0: 	@since 7.0
sl@0: 	
sl@0: 	Controls the identification, (resolution), of which implementation 
sl@0: 	will be used to satisfy an interface implementation instantiation.
sl@0:  */
sl@0: class CPlatSecResolver : public CResolver
sl@0: {
sl@0: public:
sl@0: /**
sl@0: 	@fn				NewL(MPublicRegistry& aRegistry)
sl@0: 	Intended Usage	: Standardized safe construction which leaves nothing 
sl@0: 					on the cleanup stack.	
sl@0: 	Error Condition	: Cannot fully construct because of memory limitations.	
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			7.0
sl@0: 	@return			A pointer to the new class
sl@0: 	@post			CPlatSecResolver is fully constructed, 
sl@0: 					and initialized.
sl@0:  */
sl@0: 	static CPlatSecResolver* NewL(MPublicRegistry& aRegistry);
sl@0: 
sl@0: /**
sl@0: 	@fn				~CPlatSecResolver()
sl@0: 	Intended Usage	: Standard default d'tor	
sl@0: 	Error Condition	: None	
sl@0: 	@since			7.0
sl@0:  */
sl@0: 	~CPlatSecResolver();
sl@0: 
sl@0: /**
sl@0: 	@fn				IdentifyImplementationL(TUid aInterfaceUid, 
sl@0: 											const TEComResolverParams& aAdditionalParameters) const
sl@0: 	Intended Usage	:	Request that the resolver identify the most appropriate 
sl@0: 						interface implementation.
sl@0: 	Error Condition	:	
sl@0: 	@since			9.0
sl@0: 	@param			aInterfaceUid The interface for which implementations are requested
sl@0: 	@param			aAdditionalParameters Data to be used to refine the search further
sl@0: 	@return			The Uid of the best fit interface implementation - KNullUid if no match is found
sl@0: 	@pre 			Object is fully constructed and initialized
sl@0: 	@post			Registry contents are not modified but registry keys may be updated
sl@0:  */
sl@0: 	TUid IdentifyImplementationL(TUid aInterfaceUid, const TEComResolverParams& aAdditionalParameters)const;
sl@0: 
sl@0: /**
sl@0: 	@fn				ListAllL(TUid aInterfaceUid, const TEComResolverParams& aAdditionalParameters)const
sl@0: 	Intended Usage	:	List all the implementations which satisfy the specified interface.
sl@0: 	Error Condition	:	
sl@0: 	@since			7.0
sl@0: 	@param			aInterfaceUid The interface for which implementations are requested
sl@0: 	@param			aAdditionalParameters Data to be used to refine the search further
sl@0: 	@return			Pointer to an array of suitable implementations. Ownership of this array
sl@0: 	is passed to the calling function.
sl@0: 	@pre 			Object is fully constructed and initialized
sl@0: 	@post			Registry contents are not modified but registry keys may be updated
sl@0:  */
sl@0: 	RImplInfoArray* ListAllL(TUid aInterfaceUid, 
sl@0: 							 const TEComResolverParams& aAdditionalParameters)const;
sl@0: 
sl@0: private:
sl@0: /**
sl@0: 	@internalComponent
sl@0: 	@fn				CPlatSecResolver(MPublicRegistry& aRegistry)
sl@0: 	Intended Usage	: Standardized default c'tor	
sl@0: 	Error Condition	: None	
sl@0: 	@since			7.0
sl@0: 	@post			CPlatSecResolver is fully constructed
sl@0:  */
sl@0: 	explicit CPlatSecResolver(MPublicRegistry& aRegistry);
sl@0: 
sl@0: /**
sl@0: 	@fn				Resolve(const RImplInfoArray& aImplementationsInfo, 
sl@0: 							const TEComResolverParams& aAdditionalParameters) const
sl@0: 	Intended Usage	:	Called by IdentifyImplementationL to select an appropriate 
sl@0: 					implementation from a list of possibles
sl@0: 	@since			7.0
sl@0: 	@param			aImplementationsInfo Information on the potential implementations
sl@0: 	@param			aAdditionalParameters The data to match against to detemine the 
sl@0: 					implementation
sl@0: 	@return			The Uid of the selected implementation - KNullUid if no match is found
sl@0: 	@pre 			This object is fully constructed
sl@0:  */
sl@0: 	TUid Resolve(const RImplInfoArray& aImplementationsInfo, 
sl@0: 				 const TEComResolverParams& aAdditionalParameters) const;
sl@0: 
sl@0: /**
sl@0: 	@fn				Match(const TDesC8& aImplementationType, 
sl@0: 						  const TDesC8& aMatchType, 
sl@0: 						  TBool aUseWildcards) const
sl@0: 	Intended Usage	:	Searches for a match of a data type on an implementation type.
sl@0: 	Match returns ETrue if aMatchType is found within aImplementationType according to 
sl@0: 	the following rules:
sl@0: 	1) aImplementationType is treated as a series of descriptors separated by double 
sl@0: 	bars (||). ETrue is returned if aMatchType matches exactly any of the short 
sl@0: 	descriptors.  If no double bar is present then aImplementationType is treated as a
sl@0: 	single descriptor.
sl@0: 	2) If aUseWildcards == ETrue then a '?' in aMatchType will be matched to any single
sl@0: 	character and '*' will be matched to any series of characters.
sl@0: 	@leave  		KErrNoMemory
sl@0: 	@since			7.0
sl@0: 	@param			aImplementationType The implementation data type to search for a match
sl@0: 	@param			aMatchType The data to search for
sl@0: 	@param			aUseWildcards ETrue if wildcard matching should be allowed
sl@0: 	@return			ETrue if a match was found, EFalse otherwise
sl@0: 	@pre 			This object is fully constructed
sl@0:  */
sl@0: 	TBool Match(const TDesC8& aImplementationType, 
sl@0: 				const TDesC8& aMatchType, 
sl@0: 				TBool aUseWildcards) const;
sl@0: 
sl@0: private:
sl@0: 	mutable RImplInfoArray* iImplementationInfoArray;
sl@0: };
sl@0: 
sl@0: #endif // __EXAMPLERESOLVER_H__
sl@0: