1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/T_PlatSecResolver/T_SecResolver.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,143 @@
1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// PlatSecResolver.h
1.18 +//
1.19 +//
1.20 +
1.21 +
1.22 +#ifndef __PLATSECRESOLVER_H__
1.23 +#define __PLATSECRESOLVER_H__
1.24 +
1.25 +#include "Resolver.h"
1.26 +#include "RegistryData.h"
1.27 +
1.28 +class TEComResolverParams;
1.29 +
1.30 +/**
1.31 + @since 7.0
1.32 +
1.33 + Controls the identification, (resolution), of which implementation
1.34 + will be used to satisfy an interface implementation instantiation.
1.35 + */
1.36 +class CPlatSecResolver : public CResolver
1.37 +{
1.38 +public:
1.39 +/**
1.40 + @fn NewL(MPublicRegistry& aRegistry)
1.41 + Intended Usage : Standardized safe construction which leaves nothing
1.42 + on the cleanup stack.
1.43 + Error Condition : Cannot fully construct because of memory limitations.
1.44 + @leave KErrNoMemory
1.45 + @since 7.0
1.46 + @return A pointer to the new class
1.47 + @post CPlatSecResolver is fully constructed,
1.48 + and initialized.
1.49 + */
1.50 + static CPlatSecResolver* NewL(MPublicRegistry& aRegistry);
1.51 +
1.52 +/**
1.53 + @fn ~CPlatSecResolver()
1.54 + Intended Usage : Standard default d'tor
1.55 + Error Condition : None
1.56 + @since 7.0
1.57 + */
1.58 + ~CPlatSecResolver();
1.59 +
1.60 +/**
1.61 + @fn IdentifyImplementationL(TUid aInterfaceUid,
1.62 + const TEComResolverParams& aAdditionalParameters) const
1.63 + Intended Usage : Request that the resolver identify the most appropriate
1.64 + interface implementation.
1.65 + Error Condition :
1.66 + @since 9.0
1.67 + @param aInterfaceUid The interface for which implementations are requested
1.68 + @param aAdditionalParameters Data to be used to refine the search further
1.69 + @return The Uid of the best fit interface implementation - KNullUid if no match is found
1.70 + @pre Object is fully constructed and initialized
1.71 + @post Registry contents are not modified but registry keys may be updated
1.72 + */
1.73 + TUid IdentifyImplementationL(TUid aInterfaceUid, const TEComResolverParams& aAdditionalParameters)const;
1.74 +
1.75 +/**
1.76 + @fn ListAllL(TUid aInterfaceUid, const TEComResolverParams& aAdditionalParameters)const
1.77 + Intended Usage : List all the implementations which satisfy the specified interface.
1.78 + Error Condition :
1.79 + @since 7.0
1.80 + @param aInterfaceUid The interface for which implementations are requested
1.81 + @param aAdditionalParameters Data to be used to refine the search further
1.82 + @return Pointer to an array of suitable implementations. Ownership of this array
1.83 + is passed to the calling function.
1.84 + @pre Object is fully constructed and initialized
1.85 + @post Registry contents are not modified but registry keys may be updated
1.86 + */
1.87 + RImplInfoArray* ListAllL(TUid aInterfaceUid,
1.88 + const TEComResolverParams& aAdditionalParameters)const;
1.89 +
1.90 +private:
1.91 +/**
1.92 + @internalComponent
1.93 + @fn CPlatSecResolver(MPublicRegistry& aRegistry)
1.94 + Intended Usage : Standardized default c'tor
1.95 + Error Condition : None
1.96 + @since 7.0
1.97 + @post CPlatSecResolver is fully constructed
1.98 + */
1.99 + explicit CPlatSecResolver(MPublicRegistry& aRegistry);
1.100 +
1.101 +/**
1.102 + @fn Resolve(const RImplInfoArray& aImplementationsInfo,
1.103 + const TEComResolverParams& aAdditionalParameters) const
1.104 + Intended Usage : Called by IdentifyImplementationL to select an appropriate
1.105 + implementation from a list of possibles
1.106 + @since 7.0
1.107 + @param aImplementationsInfo Information on the potential implementations
1.108 + @param aAdditionalParameters The data to match against to detemine the
1.109 + implementation
1.110 + @return The Uid of the selected implementation - KNullUid if no match is found
1.111 + @pre This object is fully constructed
1.112 + */
1.113 + TUid Resolve(const RImplInfoArray& aImplementationsInfo,
1.114 + const TEComResolverParams& aAdditionalParameters) const;
1.115 +
1.116 +/**
1.117 + @fn Match(const TDesC8& aImplementationType,
1.118 + const TDesC8& aMatchType,
1.119 + TBool aUseWildcards) const
1.120 + Intended Usage : Searches for a match of a data type on an implementation type.
1.121 + Match returns ETrue if aMatchType is found within aImplementationType according to
1.122 + the following rules:
1.123 + 1) aImplementationType is treated as a series of descriptors separated by double
1.124 + bars (||). ETrue is returned if aMatchType matches exactly any of the short
1.125 + descriptors. If no double bar is present then aImplementationType is treated as a
1.126 + single descriptor.
1.127 + 2) If aUseWildcards == ETrue then a '?' in aMatchType will be matched to any single
1.128 + character and '*' will be matched to any series of characters.
1.129 + @leave KErrNoMemory
1.130 + @since 7.0
1.131 + @param aImplementationType The implementation data type to search for a match
1.132 + @param aMatchType The data to search for
1.133 + @param aUseWildcards ETrue if wildcard matching should be allowed
1.134 + @return ETrue if a match was found, EFalse otherwise
1.135 + @pre This object is fully constructed
1.136 + */
1.137 + TBool Match(const TDesC8& aImplementationType,
1.138 + const TDesC8& aMatchType,
1.139 + TBool aUseWildcards) const;
1.140 +
1.141 +private:
1.142 + mutable RImplInfoArray* iImplementationInfoArray;
1.143 +};
1.144 +
1.145 +#endif // __EXAMPLERESOLVER_H__
1.146 +