CPKIXValidationResultBase Class Reference

#include <pkixvalidationresult.h>

Link against: pkixcertbase.lib

class CPKIXValidationResultBase : public CBase

Inherits from

CPKIXValidationResultBase

Public Member Functions
	~CPKIXValidationResultBase()
IMPORT_C void	AppendCertificateValidationObjectL(const CCertificateValidationWarnings &)
IMPORT_C void	AppendCriticalExtensionWarningL(TDesC &)
void	AppendPolicyL(CX509CertPolicyInfo &)
void	AppendWarningL(TValidationStatus)
IMPORT_C const TValidationStatus	Error()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CPKIXValidationResultBase *	NewL()
IMPORT_C CPKIXValidationResultBase *	NewL(RReadStream &)
IMPORT_C CPKIXValidationResultBase *	NewLC()
IMPORT_C CPKIXValidationResultBase *	NewLC(RReadStream &)
IMPORT_C const CArrayPtrFlat< CX509CertPolicyInfo > &	Policies()
void	RemovePolicies()
void	Reset()
void	SetError(const TValidationError, const TInt)
void	SetErrorAndLeaveL(const TValidationError, const TInt)
IMPORT_C const RPointerArray< CCertificateValidationWarnings > &	ValidationWarnings()
IMPORT_C const CArrayFixFlat< TValidationStatus > &	Warnings()

Protected Member Functions
	CPKIXValidationResultBase()
IMPORT_C void	ConstructL()

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

Detailed Description

Base class for CPKIXValidationResult.

Constructor & Destructor Documentation

CPKIXValidationResultBase ( )

IMPORT_C

CPKIXValidationResultBase

(

)

[protected]

~CPKIXValidationResultBase ( )

IMPORT_C

~CPKIXValidationResultBase

(

)

The destructor.

Frees all resources owned by the object.

Member Function Documentation

AppendCertificateValidationObjectL ( const CCertificateValidationWarnings & )

IMPORT_C void

AppendCertificateValidationObjectL

(

const CCertificateValidationWarnings &

aCertWarning

)

Adds a certificate warning to the validation result.

Parameter	Description
aCertWarning	The warning to be added.

AppendCriticalExtensionWarningL ( TDesC & )

IMPORT_C void

AppendCriticalExtensionWarningL

(

TDesC &

aCriticalExt

)

Adds a critical extension OID warning.

Parameter	Description
aCriticalExt	The critical extension OID to be added.

AppendPolicyL ( CX509CertPolicyInfo & )

void

AppendPolicyL

(

CX509CertPolicyInfo &

aPolicy

)

Adds a policy to the validation result.

Parameter	Description
aPolicy	The policy to be added.

AppendWarningL ( TValidationStatus )

void

AppendWarningL

(

TValidationStatus

aWarning

)

Adds a warning to the validation result.

Parameter	Description
aWarning	The warning to be added.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected]

Error ( )

IMPORT_C const TValidationStatus

Error

(

)

const

Gets the error status of the operation.

Errors are considered fatal, i.e. validation has failed.

Returns: The error status of the operation.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameter	Description
aStream	Stream to which the object should be externalised.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

Note that this function has assignment semantics: it replaces the old value of the object with a new value read from the read stream.

Parameter	Description
aStream	Stream from which the object should be internalised.

NewL ( )

IMPORT_C CPKIXValidationResultBase *

NewL

(

)

[static]

Creates a new PKIX Validation Result object.

Returns: The new PKIX Validation Result object.

NewL ( RReadStream & )

IMPORT_C CPKIXValidationResultBase *

NewL

(

RReadStream &

aStream

)

[static]

Creates a new PKIX Validation Result object from a stream.

Returns: The new PKIX Validation Result object.

NewLC ( )

IMPORT_C CPKIXValidationResultBase *

NewLC

(

)

[static]

Creates a new PKIX Validation Result object, and puts a pointer to it onto the cleanup stack.

Returns: The new PKIX Validation Result object.

NewLC ( RReadStream & )

IMPORT_C CPKIXValidationResultBase *

NewLC

(

RReadStream &

aStream

)

[static]

Creates a new PKIX Validation Result object from a stream, and puts a pointer to it onto the cleanup stack.

Returns: The new PKIX Validation Result object.

Policies ( )

IMPORT_C const CArrayPtrFlat< CX509CertPolicyInfo > &

Policies

(

)

const

Gets a list of all the certificate policies which have been accepted implicitly in the course of validation.

Returns: An array of certificate policies.

RemovePolicies ( )

void

RemovePolicies

(

)

Removes all policies from the validation result.

It is used by the validation process to remove policies it has added when the computation cannot complete because of environmental conditions such as out of memory, file access failures, etc..

Reset ( )

void

Reset

(

)

Resets the validation result object to its default values.

SetError ( const TValidationError, const TInt )

void	SetError	(	const TValidationError	aError,
			const TInt	aCert
		)

Sets the error status.

Parameter	Description
aError	The error type that occurred when validating the certificate chain.
aCert	The index number identifying the certificate that gave rise to the error.

SetErrorAndLeaveL ( const TValidationError, const TInt )

void	SetErrorAndLeaveL	(	const TValidationError	aError,
			const TInt	aCert
		)

Sets the error status, and then leaves.

The function uses SetError() to set the error status.

Parameter	Description
aError	The error type that occurred when validating the certificate chain.
aCert	The index number identifying the certificate that gave rise to the error.

ValidationWarnings ( )

IMPORT_C const RPointerArray< CCertificateValidationWarnings > &

ValidationWarnings

(

)

const

Returns a list of critical extensions encountered and warnings generated by certificates during chain validation.

Returns: An array of certificate warnings.

Warnings ( )

IMPORT_C const CArrayFixFlat< TValidationStatus > &

Warnings

(

)

const

Gets a list of warnings generated.

The warnings may or may not be fatal, depending on the context, which the client is expected to provide.

Returns: An array of any warnings generated.