CCTCertInfo Class Reference

#include <cctcertinfo.h>

Link against: ctframework.lib

class CCTCertInfo : protected CBase, public MCTTokenObject, public MCertInfo

Inherits from

CCTCertInfo

Public Member Functions
IMPORT_C TCertificateFormat	CertificateFormat()
IMPORT_C TCertificateOwnerType	CertificateOwnerType()
virtual IMPORT_C TCTTokenObjectHandle	Handle()
IMPORT_C TBool	IsDeletable()
IMPORT_C const TDesC8 *	IssuerHash()
IMPORT_C const TKeyIdentifier &	IssuerKeyId()
virtual const TDesC &	Label()
IMPORT_C CCTCertInfo *	NewL(const CCTCertInfo &)
IMPORT_C CCTCertInfo *	NewL(const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt, TBool, const TDesC8 *)
IMPORT_C CCTCertInfo *	NewL(const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt)
IMPORT_C CCTCertInfo *	NewL(RReadStream &, MCTToken &)
IMPORT_C CCTCertInfo *	NewLC(const CCTCertInfo &)
IMPORT_C CCTCertInfo *	NewLC(const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt, TBool, const TDesC8 *)
IMPORT_C CCTCertInfo *	NewLC(const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt)
IMPORT_C CCTCertInfo *	NewLC(RReadStream &, MCTToken &)
IMPORT_C void	SetCertificateId(TInt)
IMPORT_C TInt	Size()
IMPORT_C const TKeyIdentifier &	SubjectKeyId()
virtual MCTToken &	Token()
virtual TUid	Type()
IMPORT_C TBool	operator==(const CCTCertInfo &)

Protected Member Functions
virtual	~CCTCertInfo()

Inherited Attributes
	MCertInfo::iCertificateId
	MCertInfo::iCertificateOwnerType
	MCertInfo::iDeletable
	MCertInfo::iFormat
	MCertInfo::iIssuerKeyId
	MCertInfo::iLabel
	MCertInfo::iSize
	MCertInfo::iSubjectKeyId

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	MCTTokenObject::AddTokenRef()
	MCTTokenObject::DoRelease()
	MCTTokenObject::MCTTokenObject(MCTToken &)
	MCTTokenObject::Release()
	MCTTokenObject::~MCTTokenObject()
	MCertInfo::ExternalizeL(RWriteStream &)const
	MCertInfo::InternalizeL(RReadStream &)
	MCertInfo::MCertInfo()
	MCertInfo::MCertInfo(const MCertInfo &)
	MCertInfo::MCertInfo(const TDesC &,TCertificateFormat,TCertificateOwnerType,TInt,const TKeyIdentifier ,const TKeyIdentifier ,TInt,TBool)
	MCertInfo::~MCertInfo()

Detailed Description

Encapsulates information about a stored certificate.

Objects of this type are usually returned by a certificate store, to allow a client to query the contents of the store.

Note that these objects are normally constructed by certificate stores, not by clients.

Constructor & Destructor Documentation

~CCTCertInfo ( )

IMPORT_C

~CCTCertInfo

(

)

[protected, virtual]

Member Function Documentation

CertificateFormat ( )

IMPORT_C TCertificateFormat

CertificateFormat

(

)

const

Gets the certificate format.

Return Value: The certificate format.

CertificateOwnerType ( )

IMPORT_C TCertificateOwnerType

CertificateOwnerType

(

)

const

Gets the owner type.

Return Value: The owner type.

Handle ( )

IMPORT_C TCTTokenObjectHandle

Handle

(

)

const [virtual]

Reimplemented from MCTTokenObject::Handle()const

Gets a handle for the object.

The primary purpose of the handle is to allow token objects to be 'passed' between processes.

IsDeletable ( )

IMPORT_C TBool

IsDeletable

(

)

const

Whether the certificate is deletable.

Return Value: ETrue if it is possible to delete the certificate; EFalse, otherwise.

IssuerHash ( )

IMPORT_C const TDesC8 *

IssuerHash

(

)

const

Reimplemented from MCertInfo::IssuerHash()const

Gets the hash of the issuer's DN.

Return Value: The hash of the issuer's DN, or NULL if not known.

IssuerKeyId ( )

IMPORT_C const TKeyIdentifier &

IssuerKeyId

(

)

const

Gets the issuer key ID.

Return Value: A reference to a key identifier object.

