Security.KMIPServer

persistent class Security.KMIPServer extends %Library.Persistent, %XML.Adaptor, %SYSTEM.Help

SQL Table Name: Security.KMIPServer

Defines the KMIP servers configured for this system.

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access. The table can only be queried directly by users with the %All role. Regular users should use the List and Detail class queries.

Method Inventory

Configure()
Exists()
Export()
Import()

Parameters

parameter DOMAIN = %Utility;

Default Localization Domain

Properties

property DBEncStartKeyList as %String (MAXLEN = 9471);

Comma-delimited list of data encryption key IDs for activation at startup 256 36-character key IDs plus commas

Property methods: DBEncStartKeyListDisplayToLogical(), DBEncStartKeyListGet(), DBEncStartKeyListGetStored(), DBEncStartKeyListIsValid(), DBEncStartKeyListLogicalToDisplay(), DBEncStartKeyListLogicalToOdbc(), DBEncStartKeyListNormalize(), DBEncStartKeyListSet()

property Description as %String (MAXLEN = 256);

Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()

property Flags as %Integer [ InitialExpression = 82 , Required ];

Flags argument to KMIP_CMD_new()

Property methods: FlagsDisplayToLogical(), FlagsGet(), FlagsGetStored(), FlagsIsValid(), FlagsLogicalToDisplay(), FlagsNormalize(), FlagsSet(), FlagsXSDToLogical()

property Host as %String (MAXLEN = 255) [ Required ];

Server host DNS name.

Property methods: HostDisplayToLogical(), HostGet(), HostGetStored(), HostIsValid(), HostLogicalToDisplay(), HostLogicalToOdbc(), HostNormalize(), HostSet()

property NBIO as %Boolean [ InitialExpression = 1 , Required ];

Non-blocking I/O.

Property methods: NBIODisplayToLogical(), NBIOGet(), NBIOGetStored(), NBIOIsValid(), NBIOLogicalToDisplay(), NBIOLogicalToXSD(), NBIONormalize(), NBIOSet(), NBIOXSDToLogical()

property Name as %String (MAXLEN = 64, MINLEN = 1) [ Required ];

Name of this KMIP Server.

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

property Port as %Integer [ InitialExpression = 5696 , Required ];

TCP port number. 5696 is the value assigned by the IANA.

Property methods: PortDisplayToLogical(), PortGet(), PortGetStored(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSet(), PortXSDToLogical()

property Protocol as %Integer [ InitialExpression = $$$KMIPv21 , Required ];

OASIS KMIP protocol version. Default is KMIP v2.1.

Property methods: ProtocolDisplayToLogical(), ProtocolGet(), ProtocolGetStored(), ProtocolIsValid(), ProtocolLogicalToDisplay(), ProtocolNormalize(), ProtocolSet(), ProtocolXSDToLogical()

property Reconnect as %Boolean [ InitialExpression = 1 , Required ];

Auto-reconnect.

Property methods: ReconnectDisplayToLogical(), ReconnectGet(), ReconnectGetStored(), ReconnectIsValid(), ReconnectLogicalToDisplay(), ReconnectLogicalToXSD(), ReconnectNormalize(), ReconnectSet(), ReconnectXSDToLogical()

property SSLConfig as %String (MAXLEN = 64, MINLEN = 1) [ Required ];

SSL/TLS configuration name. This must be a Client configuration with Server certificate verification set to Require and file(s) containing the client's X.509 certificate and associated private key.

Property methods: SSLConfigDisplayToLogical(), SSLConfigGet(), SSLConfigGetStored(), SSLConfigIsValid(), SSLConfigLogicalToDisplay(), SSLConfigLogicalToOdbc(), SSLConfigNormalize(), SSLConfigSet()

property Timeout as %Integer [ InitialExpression = 10 , Required ];

I/O timeout, in seconds.

Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutGetStored(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet(), TimeoutXSDToLogical()

Methods

method Configure() as %Status

classmethod Exists(Name As %String, ByRef KMIPServer As %ObjectHandle, ByRef Status As %Status) as %Boolean

KMIPServer exists.
This method checks for the existence of a KMIPServer in the security database.
Parameters:
Name - Name of the KMIPServer to check existence of
Return values:
If Value of the method = 0 (KMIPServer does not exist, or some error occured)
KMIPServer = Null
Status = KMIPServer "x" does not exist, or other error message

If Value of the method = 1 (KMIPServer exists)
KMipServer = Object handle to KMIPServer
Status = $$$OK

classmethod Export(FileName As %String = "KMIPServerExport.xml", ByRef NumExported As %Integer = 0, Name As %String = "*") as %Status

classmethod Import(FileName As %String = "KMIPServerExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status

Queries

query Detail(Names As %String = "*")

Selects Name As %String, Description As %String, Host As %String, Port As %Integer, Protocol As %Integer, SSLConfig As %String, NBIO As %Boolean, Reconnect As %Boolean, Timeout As %Integer, Flags As %Integer, DBEncStartKeyList As %String

List all KMIP Server records, brief display.
Names - Comma separated list of KMIP Server names, "*" = All
Note: This query may change in future versions

query List(Names As %String)

Selects Name As %String, Description As %String, SSLConfig As %String

List all KMIP Server records, brief display.
Names - Comma separated list of KMIPServer names, "*" = All
Note: This query may change in future versions

Indexes

index (NameIndex on Name) [IdKey, Type = key];

Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Triggers

trigger NoSQL (BEFORE event INSERT/UPDATE/DELETE);