TElFileCertificateRetriever.OnCertificateNeeded method

TElFileCertificateRetriever.OnCertificateNeeded

This event is fired when a certificate required for validation is missing.

Declaration

[C#]
event TSBCertificateRetrievalEvent OnCertificateNeeded;
delegate void TSBCertificateRetrievalEvent(Object Sender, TElX509Certificate Certificate, TSBGeneralName NameType, string Location, ref TElX509Certificate CACertificate);

[VB.NET]
Event OnCertificateNeeded As TSBCertificateRetrievalEvent
Delegate Sub TSBCertificateRetrievalEvent(ByVal Sender As Object, ByVal Certificate As TElX509Certificate, ByVal NameType As TSBGeneralName, ByVal Location As String, ByRef CACertificate As TElX509Certificate)

[Pascal]
property OnCertificateNeeded : TSBCertificateRetrievalEvent;
TSBCertificateRetrievalEvent = procedure(Sender : TObject; Certificate : TElX509Certificate; NameType : TSBGeneralName; const Location : string; var CACertificate : TElX509Certificate) of object;

[C++]
    void get_OnCertificateNeeded(TSBCertificateRetrievalEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnCertificateNeeded(TSBCertificateRetrievalEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBCertificateRetrievalEvent)(void * _ObjectData, TObjectHandle Sender, TElX509CertificateHandle Certificate, TSBGeneralNameRaw NameType, const char * pcLocation, int32_t szLocation, TElX509CertificateHandle &CACertificate);

[PHP]
    TSBCertificateRetrievalEvent|callable|NULL get_OnCertificateNeeded()
    void set_OnCertificateNeeded(TSBCertificateRetrievalEvent|callable|NULL $Value)
    callable TSBCertificateRetrievalEvent(TObject $Sender, TElX509Certificate $Certificate, integer $NameType, string $Location, TElX509Certificate &$CACertificate)

[Java]
    TSBCertificateRetrievalEvent getOnCertificateNeeded();
    void setOnCertificateNeeded(TSBCertificateRetrievalEvent Value);
    TSBCertificateRetrievalEvent.Callback OnCertificateNeeded = new TSBCertificateRetrievalEvent.Callback() {
        public TElX509Certificate TSBCertificateRetrievalEventCallback(TObject Sender, TElX509Certificate Certificate, TSBGeneralName NameType, String Location) {
            //...
        }
    }

Parameters

Certificate - missing certificate should be passed via this parameter.
NameType - specifies the NameType value which identifies the certificate location.
Location - the location of the certificate to be retrieved.
CACertificate - contains the CA certificate.
pcLocation - the location of the certificate to be retrieved.
szLocation - the length of pcLocation.

Possible NameType values:

[.NET] [C++]	[Pascal]	Description
gnRFC822Name = 0	gnRFC822Name	The content of TElGeneralName is an e-mail address and it is stored in TElGeneralName.RFC822Name
gnDNSName = 1	gnDNSName	The content of TElGeneralName is Domain Name Service label and it is stored in TElGeneralName.DNSName
gnDirectoryName = 2	gnDirectoryName	The content of TElGeneralName is stored in TElGeneralName.DirectoryName
gnEdiPartyName = 3	gnEdiPartyName	The content of TElGeneralName is EDI party name and it is stored in TElGeneralName.EdiPartyName
gnUniformResourceIdentifier = 4	gnUniformResourceIdentifier	The content of TElGeneralName is the URI of identity and it is stored in TElGeneralName.UniformResourceIdentifier
gnIPAddress = 5	gnIPAddress	The content of TElGeneralName is the IP address and it is stored in TElGeneralName.IpAddress
gnRegisteredID = 6	gnRegisteredID	The content of TElGeneralName is the registered Object Identifier and it is stored in TElGeneralName.RegidteredID
gnOtherName = 7	gnOtherName	The content of TElGeneralName is stored in TElGeneralName.OtherName
gnUnknown = 8	gnUnknown	name type is unknown
gnPermanentIdentifier = 9	gnPermanentIdentifier	Permanent Identifier (RFC 4043).

Description

This event is fired by TElFileCertificateRetriever every time when RetrieveCertificate is called. The application should locate the requested certificate in the file system, and pass it to the Retriever.