IPKIFPkiArtifact Class Reference
#include <IPKIFPkiArtifact.h>
Detailed Description
The IPKIFPkiArtifact interface is to maintain state information for certificates and CRLs. It can maintain a list of locations from which the object has been retrieved, the time is was last retrieved, the state of the object (i.e., pending, available, not available) or verification information.TSP-enforcing: No
Definition at line 48 of file IPKIFPkiArtifact.h.
Public Member Functions | |
| IPKIFPkiArtifact () | |
| virtual | ~IPKIFPkiArtifact () |
| void | AddSource (std::string &sourceURI) |
| Adds a source URI with the current time as the retrieval time. | |
| void | AddSource (std::string &sourceURI, CPKIFTimePtr &retrievalTime) |
| Adds a source URI with the indicated time as the retrieval time. | |
| void | GetSources (std::vector< std::string > &sourceURIs) const |
| Retrieves the list of source URIs. | |
| void | GetSources (std::vector< std::pair< std::string, CPKIFTimePtr > > &sourceURIs) const |
| Retrieves the list of source URIs and associated retrieval times. | |
| CPKIFTimePtr | GetLatestRetrievalTime () const |
| Retrieves the latest retrieval time passed to AddSource. | |
| void | SetVerificationPublicKey (CPKIFSubjectPublicKeyInfoPtr &spki) |
| Sets the public key that can be used to successfully verify the artifact. | |
| CPKIFSubjectPublicKeyInfoPtr | SetVerificationPublicKey () const |
| Gets the public key that can be used to successfully verify the artifact. | |
| void | SetVerificationParameters (CPKIFAlgorithmIdentifierPtr ¶ms) |
| Sets the public key parameters that can be used to successfully verify the artifact, if necessary. | |
| CPKIFAlgorithmIdentifierPtr | GetVerificationPublicKey () const |
| Gets the public key parameters that can be used to successfully verify the artifact, if necessary. | |
| PKIArtifactState | GetState () const |
| Gets the stats of the artifact (retrieval is not specified by this interface). | |
| void | SetState (PKIArtifactState state) const |
| Sets the stats of the artifact (retrieval is not specified by this interface). | |
Constructor & Destructor Documentation
| IPKIFPkiArtifact::IPKIFPkiArtifact | ( | ) |
Interface: External
This function creates and initializes a IPKIFPkiArtifact objects
- Returns:
- None
Definition at line 35 of file IPKIFPkiArtifact.cpp.
References PAS_PENDING.
| IPKIFPkiArtifact::~IPKIFPkiArtifact | ( | ) | [virtual] |
Member Function Documentation
| void IPKIFPkiArtifact::AddSource | ( | std::string & | sourceURI | ) |
Adds a source URI with the current time as the retrieval time.
Interface: External
This function adds a source URI with the current time as the retrieval time
- Returns:
- None
- Parameters:
-
sourceURI [in] string indicating source URI
Definition at line 59 of file IPKIFPkiArtifact.cpp.
References CPKIFTime::CurrentTime().
| void IPKIFPkiArtifact::AddSource | ( | std::string & | sourceURI, | |
| CPKIFTimePtr & | retrievalTime | |||
| ) |
Adds a source URI with the indicated time as the retrieval time.
Interface: External
This function adds a source URI with the indicated time as the retrieval time
- Returns:
- None
- Parameters:
-
sourceURI [in] string indicating source URI retrievalTime [in] A refernce to a smart pointer to CPKIFTime object
Definition at line 76 of file IPKIFPkiArtifact.cpp.
| void IPKIFPkiArtifact::GetSources | ( | std::vector< std::string > & | sourceURIs | ) | const |
Retrieves the list of source URIs.
Interface: External
This function retrieves the list of source URIs
- Returns:
- None
- Parameters:
-
sourceURIs [in] a vector of strings indicating source URI
Definition at line 93 of file IPKIFPkiArtifact.cpp.
Referenced by CPKIFLdapCertNode::GetCertificates(), CPKIFHttpCertNode::GetCertificates(), CPKIFLdapCrlNode::GetCrls(), CPKIFHttpCrlNode::GetCrls(), and CPKIFCertificateSource::operator==().
| void IPKIFPkiArtifact::GetSources | ( | std::vector< std::pair< std::string, CPKIFTimePtr > > & | sourceURIs | ) | const |
Retrieves the list of source URIs and associated retrieval times.
| CPKIFTimePtr IPKIFPkiArtifact::GetLatestRetrievalTime | ( | ) | const |
Retrieves the latest retrieval time passed to AddSource.
Interface: External
This function retrieves the latest retrieval time passed to AddSource
- Returns:
- A smart pointer to CPKIFTime
Definition at line 126 of file IPKIFPkiArtifact.cpp.
| void IPKIFPkiArtifact::SetVerificationPublicKey | ( | CPKIFSubjectPublicKeyInfoPtr & | spki | ) |
Sets the public key that can be used to successfully verify the artifact.
Interface: External
This function sets the public key that can be used to successfully verify the artifact
- Returns:
- A smart pointer to CPKIFTime
- Parameters:
-
spki [in] A reference to a smart pointer to CPKIFSubjectPublicKeyInfo object
Definition at line 150 of file IPKIFPkiArtifact.cpp.
| CPKIFSubjectPublicKeyInfoPtr IPKIFPkiArtifact::SetVerificationPublicKey | ( | ) | const |
Gets the public key that can be used to successfully verify the artifact.
Interface: External
This function /gets the public key that can be used to successfully verify the artifact
- Returns:
- A smart pointer to CPKIFSubjectPublicKeyInfo
Definition at line 164 of file IPKIFPkiArtifact.cpp.
| void IPKIFPkiArtifact::SetVerificationParameters | ( | CPKIFAlgorithmIdentifierPtr & | params | ) |
Sets the public key parameters that can be used to successfully verify the artifact, if necessary.
Interface: External
This function sets the public key parameters that can be used to successfully verify the artifact, if necessary
- Returns:
- A smart pointer to CPKIFSubjectPublicKeyInfo
- Parameters:
-
params [in] A reference to a smart pointer to CPKIFAlgorithmIdentifier object
Definition at line 176 of file IPKIFPkiArtifact.cpp.
| CPKIFAlgorithmIdentifierPtr IPKIFPkiArtifact::GetVerificationPublicKey | ( | ) | const |
Gets the public key parameters that can be used to successfully verify the artifact, if necessary.
Interface: External
This function gets the public key parameters that can be used to successfully verify the artifact, if necessary
- Returns:
- A smart pointer to CPKIFAlgorithmIdentifier
Definition at line 190 of file IPKIFPkiArtifact.cpp.
| PKIArtifactState IPKIFPkiArtifact::GetState | ( | ) | const |
Gets the stats of the artifact (retrieval is not specified by this interface).
Interface: External
This function gets the stats of the artifact (retrieval is not specified by this interface)
- Returns:
- A smart pointer to PKIArtifactState
Definition at line 202 of file IPKIFPkiArtifact.cpp.
Referenced by CPKIFLdapCrlNode::GetCrls(), and CPKIFHttpCrlNode::GetCrls().
| void IPKIFPkiArtifact::SetState | ( | PKIArtifactState | state | ) | const |
Sets the stats of the artifact (retrieval is not specified by this interface).
Interface: External
This function sets the stats of the artifact (retrieval is not specified by this interface)
- Returns:
- None
Definition at line 215 of file IPKIFPkiArtifact.cpp.
Referenced by CPKIFHttpCertNode::GetCertificates(), CPKIFLdapCrlNode::GetCrls(), CPKIFHttpCrlNode::GetCrls(), CPKIFCertificateNodeEntry::SetCert(), and CPKIFCRLNodeEntry::SetCRL().
The documentation for this class was generated from the following files:
