All Classes
-
All Classes Interface Summary Class Summary Exception Summary Class Description Callback Java callback interface This interface must be implemented at the application side by a class that should receive the callback(s).PTEID_Address Class for the Address document on a EID Card.
You can get such an object from PTEID_EIDCard::getAddr().PTEID_ASICContainer PTEID_ByteArray Class used to receive and supply an array of bytes from/to different methods in the SDK.
Memory management note - instances of this class will not own the char arrays that are supplied to
it in the constructor or Append() methods as this class will perform copies of the input arraysPTEID_Card Abstract base class for all the card type supported.
The PTEID_ReaderContext::getCard() method will return such an object.PTEID_CardContactInterface PTEID_CardPaceSecretType PTEID_CardType PTEID_CardVersionInfo Class for the info document.
You can get such an object from PTEID_EIDCard::getVersionInfo().PTEID_CCXML_Doc PTEID_Certificate Class that represents one certificate.PTEID_Certificates Container class for all certificates on the card.PTEID_CertifStatus PTEID_CertifType PTEID_CMDSignatureClient This class is a client for signing with Chave Móvel Digital.PTEID_Config Class to access and modify the config parameters of pteid-mw.PTEID_EId Class for the ID document on a EID Card.
You can get such an object from PTEID_EIDCard::getID().PTEID_EIDCard This class represents a Portugal EID card.
To get such an object you have to ask it from the ReaderContext.PTEID_ExBadTransaction Exception class Bad Transaction (error code = EIDMW_ERR_BAD_TRANSACTION)
Throw when a class/function is not used correctly
Used in : - PTEID_ReaderContext::Lock()
- PTEID_ReaderContext::Unlock()PTEID_ExBadUsage Exception class Bad Usage (error code = EIDMW_ERR_BAD_USAGE)
Throw when a class/function is not used correctly
Used in : - PTEID_Crl classPTEID_ExBatchSignatureFailed Exception class PTEID_ExBatchSignatureFailed error codes:
All error codes related with pdf signatures (except timestamp/LTV errors), e.g.:
EIDMW_PDF_INVALID_ERROR
EIDMW_PDF_UNSUPPORTED_ERROR
EIDMW_PDF_INVALID_PAGE_ERROR
Throw when batch signature fails.
Used in : - int PTEID_EIDCard::SignPDF(PTEID_PDFSignature &sig_handler, int page, double coord_x, double coord_y, const char *location, const char *reason, const char *outfile_path)
Use GetFailedSignatureIndex() to know which of the signatures(from the batch) failed.PTEID_ExCardBadType PTEID_ExCardChanged PTEID_ExCardTypeUnknown Exception class Card Type Unknown (error code = EIDMW_ERR_CARDTYPE_UNKNOWN)
Throw when the card type is not supported
Used in : - PTEID_ReaderContext::getCard()PTEID_Exception Base class for the PTEID SDK ExceptionsPTEID_ExCertNoIssuer PTEID_ExCertNoRoot Exception class Certificate No OCSP responder (error code = EIDMW_ERR_CERT_NOROOT)
Throw when ask for the Root
Used in : - PTEID_Certificate::getRoot()PTEID_ExCmdNotAllowed Exception class Command Not Allowed (error code = EIDMW_ERR_CMD_NOT_ALLOWED)
Throw when the command asked is not allowed
Used in : - PTEID_SmartCard::writeFile(const char *fileID,const PTEID_ByteArray &out,PTEID_Pin *pin,const char *csPinCode)PTEID_ExCmdNotSupported Exception class Command Not Supported (error code = EIDMW_ERR_NOT_SUPPORTED)
Throw when the command asked is not supported by the cardPTEID_ExDocTypeUnknown PTEID_ExFileTypeUnknown Exception class File Type Unknown (error code = EIDMW_ERR_FILETYPE_UNKNOWN)
Throw when the Raw Data type doesn't exist for this card
Used in : - PTEID_Card::getRawData(PTEID_RawDataType type)PTEID_ExNoCardPresent Exception class No Card Present (error code = EIDMW_ERR_NO_CARD)
Throw when no card is present
Used in : - PTEID_ReaderContext::getCardType()
- PTEID_ReaderContext::getCard()
- PTEID_ReaderContext::getEIDCard()PTEID_ExNoReader Exception class No reader (error code = EIDMW_ERR_NO_READER)
Throw when the reader set is empty
Used in : - PTEID_Object::checkContextStillOk()PTEID_ExParamRange Exception class Bad Parameter Range (error code = EIDMW_ERR_PARAM_RANGE)
Throw when the element ask is out of range
Used in : - PTEID_ReaderSet::getReaderName(unsigned long ulIndex)
- PTEID_ReaderSet::getReaderByNum(unsigned long ulIndex)
- PTEID_Certificate::getChildren(unsigned long ulIndex)
- PTEID_Certificates::getCertByNumber(unsigned long ulIndex)
- PTEID_Pins::getPinByNumber(unsigned long ulIndex)PTEID_ExReaderSetChanged PTEID_ExReleaseNeeded Exception class Release Needed (error code = EIDMW_ERR_RELEASE_NEEDED)
Throw when the application close without calling the PTEID_RealeaseSDKPTEID_ExSOD Exception class SOD error error codes:
EIDMW_SOD_UNEXPECTED_VALUE
EIDMW_SOD_UNEXPECTED_ASN1_TAG
EIDMW_SOD_UNEXPECTED_ALGO_OID
EIDMW_SOD_ERR_HASH_NO_MATCH_ID
EIDMW_SOD_ERR_HASH_NO_MATCH_ADDRESS
EIDMW_SOD_ERR_HASH_NO_MATCH_PICTURE
EIDMW_SOD_ERR_HASH_NO_MATCH_PUBLIC_KEY
Throw when the SOD is not correctPTEID_ExUnknown Exception class Release Needed (error code = EIDMW_ERR_UNKNOWN)PTEID_FileType PTEID_LogLevel PTEID_Object Base class for the object of PTEID SDK (Can not be instantiated).PTEID_PACE_ERROR PTEID_Param Enumeration that includes all the configuration values of pteid-mw
They are grouped in different sections: general, logging, certcache, proxy, guitool, xsignPTEID_PDFSignature Helper class for the PTEID_EIDCard::SignPDF() methods - it defines multiple options that affect the signature operation
e.g Signature in batch mode, adding a cryptographic timestamp, small format visible signature and custom image in the visible signaturePTEID_Photo Class that represents the Citizen photograph stored in a pteid cardPTEID_Pin Class that represent one Pin.PTEID_Pins Container class for all pins on the card.PTEID_PinUsage PTEID_PublicKey Class that represents the card authentication public key - to be used in a mutual authentication process (1024 bit RSA key)
This key is totally unrelated to the citizen authentication key which is present in the authentication certificatePTEID_ReaderContext This class represent a reader.
You get reader object from the ReaderSet
either by its index (getReaderByNum) or by its name (getReaderByName).
Once you have a reader object, you can check if a card is present (isCardPresent).
Then you can ask which type of card is in the reader with getCardType()
and then get a card object using one of this method :
getCard or getEIDCard.PTEID_ReaderSet This is a singleton class that is the starting point to get all other objects.
You get an instance from the static instance() method (or using the define ReaderSet).
Then you get a READER (PTEID_ReaderContext)
-> from this reader, you a CARD (PTEID_Card or derived class)
-> from this card, you get identity or address objects (PTEID_EId or PTEID_Address)
-> ...PTEID_RSAPaddingType RSA padding type
Which type of padding to be used while signing with RSAPTEID_SignatureLevel PTEID_SigningDevice PTEID_SigningDeviceFactory Singleton class - Factory used to obtain signing devices.
Optionally, opens a dialog to let user choose signing device type.PTEID_SigningDeviceProxy Interface class for objects with Signing capabilities.PTEID_SigningDeviceType PTEID_SmartCard Abstract base class for Smart card.PTEID_Sod Class for the SOD document on an EID Card.
You can get such an object from PTEID_EIDCard::getSod().PTEID_ulwrapper PTEID_XmlUserRequestedInfo This class will contain information about the data to be included in the XML file returned by PTEID_EIDCard::getXmlCCDocpteidlibJava_WrapperConstants XMLUserData