Label ( )

const TDesC &

Label

(

)

const [virtual]

Reimplemented from MCTTokenObject::Label()const

Gets the object's human-readable label.

NewL ( const CCTCertInfo & )

IMPORT_C CCTCertInfo *

NewL

(

const CCTCertInfo &

aCertInfo

)

[static]

Construction -- Note that these objects are normally constructed by certificate stores, not by clients.

Creates the certificate information object by copying from an existing object.

Parameters
aCertInfo	The source certificate information.

Return Value: A pointer to the new certificate information object.

Leave Codes
KErrNoMemory	There is no memory to construct it.

NewL ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt, TBool, const TDesC8 * )

IMPORT_C CCTCertInfo *	NewL	(	const TDesC &	aLabel,
			TCertificateFormat	aFormat,
			TCertificateOwnerType	aCertificateOwnerType,
			TInt	aSize,
			const TKeyIdentifier *	aSubjectKeyId,
			const TKeyIdentifier *	aIssuerKeyId,
			MCTToken &	aToken,
			TInt	aCertificateId,
			TBool	aDeletable,
			const TDesC8 *	aIssuerHash = NULL
		)	[static]

Creates the certificate information object from its constituent parts.

Parameters
aLabel	The certificate's label.
aFormat	The certificate's format.
aCertificateOwnerType	The owner type.
aSize	The size of the certificate.
aSubjectKeyId	The subject key ID.
aIssuerKeyId	The issuer key ID.
aToken	The token that the certificate is within.
aCertificateId	The ID within the object handle.
aDeletable	The certificate is deletable.
aIssuerHash	The hash of the DN of the issuer.

Return Value: A pointer to the new certificate information object.

Leave Codes
KErrNoMemory	There is no memory to construct it.

NewL ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt )

IMPORT_C CCTCertInfo *	NewL	(	const TDesC &	aLabel,
			TCertificateFormat	aFormat,
			TCertificateOwnerType	aCertificateOwnerType,
			TInt	aSize,
			const TKeyIdentifier *	aSubjectKeyId,
			const TKeyIdentifier *	aIssuerKeyId,
			MCTToken &	aToken,
			TInt	aCertificateId
		)	[static]

Creates the certificate information object from its constituent parts.

Parameters
aLabel	The certificate's label.
aFormat	The certificate's format.
aCertificateOwnerType	The owner type.
aSize	The size of the certificate.
aSubjectKeyId	The subject key ID.
aIssuerKeyId	The issuer key ID.
aToken	The token that the certificate is within.
aCertificateId	The ID within the object handle.

Return Value: A pointer to the new certificate information object.

Leave Codes
KErrNoMemory	There is no memory to construct it.

NewL ( RReadStream &, MCTToken & )

IMPORT_C CCTCertInfo *	NewL	(	RReadStream &	aStream,
			MCTToken &	aToken
		)	[static]

Creates the certificate information object by internalising a previously externalised one.

Parameters
aStream	The stream from which the object is to be internalised.
aToken	The token that it is within.

NewLC ( const CCTCertInfo & )

IMPORT_C CCTCertInfo *

NewLC

(

const CCTCertInfo &

aCertInfo

)

[static]

Creates the certificate information object by copying from an existing object, and puts a pointer to the new object onto the cleanup stack.

Parameters
aCertInfo	The source certificate information.

Return Value: A pointer to the new certificate information object.

Leave Codes
KErrNoMemory	There is no memory to construct it.

NewLC ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt, TBool, const TDesC8 * )

IMPORT_C CCTCertInfo *	NewLC	(	const TDesC &	aLabel,
			TCertificateFormat	aFormat,
			TCertificateOwnerType	aCertificateOwnerType,
			TInt	aSize,
			const TKeyIdentifier *	aSubjectKeyId,
			const TKeyIdentifier *	aIssuerKeyId,
			MCTToken &	aToken,
			TInt	aCertificateId,
			TBool	aDeletable,
			const TDesC8 *	aIssuerHash = NULL
		)	[static]

Creates the certificate information object from its constituent parts, and puts a pointer to the new object onto the cleanup stack.

Parameters
aLabel	The certificate's label.
aFormat	The certificate's format.
aCertificateOwnerType	The owner type.
aSize	The size of the certificate.
aSubjectKeyId	The subject key ID.
aIssuerKeyId	The issuer key ID.
aToken	The token that the certificate is within.
aCertificateId	The ID within the object handle.
aDeletable	The certificate is deletable.
aIssuerHash	The hash of the issuer's DN.

Return Value: A pointer to the new certificate information object.

Leave Codes
KErrNoMemory	There is no memory to construct it.

NewLC ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt )

IMPORT_C CCTCertInfo *	NewLC	(	const TDesC &	aLabel,
			TCertificateFormat	aFormat,
			TCertificateOwnerType	aCertificateOwnerType,
			TInt	aSize,
			const TKeyIdentifier *	aSubjectKeyId,
			const TKeyIdentifier *	aIssuerKeyId,
			MCTToken &	aToken,
			TInt	aCertificateId
		)	[static]

Creates the certificate information object from its constituent parts, and puts a pointer to the new object onto the cleanup stack.

Parameters
aLabel	The certificate's label.
aFormat	The certificate's format.
aCertificateOwnerType	The owner type.
aSize	The size of the certificate.
aSubjectKeyId	The subject key ID.
aIssuerKeyId	The issuer key ID.
aToken	The token that the certificate is within.
aCertificateId	The ID within the object handle.

Return Value: A pointer to the new certificate information object.

Leave Codes
KErrNoMemory	There is no memory to construct it.

NewLC ( RReadStream &, MCTToken & )

IMPORT_C CCTCertInfo *	NewLC	(	RReadStream &	aStream,
			MCTToken &	aToken
		)	[static]

Creates the certificate information object, by internalising a previously externalised one, and puts a pointer to the new object onto the cleanup stack.

Parameters
aStream	The stream from which the object is to be internalised.
aToken	The token that it is within.

SetCertificateId ( TInt )

IMPORT_C void

SetCertificateId

(

TInt

aCertId

)

Sets the certificate Id.

Parameters
aCertId	The certificate Id.

Size ( )

IMPORT_C TInt

Size

(

)

const

Gets the size of the certificate.

Note that this function must be called so that the correct size of descriptor can be allocated when retrieving the certificate (with MCertStore::Retrieve()).

Return Value: The size of the certificate.

SubjectKeyId ( )

IMPORT_C const TKeyIdentifier &

SubjectKeyId

(

)

const

Gets the subject key ID.

Return Value: A reference to a key identifier object.

Token ( )

MCTToken &

Token

(

)

const [virtual]

Reimplemented from MCTTokenObject::Token()const

Gets a reference to the associated token.

Type ( )

TUid

Type

(

)

const [virtual]

Reimplemented from MCTTokenObject::Type()const

Gets a UID representing the type of the token object.

The function overrides MCTTokenObject::Type().

The meanings of possible UIDs should be documented in the documentation for the interface that returns them.

operator== ( const CCTCertInfo & )

IMPORT_C TBool

operator==

(

const CCTCertInfo &

aCertInfo

)

const

Compares this certificate information object with a specified Certificate Information object for equality.

Parameters
aCertInfo	The certificate information object to be compared.

Return Value: ETrue, if they are the same; EFalse, otherwise.

CCTCertInfo Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

~CCTCertInfo ( )

Member Function Documentation

CertificateFormat ( )

CertificateOwnerType ( )

Handle ( )

IsDeletable ( )

IssuerHash ( )

IssuerKeyId ( )

Label ( )

NewL ( const CCTCertInfo & )

NewL ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier *, const TKeyIdentifier *, MCTToken &, TInt, TBool, const TDesC8 * )

NewL ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier *, const TKeyIdentifier *, MCTToken &, TInt )

NewL ( RReadStream &, MCTToken & )

NewLC ( const CCTCertInfo & )

NewLC ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier *, const TKeyIdentifier *, MCTToken &, TInt, TBool, const TDesC8 * )

NewLC ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier *, const TKeyIdentifier *, MCTToken &, TInt )

NewLC ( RReadStream &, MCTToken & )

SetCertificateId ( TInt )

Size ( )

SubjectKeyId ( )

Token ( )

Type ( )

operator== ( const CCTCertInfo & )

NewL ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt, TBool, const TDesC8 * )

NewL ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt )

NewLC ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt, TBool, const TDesC8 * )

NewLC ( const TDesC &, TCertificateFormat, TCertificateOwnerType, TInt, const TKeyIdentifier , const TKeyIdentifier , MCTToken &, TInt )