|
Developer's Guide
|
|
|
Developer's Guide
|
|
#include <p6kmipclient.h>
In the KMIP protocol there are several ways to do the same thing (e.g., encoding asymmetric keys). This structure allows the caller to over ride the default KMIP client behavior.
pVersion - Protocol version that the object will adhere to, valid values "1.0" and "1.1". Can be NULL with the default value of "1.1" used.
pSubdirectory - a subdirectory to be created under the log directory to place all logging output for the current KMIP client. This is optional and can be NULL. However, it can be used to better organize logging output (e.g., "../some_log_directory/domain_name_of_kmip_server/sub_directory" if this value is set).
asynchronous - When this parameter is set to zero the internal default is used (which is all requests are synchronous). When set to 1 all requests are then asynchronous. Note, that the caller can toggle this setting at anytime by calling the setAsynchronousIndicator() API method.
privateKeyEncoding - When this parameter is set to zero the internal default is used. Otherwise the value selected from Section 9.1.3.2.3 in p6kmip.h, Key Format Type Enumeration,
publicKeyEncoding - When this parameter is set to zero the internal default is used. Otherwise the value selected from Section 9.1.3.2.3 in p6kmip.h, Key Format Type Enumeration,
symmetricKeyEncoding - When this parameter is set to zero the internal default is used. Otherwise the value selected from Section 9.1.3.2.3 in p6kmip.h, Key Format Type Enumeration,
maxBufferSize - Defines the size in bytes for all buffers used for sending and reading data to / from a KMIP server. This component uses P6R's memory pools for KMIP messages and this value is used to define the max size of each buffer in the pool.
maxTTLVSize - (Optional can be zero), Define the maximum number of bytes in a TTLV encoded KMIP message that can be received from a KMIP server. When zero this parameter equals maxBufferSize. If this value is set bigger than maxBufferSize then maxBufferSize is used instead. Usually the client will not have to set this parameter.
connectTimeout - Units in milliseconds for socket time out when attempting to create a connection to a KMIP server. When this parameter is set to zero, then the default value of 1000 is used.
sendTimeout - Units in milliseconds for socket time out when sending an protocol message to a KMIP server. When this parameter is set to zero, then the default value of 1000 is used.
receiveTimeout - Units in milliseconds for socket time out when reading an incoming protocol message from a KMIP server. When this parameter is set to zero, then the default value of 1000 is used.
initialBufCount - The number of buffers to preallocate that will hold incoming and outgoing KMIP protocol messages. When this parameter is set to zero, then the default value of 5 is used.
growBufsBy - The number of buffers to allocate each time when the cache of free buffers is empty. These buffers are used to hold incoming and outgoing KMIP protocol messages. When this parameter is set to zero, then the default value of 5 is used.
compatibility1 - A bit mask to enable special features of the KMIP specification (e.g., XML, JSON, HTTPS). Bit mask values are defined at the end of the p6kmip.h file.
useAttestation - set the Attestation Capable Indicator on for every request to the server. The default client behavior is for no attestation. Added in KMIP 1.2
pAttestationTypes - optional, NULL when not in use, a list of attestation types, see Section 9.1.3.2.36 (in p6kmip.h) Attestation Type Enumeration
numAttTypes - number of entries in pAttestationTypes if not NULL
customize - optional, zero when not in use, caller can disable certain optional KMIP fields in requests (see p6kmipencoder.h KMIP_CUST_XXX).
Definition at line 2045 of file p6kmipclient.h.
