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: //
sl@0: 
sl@0: namespace DBSC
sl@0: {
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////
sl@0: //class CPolicyBase
sl@0: 
sl@0: /**
sl@0: */
sl@0: inline CPolicyBase::CPolicyBase()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return A const reference to the controlled collection of R/W/S policies.
sl@0: */
sl@0: inline const CPolicyBase::RPolicyCollection& CPolicyBase::PolicyCollection() const
sl@0: 	{
sl@0: 	return iPolicyCollection;
sl@0: 	}
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////
sl@0: //class CDbPolicy
sl@0: 
sl@0: /**
sl@0: */
sl@0: inline CDbPolicy::CDbPolicy()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard phase-one CDbPolicy factory method.
sl@0: @param aPolicyCollection A collection of R/W/S policies.
sl@0: @return A pointer to just created CDbPolicy instance.
sl@0: @leave System-wide error codes, including KErrNoMemory
sl@0: */
sl@0: inline CDbPolicy* CDbPolicy::NewL(const RPolicyCollection& aPolicyCollection)
sl@0: 	{
sl@0: 	CDbPolicy* policy = CDbPolicy::NewLC(aPolicyCollection);
sl@0: 	CleanupStack::Pop(policy);
sl@0: 	return policy;
sl@0: 	}
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////
sl@0: //class CTblPolicy
sl@0: 
sl@0: /**
sl@0: */
sl@0: inline CTblPolicy::CTblPolicy(const CDbPolicy* aDbPolicy) :
sl@0: 	iDbPolicy(aDbPolicy)
sl@0: 	{
sl@0: 	__ASSERT(iDbPolicy);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard phase-one CTblPolicy factory method.
sl@0: @param aTblName The name of the table, access to which is controlled by the supplied policies
sl@0: @param aPolicyCollection A collection of R/W/S policies.
sl@0: @param aDbPolicy The related for the table database policy.
sl@0: @return A pointer to just created CTblPolicy instance.
sl@0: @leave System-wide error codes, including KErrNoMemory
sl@0: */
sl@0: inline CTblPolicy* CTblPolicy::NewL(const TDesC& aTblName, 
sl@0: 									const RPolicyCollection& aPolicyCollection,
sl@0: 									const CDbPolicy* aDbPolicy)
sl@0: 	{
sl@0: 	CTblPolicy* policy = CTblPolicy::NewLC(aTblName, aPolicyCollection, aDbPolicy);
sl@0: 	CleanupStack::Pop(policy);
sl@0: 	return policy;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return A const reference to the table name.
sl@0: */
sl@0: inline const TDesC& CTblPolicy::TableName() const
sl@0: 	{
sl@0: 	DB_INVARIANT();
sl@0: 	return *iTblName;
sl@0: 	}
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////
sl@0: //class CPolicyDomain
sl@0: 
sl@0: /**
sl@0: CPolicyDomain collection of table security policies  - the granularity.
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KTblPolicyCollGranularity = 32;
sl@0: 
sl@0: /**
sl@0: @param aUid The domain UID
sl@0: */
sl@0: inline CPolicyDomain::CPolicyDomain(TUid aUid) :
sl@0: 	iUid(aUid),
sl@0: 	iTPCollection(KTblPolicyCollGranularity)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard phase-one CPolicyDomain factory method.
sl@0: @param aUid The format uid of the databases, access to which is controlled by security policies
sl@0: @param aPDLoader The interface, which actual implementation is used to load the related set
sl@0:                  of security policies into CPolicyDomain collection. Currently CPolicyDomain
sl@0: 				 policy collection can be loaded from a text or binary policy file.
sl@0: @return A pointer to just created CPolicyDomain instance.
sl@0: @leave System-wide error codes, including KErrNoMemory
sl@0: */
sl@0: inline CPolicyDomain* CPolicyDomain::NewL(TUid aUid, MPolicyDomainLoader& aPDLoader)
sl@0: 	{
sl@0: 	CPolicyDomain* domain = CPolicyDomain::NewLC(aUid, aPDLoader);
sl@0: 	CleanupStack::Pop(domain);
sl@0: 	return domain;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return Policy domain UID.
sl@0: */
sl@0: inline TUid CPolicyDomain::Uid() const
sl@0: 	{
sl@0: 	DB_INVARIANT();
sl@0: 	return iUid;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return Backup&restore SID.
sl@0: */
sl@0: inline TSecureId CPolicyDomain::BackupSID() const
sl@0: 	{
sl@0: 	DB_INVARIANT();
sl@0: 	return iBackupSID;
sl@0: 	}
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////
sl@0: //class TPolicyDomainBuilder
sl@0: 
sl@0: /**
sl@0: TPolicyDomainBuilder is a friend class of CPolicyDomain, which means that it can access
sl@0: CPolicyDomain's data members and add/update new policies there.
sl@0: The idea is that TPolicyDomainBuilder will be used by the implementors of MPolicyDomainLoader
sl@0: interface, removing the need of making them friends of CPolicyDomain or visible from CPolicyDomain.
sl@0: @param aPolicyDomain A reference to the policy domain object, which collection has to be 
sl@0:                      created by the TPolicyDomainBuilder instance.
sl@0: */
sl@0: inline TPolicyDomainBuilder::TPolicyDomainBuilder(CPolicyDomain& aPolicyDomain) :
sl@0: 	iPolicyDomain(aPolicyDomain)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: The method adds a table policy to the related CPolicyDomain collection.
sl@0: @param aTblPolicy A pointer to CTblPolicy instance, which has to be added to 
sl@0:                   the related CPolicyDomain collection. CPolicyDomain collection takes the
sl@0: 				  ownership on the supplied CTblPolicy instance.
sl@0: */
sl@0: inline void TPolicyDomainBuilder::AddTblPolicyL(CTblPolicy* aTblPolicy)
sl@0: 	{
sl@0: 	__ASSERT(aTblPolicy);
sl@0: 	__LEAVE_IF_ERROR(iPolicyDomain.iTPCollection.Append(aTblPolicy));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: The method initializes CPolicyDomain::iBackupSID data member.
sl@0: The backup&restore SID can be ECapability_None, which means - no one is allowed to do backup&restore
sl@0: for the databases, covered by current policy domain.
sl@0: @param aTblPolicy aSecureId SID of the process, which is allowed to do backup&restore
sl@0:                   for databases covered by current TPolicyDomainBuilder object.
sl@0: */
sl@0: inline void TPolicyDomainBuilder::SetBackupSID(TSecureId& aSecureId)
sl@0: 	{
sl@0: 	iPolicyDomain.iBackupSID = aSecureId;
sl@0: 	}
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////
sl@0: //class TPolicyDomainReader
sl@0: 
sl@0: /**
sl@0: TPolicyDomainReader is a friend class of CPolicyDomain, which means that it can access
sl@0: CPolicyDomain's data members and iterate through the policies collection.
sl@0: The idea is that TPolicyDomainReader will be used by the implementors of MPolicyDomainPersister
sl@0: interface, removing the need of making them friends of CPolicyDomain or visible from CPolicyDomain.
sl@0: @param aPolicyDomain A reference to the policy domain object, which collection has to be 
sl@0:                      traversed by the TPolicyDomainReader instance.
sl@0: */
sl@0: inline TPolicyDomainReader::TPolicyDomainReader(const CPolicyDomain& aPolicyDomain) :
sl@0: 	iPolicyDomain(aPolicyDomain),
sl@0: 	iIndex(0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return The UID of the related CPolicyDomain object.
sl@0: */
sl@0: inline TUid TPolicyDomainReader::Uid() const
sl@0: 	{
sl@0: 	return iPolicyDomain.Uid();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return A const reference to the existing CDbPolicy instance - part of the related
sl@0:         CPolicyDomain security policies collection.
sl@0: */
sl@0: inline const CDbPolicy& TPolicyDomainReader::DbPolicy() const
sl@0: 	{
sl@0: 	__ASSERT(iPolicyDomain.iDbPolicy);
sl@0: 	return *iPolicyDomain.iDbPolicy;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Resets the iterator for a new scan from the beginning of the controlled table 
sl@0: policies collection.
sl@0: */
sl@0: inline void TPolicyDomainReader::ResetTblPos() const
sl@0: 	{
sl@0: 	iIndex = 0;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return The count of security policies in the controlled table policies collection.
sl@0: */
sl@0: inline TInt TPolicyDomainReader::TblPolicyCount() const
sl@0: 	{
sl@0: 	return iPolicyDomain.iTPCollection.Count();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return A const pointer to the next CTblPolicy instance in the controlled collection
sl@0:         of table security policies.
sl@0: */
sl@0: inline const CTblPolicy* TPolicyDomainReader::NextTblPolicy() const
sl@0: 	{
sl@0: 	return iIndex < iPolicyDomain.iTPCollection.Count() ? iPolicyDomain.iTPCollection[iIndex++] : NULL;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return Backup&restore process SID.
sl@0: */
sl@0: inline TSecureId TPolicyDomainReader::BackupSID() const
sl@0: 	{
sl@0: 	return iPolicyDomain.iBackupSID;
sl@0: 	}
sl@0: 
sl@0: } //end of - namespace DBSC