GISBSender Component

Properties   Methods   Events   Config Settings   Errors  

The GISBSender class implements an GISB / EDM client.

Syntax

ipworksedi.GISBSender

Remarks

The GISBSender component is used to send EDI or other documents using the GISB (Gas Industry Standards Board) / NAESB (North American Energy Standards Board) EDM (Electronic Delivery Mechanism) protocol.

When sending an EDI message, the client should specify, at a minimum, DataFrom, DataTo, URL, EDIData, and EDIType. The Post method should then be invoked.

Basic Features: GISB Versions 1.4 and above

Security is provided via the use of PGP. If you want to sign and/or encrypt your message set the SignData and EncryptData properties to true. The component does not itself implement PGP, instead it uses a

The following table defines possible values that may be passed to the SetPGPParam.

to allow you to process the PGP data with a library of your choice.

TLS/SSL will also be used if the scheme in URL is "https". In case your trading partner is using a self-signed certificate you may set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.

After you Post the server will issue a brief reply. If the server indicates some sort of an error an exception will be thrown. However, the absence of an error message does not necessarily mean that the server was able to read the EDI data. The server may attempt to process the data after closing the connection; if it finds an error it might send a separate error notification which may be processed by the GISBReceiver component.

Extended Security Options: NAESB Version 1.6

Version 1.6 of the NAESB/GISB protocol includes extensions to allow additional security. Like the AS2 protocol, version 1.6 allows for the use of receipts.

To request a receipt, set the ReceiptTo property. The ReceiptType and ReceiptSecurity properties may be used to customize the receipt request; by default, the component will request a GISB-Acknowledgement-Receipt signed over an SHA-1 hash. The receipt will be returned in the HTTP reply, and will automatically be verified by the component.

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

CookieCount Property (GISBSender Component)

The number of records in the Cookie arrays.

Syntax

func (obj *GISBSender) CookieCount() (int32, error)
func (obj *GISBSender) SetCookieCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

Data Type

int32

CookieDomain Property (GISBSender Component)

The domain of a received cookie.

Syntax

func (obj *GISBSender) CookieDomain(CookieIndex int32) (string, error)

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

string

CookieExpiration Property (GISBSender Component)

An expiration time for the cookie (if provided by the server).

Syntax

func (obj *GISBSender) CookieExpiration(CookieIndex int32) (string, error)

Default Value

""

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

string

CookieName Property (GISBSender Component)

The name of the cookie.

Syntax

func (obj *GISBSender) CookieName(CookieIndex int32) (string, error)
func (obj *GISBSender) SetCookieName(CookieIndex int32, value string) error

Default Value

""

Remarks

The name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

Data Type

string

CookiePath Property (GISBSender Component)

A path name to limit the cookie to (if provided by the server).

Syntax

func (obj *GISBSender) CookiePath(CookieIndex int32) (string, error)

Default Value

""

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

string

CookieSecure Property (GISBSender Component)

The security flag of the received cookie.

Syntax

func (obj *GISBSender) CookieSecure(CookieIndex int32) (bool, error)

Default Value

false

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

bool

CookieValue Property (GISBSender Component)

The value of the cookie.

Syntax

func (obj *GISBSender) CookieValue(CookieIndex int32) (string, error)
func (obj *GISBSender) SetCookieValue(CookieIndex int32, value string) error

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

Data Type

string

DataElementCount Property (GISBSender Component)

The number of records in the DataElement arrays.

Syntax

func (obj *GISBSender) DataElementCount() (int32, error)
func (obj *GISBSender) SetDataElementCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

• DataElementName
• DataElementValue

The array indices start at 0 and end at DataElementCount - 1.

Data Type

int32

DataElementName Property (GISBSender Component)

The name of the current data element.

Syntax

func (obj *GISBSender) DataElementName(ElementIndex int32) (string, error)
func (obj *GISBSender) SetDataElementName(ElementIndex int32, value string) error

Default Value

""

Remarks

The name of the current data element.

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DataElementCount property.

Data Type

string

DataElementValue Property (GISBSender Component)

The value of the current data element.

Syntax

func (obj *GISBSender) DataElementValue(ElementIndex int32) (string, error)
func (obj *GISBSender) SetDataElementValue(ElementIndex int32, value string) error

Default Value

""

Remarks

The value of the current data element.

The ElementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DataElementCount property.

Data Type

string

DataFrom Property (GISBSender Component)

The identity of the sending system.

Syntax

func (obj *GISBSender) DataFrom() (string, error)
func (obj *GISBSender) SetDataFrom(value string) error

Default Value

""

Remarks

Will generally be the DUNS number of the sending trading partner. Required.

Data Type

string

DataTo Property (GISBSender Component)

The identity of the receiving system.

Syntax

func (obj *GISBSender) DataTo() (string, error)
func (obj *GISBSender) SetDataTo(value string) error

Default Value

""

Remarks

Will generally be the DUNS number of the receiving trading partner. Required.

Data Type

string

EncryptData Property (GISBSender Component)

Whether or not to encrypt the data.

Syntax

func (obj *GISBSender) EncryptData() (bool, error)
func (obj *GISBSender) SetEncryptData(value bool) error

Default Value

false

Remarks

If true, then the data will be encrypted before sending to the server.

Data Type

bool

FirewallAutoDetect Property (GISBSender Component)

Whether to automatically detect and use firewall system settings, if available.

Syntax

func (obj *GISBSender) FirewallAutoDetect() (bool, error)
func (obj *GISBSender) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

FirewallType Property (GISBSender Component)

The type of firewall to connect through.

Syntax

func (obj *GISBSender) FirewallType() (int32, error)
func (obj *GISBSender) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

int32

FirewallHost Property (GISBSender Component)

The name or IP address of the firewall (optional).

Syntax

func (obj *GISBSender) FirewallHost() (string, error)
func (obj *GISBSender) SetFirewallHost(value string) error

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component fails with an error.

Data Type

string

FirewallPassword Property (GISBSender Component)

A password if authentication is to be used when connecting through the firewall.

Syntax

func (obj *GISBSender) FirewallPassword() (string, error)
func (obj *GISBSender) SetFirewallPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component fails with an error.

Data Type

string

FirewallPort Property (GISBSender Component)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

func (obj *GISBSender) FirewallPort() (int32, error)
func (obj *GISBSender) SetFirewallPort(value int32) error

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

NOTE: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

int32

FirewallUser Property (GISBSender Component)

A username if authentication is to be used when connecting through a firewall.

Syntax

func (obj *GISBSender) FirewallUser() (string, error)
func (obj *GISBSender) SetFirewallUser(value string) error

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component fails with an error.

Data Type

string

EDIData Property (GISBSender Component)

This property contains the EDI payload of the transmission.

Syntax

func (obj *GISBSender) EDIData() ([]byte, error)
func (obj *GISBSender) SetEDIData(value []byte) error

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if EDIOutputStream has not been specified and ParseRequest finishes without an error. EDIData will contain the full decrypted text of the EDI message.

Data Type

[]byte

EDIType Property (GISBSender Component)

The EDIType of the EDI message.

Syntax

func (obj *GISBSender) EDIType() (string, error)
func (obj *GISBSender) SetEDIType(value string) error

Default Value

"X12"

Remarks

The EDIType of the EDI message. The default value is "X12". EDIType may also be set to "error", in which case the message is an error relating to a previous message. In this case the ErrorMessage property and related properties will provide more information.

Data Type

string

EDIFileName Property (GISBSender Component)

In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

func (obj *GISBSender) EDIFileName() (string, error)
func (obj *GISBSender) SetEDIFileName(value string) error

Default Value

""

Remarks

In a sender, if EDIFileName is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.

In a receiver, if this property is set prior to calling ParseFormData and ParseRequest the incoming data will be decrypted and written to the file at the specified path.

Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.

Data Type

string

EDIName Property (GISBSender Component)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

func (obj *GISBSender) EDIName() (string, error)
func (obj *GISBSender) SetEDIName(value string) error

Default Value

"rfc1767.edi"

Remarks

EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

Data Type

string

GISBVersion Property (GISBSender Component)

The version of GISB/NAESB being used.

Syntax

func (obj *GISBSender) GISBVersion() (string, error)
func (obj *GISBSender) SetGISBVersion(value string) error

Default Value

"1.6"

Remarks

The version of the GISB/NAESB EDM being used. Supported values are "1.4", "1.6", "2.0", and "2.1". Note that requesting a receipt is only supported in version 1.6 and up.

Data Type

string

LocalHost Property (GISBSender Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

func (obj *GISBSender) LocalHost() (string, error)
func (obj *GISBSender) SetLocalHost(value string) error

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

string

LogDirectory Property (GISBSender Component)

The path to a directory for logging.

Syntax

func (obj *GISBSender) LogDirectory() (string, error)
func (obj *GISBSender) SetLogDirectory(value string) error

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the component will log the original EDI data, the complete text of the outgoing request and the incoming response.

The component will write a single file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files.

The filenames will be chosen automatically by the component. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".

If logs cannot be written an exception will be thrown.

Data Type

string

LogFile Property (GISBSender Component)

The log file written.

Syntax

func (obj *GISBSender) LogFile() (string, error)

Default Value

""

Remarks

In case LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the path. A diagnostic log will be written with filename LogFile + ".log", and in case of error, an additional file will be written with filename LogFile + ".dat".

This property is read-only.

Data Type

string

ProxyAuthScheme Property (GISBSender Component)

The type of authorization to perform when connecting to the proxy.

Syntax

func (obj *GISBSender) ProxyAuthScheme() (int32, error)
func (obj *GISBSender) SetProxyAuthScheme(value int32) error

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

int32

ProxyAutoDetect Property (GISBSender Component)

Whether to automatically detect and use proxy system settings, if available.

Syntax

func (obj *GISBSender) ProxyAutoDetect() (bool, error)
func (obj *GISBSender) SetProxyAutoDetect(value bool) error

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

ProxyPassword Property (GISBSender Component)

A password if authentication is to be used for the proxy.

Syntax

func (obj *GISBSender) ProxyPassword() (string, error)
func (obj *GISBSender) SetProxyPassword(value string) error

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

string

ProxyPort Property (GISBSender Component)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

func (obj *GISBSender) ProxyPort() (int32, error)
func (obj *GISBSender) SetProxyPort(value int32) error

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

int32

ProxyServer Property (GISBSender Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

func (obj *GISBSender) ProxyServer() (string, error)
func (obj *GISBSender) SetProxyServer(value string) error

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

string

ProxySSL Property (GISBSender Component)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

func (obj *GISBSender) ProxySSL() (int32, error)
func (obj *GISBSender) SetProxySSL(value int32) error

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

int32

ProxyUser Property (GISBSender Component)

A username if authentication is to be used for the proxy.

Syntax

func (obj *GISBSender) ProxyUser() (string, error)
func (obj *GISBSender) SetProxyUser(value string) error

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

string

PublicKeyringData Property (GISBSender Component)

Public keyring data.

Syntax

func (obj *GISBSender) PublicKeyringData() ([]byte, error)
func (obj *GISBSender) SetPublicKeyringData(value []byte) error

Default Value

""

Remarks

This property allows the public keyring data to be specific in the form of a byte array. Use this in conjunction with SecretKeyringData and the keyring will be loaded from this data instead of the homedir.

Data Type

[]byte

ReceiptSecurity Property (GISBSender Component)

[1.6] Used to indicate the security options requested for the receipt.

Syntax

func (obj *GISBSender) ReceiptSecurity() (string, error)
func (obj *GISBSender) SetReceiptSecurity(value string) error

Default Value

"signed-receipt-protocol=optional, pgp-signature; signed-receipt-micalg=optional, sha1, md5"

Remarks

Only supported for Version 1.6.

By default, the component will request that the receipt be signed with a PGP signature over an SHA1 or MD5 hash (if these algorithms are supported by the server).

Set ReceiptSecurity to an empty string to request an unsigned receipt.

The string format is that of the Disposition-notification-options HTTP header, as specified in RFC 3335.

Data Type

string

ReceiptSigningProtocol Property (GISBSender Component)

[1.6] Indicates the protocol used to sign the receipt.

Syntax

func (obj *GISBSender) ReceiptSigningProtocol() (string, error)

Default Value

""

Remarks

Only supported for Version 1.6.

This property will be populated after a receipt is received from the server and validated. It will contain the MIME type of the signature used, if any (i.e., "application/pgp-signature"). It will contain an empty string if the receipt is unsigned.

This property is read-only.

Data Type

string

ReceiptTo Property (GISBSender Component)

[1.6] Used to request a receipt.

Syntax

func (obj *GISBSender) ReceiptTo() (string, error)
func (obj *GISBSender) SetReceiptTo(value string) error

Default Value

""

Remarks

Only supported for Version 1.6.

If this property is set, a Receipt-Notification-To form variable will be added to the request, and a receipt will be requested. Generally this should be the same as DataFrom.

By default, the component will request a GISB-Acknowledgement-Receipt, signed with PGP and delivered synchronously in the HTTP reply. You may set ReceiptSecurity to request a different type of signature, or no signature at all.

Data Type

string

ReceiptType Property (GISBSender Component)

[1.6] The type of receipt requested.

Syntax

func (obj *GISBSender) ReceiptType() (string, error)
func (obj *GISBSender) SetReceiptType(value string) error

Default Value

"gisb-acknowledgement-receipt"

Remarks

Only supported for Version 1.6.

If ReceiptTo is set, the component will request a receipt of the indicated type. Note that the only type of receipt readable by the component is a gisb-acknowledgement-receipt, and only if using version 1.6 of the GISB/NAESB protocol.

The security settings for the receipt (signed or unsigned) may be configured by setting ReceiptSecurity.

Data Type

string

ReplyHeaders Property (GISBSender Component)

The HTTP headers provided for the ResponseContent .

Syntax

func (obj *GISBSender) ReplyHeaders() (string, error)

Default Value

""

Remarks

The HTTP headers provided for the ResponseContent.

This property is read-only.

Data Type

string

RequestStatus Property (GISBSender Component)

The status of the request.

Syntax

func (obj *GISBSender) RequestStatus() (string, error)

Default Value

"ok"

Remarks

RequestStatus will be determined from the server response after a Post. If the request status is anything other than "ok" the component will throw an exception. Note that servers are not required to process data immediately, and a RequestStatus of "ok" is not a guarantee that the server was able to process your data.

The following is the complete list of error codes defined by the GISB 1.4 and NAESB 1.6 specifications.

The following is the complete list of error codes defined by the GISB 1.4 and NAESB 1.6 specification. Error codes only defined in version 1.6 are notated with "1.6" below, and errors that will be detected and reported automatically by the GISBReceiver component are indicated with an asterisk.

The following is the complete list of error codes defined by the GISB 1.4 specification.

EEDM100*: Missing From Common Code Identifier Code

EEDM101*: Missing To Common Code Identifier Code

EEDM102*: Missing Input Format

EEDM103*: Missing Data File

EEDM104: Missing Transaction Set

EEDM105: Invalid From Common Code Identifier

EEDM106: Invalid To Common Code Identifier

EEDM107: Invalid Input Format

EEDM108: Invalid Transaction Set

EEDM109: No Parameters Supplied

EEDM110: (1.6) Invalid "version"

EEDM111: (1.6) Missing "version"

EEDM112: (1.6) "receipt-security-selection" not mutually agreed

EEDM113*: (1.6) Invalid "receipt-security-selection"

EEDM114: (1.6) Missing "receipt-disposition-to"

EEDM115: (1.6) Invalid "receipt-disposition-to"

EEDM116: (1.6) Missing "receipt-report-type"

EEDM117: (1.6) Invalid "receipt-report-type"

EEDM118: (1.6) Missing "receipt-security-selection"

EEDM119: (1.6) Mutually agreed element, refnum, not present

EEDM601: Public Key Invalid

EEDM602: File Not Encrypted

EEDM603: Encrypted File Truncated

EEDM604*: Encrypted File Not Signed Or Signature Not Matched

EEDM699: Decryption Error

EEDM701: EDM Party Not Associated With EDI Party

EEDM702: Data Structure Error

EEDM703: Data Set Exchange Not Established For Trading Partner

EEDM999: System Error

WEDM100: Transaction Set Sent Not Mutually Agreed

WEDM102: (1.6) "receipt-security-selection" not mutually agreed

WEDM103: (1.6) Missing "receipt-security-selection"

WEDM104: (1.6) Element refnum received; not mutually agreed; ignored

This property is read-only.

Data Type

string

ResponseContent Property (GISBSender Component)

The response returned from the server.

Syntax

func (obj *GISBSender) ResponseContent() ([]byte, error)

Default Value

""

Remarks

This property will be populated after a response is received from the server. If a receipt was requested this property will contain the receipt; otherwise this property will contain at least a small bit of HTML describing whether or not the transmission succeeded.

In case the receipt was signed, ResponseContent will contain the unsigned receipt, together with its MIME headers.

Note that if a signature was requested but an unsigned receipt is received the component will throw an exception.

This property is read-only.

Data Type

[]byte

SecretKeyringData Property (GISBSender Component)

Secret keyring data.

Syntax

func (obj *GISBSender) SecretKeyringData() ([]byte, error)
func (obj *GISBSender) SetSecretKeyringData(value []byte) error

Default Value

""

Remarks

This property allows the secret keyring data to be specific in the form of a byte array. Use this in conjunction with PublicKeyringData and the keyring will be loaded from this data instead of the homedir.

Data Type

[]byte

SignData Property (GISBSender Component)

Whether or not to sign the data.

Syntax

func (obj *GISBSender) SignData() (bool, error)
func (obj *GISBSender) SetSignData(value bool) error

Default Value

false

Remarks

If true, then the data will be signed before sending to the server.

Data Type

bool

SSLAcceptServerCertEffectiveDate Property (GISBSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *GISBSender) SSLAcceptServerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLAcceptServerCertExpirationDate Property (GISBSender Component)

The date on which the certificate expires.

Syntax

func (obj *GISBSender) SSLAcceptServerCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSLAcceptServerCertExtendedKeyUsage Property (GISBSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *GISBSender) SSLAcceptServerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprint Property (GISBSender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprintSHA1 Property (GISBSender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLAcceptServerCertFingerprintSHA256 Property (GISBSender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLAcceptServerCertIssuer Property (GISBSender Component)

The issuer of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKey Property (GISBSender Component)

The private key of the certificate (if available).

Syntax

func (obj *GISBSender) SSLAcceptServerCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSLAcceptServerCertPrivateKeyAvailable Property (GISBSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSLAcceptServerCertPrivateKeyContainer Property (GISBSender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *GISBSender) SSLAcceptServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKey Property (GISBSender Component)

The public key of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKeyAlgorithm Property (GISBSender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *GISBSender) SSLAcceptServerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLAcceptServerCertPublicKeyLength Property (GISBSender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *GISBSender) SSLAcceptServerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSLAcceptServerCertSerialNumber Property (GISBSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *GISBSender) SSLAcceptServerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLAcceptServerCertSignatureAlgorithm Property (GISBSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *GISBSender) SSLAcceptServerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLAcceptServerCertStore Property (GISBSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertStore() ([]byte, error)
func (obj *GISBSender) SetSSLAcceptServerCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSLAcceptServerCertStorePassword Property (GISBSender Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *GISBSender) SSLAcceptServerCertStorePassword() (string, error)
func (obj *GISBSender) SetSSLAcceptServerCertStorePassword(value string) error

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

string

SSLAcceptServerCertStoreType Property (GISBSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertStoreType() (int32, error)
func (obj *GISBSender) SetSSLAcceptServerCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSLAcceptServerCertSubjectAltNames Property (GISBSender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintMD5 Property (GISBSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintSHA1 Property (GISBSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintSHA256 Property (GISBSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLAcceptServerCertUsage Property (GISBSender Component)

The text description of UsageFlags .

Syntax

func (obj *GISBSender) SSLAcceptServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSLAcceptServerCertUsageFlags Property (GISBSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *GISBSender) SSLAcceptServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSLAcceptServerCertVersion Property (GISBSender Component)

The certificate's version number.

Syntax

func (obj *GISBSender) SSLAcceptServerCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSLAcceptServerCertSubject Property (GISBSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *GISBSender) SSLAcceptServerCertSubject() (string, error)
func (obj *GISBSender) SetSSLAcceptServerCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

string

SSLAcceptServerCertEncoded Property (GISBSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *GISBSender) SSLAcceptServerCertEncoded() ([]byte, error)
func (obj *GISBSender) SetSSLAcceptServerCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

Data Type

[]byte

SSLCertEffectiveDate Property (GISBSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *GISBSender) SSLCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLCertExpirationDate Property (GISBSender Component)

The date on which the certificate expires.

Syntax

func (obj *GISBSender) SSLCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSLCertExtendedKeyUsage Property (GISBSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *GISBSender) SSLCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSLCertFingerprint Property (GISBSender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLCertFingerprintSHA1 Property (GISBSender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLCertFingerprintSHA256 Property (GISBSender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLCertIssuer Property (GISBSender Component)

The issuer of the certificate.

Syntax

func (obj *GISBSender) SSLCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSLCertPrivateKey Property (GISBSender Component)

The private key of the certificate (if available).

Syntax

func (obj *GISBSender) SSLCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSLCertPrivateKeyAvailable Property (GISBSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *GISBSender) SSLCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSLCertPrivateKeyContainer Property (GISBSender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *GISBSender) SSLCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSLCertPublicKey Property (GISBSender Component)

The public key of the certificate.

Syntax

func (obj *GISBSender) SSLCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSLCertPublicKeyAlgorithm Property (GISBSender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *GISBSender) SSLCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLCertPublicKeyLength Property (GISBSender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *GISBSender) SSLCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSLCertSerialNumber Property (GISBSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *GISBSender) SSLCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLCertSignatureAlgorithm Property (GISBSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *GISBSender) SSLCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLCertStore Property (GISBSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *GISBSender) SSLCertStore() ([]byte, error)
func (obj *GISBSender) SetSSLCertStore(value []byte) error

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

[]byte

SSLCertStorePassword Property (GISBSender Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *GISBSender) SSLCertStorePassword() (string, error)
func (obj *GISBSender) SetSSLCertStorePassword(value string) error

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

string

SSLCertStoreType Property (GISBSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *GISBSender) SSLCertStoreType() (int32, error)
func (obj *GISBSender) SetSSLCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

int32

SSLCertSubjectAltNames Property (GISBSender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *GISBSender) SSLCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSLCertThumbprintMD5 Property (GISBSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *GISBSender) SSLCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertThumbprintSHA1 Property (GISBSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *GISBSender) SSLCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertThumbprintSHA256 Property (GISBSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *GISBSender) SSLCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLCertUsage Property (GISBSender Component)

The text description of UsageFlags .

Syntax

func (obj *GISBSender) SSLCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSLCertUsageFlags Property (GISBSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *GISBSender) SSLCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSLCertVersion Property (GISBSender Component)

The certificate's version number.

Syntax

func (obj *GISBSender) SSLCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSLCertSubject Property (GISBSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *GISBSender) SSLCertSubject() (string, error)
func (obj *GISBSender) SetSSLCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

string

SSLCertEncoded Property (GISBSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *GISBSender) SSLCertEncoded() ([]byte, error)
func (obj *GISBSender) SetSSLCertEncoded(value []byte) error

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

Data Type

[]byte

SSLProvider Property (GISBSender Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

func (obj *GISBSender) SSLProvider() (int32, error)
func (obj *GISBSender) SetSSLProvider(value int32) error

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

int32

SSLServerCertEffectiveDate Property (GISBSender Component)

The date on which this certificate becomes valid.

Syntax

func (obj *GISBSender) SSLServerCertEffectiveDate() (string, error)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

string

SSLServerCertExpirationDate Property (GISBSender Component)

The date on which the certificate expires.

Syntax

func (obj *GISBSender) SSLServerCertExpirationDate() (string, error)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

string

SSLServerCertExtendedKeyUsage Property (GISBSender Component)

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *GISBSender) SSLServerCertExtendedKeyUsage() (string, error)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

string

SSLServerCertFingerprint Property (GISBSender Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertFingerprint() (string, error)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

string

SSLServerCertFingerprintSHA1 Property (GISBSender Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertFingerprintSHA1() (string, error)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

string

SSLServerCertFingerprintSHA256 Property (GISBSender Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertFingerprintSHA256() (string, error)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

string

SSLServerCertIssuer Property (GISBSender Component)

The issuer of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertIssuer() (string, error)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

string

SSLServerCertPrivateKey Property (GISBSender Component)

The private key of the certificate (if available).

Syntax

func (obj *GISBSender) SSLServerCertPrivateKey() (string, error)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

string

SSLServerCertPrivateKeyAvailable Property (GISBSender Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *GISBSender) SSLServerCertPrivateKeyAvailable() (bool, error)

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

SSLServerCertPrivateKeyContainer Property (GISBSender Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

func (obj *GISBSender) SSLServerCertPrivateKeyContainer() (string, error)

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

string

SSLServerCertPublicKey Property (GISBSender Component)

The public key of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertPublicKey() (string, error)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

string

SSLServerCertPublicKeyAlgorithm Property (GISBSender Component)

The textual description of the certificate's public key algorithm.

Syntax

func (obj *GISBSender) SSLServerCertPublicKeyAlgorithm() (string, error)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLServerCertPublicKeyLength Property (GISBSender Component)

The length of the certificate's public key (in bits).

Syntax

func (obj *GISBSender) SSLServerCertPublicKeyLength() (int32, error)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

int32

SSLServerCertSerialNumber Property (GISBSender Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *GISBSender) SSLServerCertSerialNumber() (string, error)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

string

SSLServerCertSignatureAlgorithm Property (GISBSender Component)

The text description of the certificate's signature algorithm.

Syntax

func (obj *GISBSender) SSLServerCertSignatureAlgorithm() (string, error)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

string

SSLServerCertStore Property (GISBSender Component)

The name of the certificate store for the client certificate.

Syntax

func (obj *GISBSender) SSLServerCertStore() ([]byte, error)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

[]byte

SSLServerCertStorePassword Property (GISBSender Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

func (obj *GISBSender) SSLServerCertStorePassword() (string, error)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

string

SSLServerCertStoreType Property (GISBSender Component)

The type of certificate store for this certificate.

Syntax

func (obj *GISBSender) SSLServerCertStoreType() (int32, error)

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

int32

SSLServerCertSubjectAltNames Property (GISBSender Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

func (obj *GISBSender) SSLServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

string

SSLServerCertThumbprintMD5 Property (GISBSender Component)

The MD5 hash of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertThumbprintMD5() (string, error)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertThumbprintSHA1 Property (GISBSender Component)

The SHA-1 hash of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertThumbprintSHA1() (string, error)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertThumbprintSHA256 Property (GISBSender Component)

The SHA-256 hash of the certificate.

Syntax

func (obj *GISBSender) SSLServerCertThumbprintSHA256() (string, error)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

string

SSLServerCertUsage Property (GISBSender Component)

The text description of UsageFlags .

Syntax

func (obj *GISBSender) SSLServerCertUsage() (string, error)

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

string

SSLServerCertUsageFlags Property (GISBSender Component)

The flags that show intended use for the certificate.

Syntax

func (obj *GISBSender) SSLServerCertUsageFlags() (int32, error)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

int32

SSLServerCertVersion Property (GISBSender Component)

The certificate's version number.

Syntax

func (obj *GISBSender) SSLServerCertVersion() (string, error)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

string

SSLServerCertSubject Property (GISBSender Component)

The subject of the certificate used for client authentication.

Syntax

func (obj *GISBSender) SSLServerCertSubject() (string, error)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

string

SSLServerCertEncoded Property (GISBSender Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *GISBSender) SSLServerCertEncoded() ([]byte, error)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only.

Data Type

[]byte

Subject Property (GISBSender Component)

The subject of the message.

Syntax

func (obj *GISBSender) Subject() (string, error)
func (obj *GISBSender) SetSubject(value string) error

Default Value

""

Remarks

The optional human-readable subject of the message.

Data Type

string

Timeout Property (GISBSender Component)

The timeout for the class.

Syntax

func (obj *GISBSender) Timeout() (int32, error)
func (obj *GISBSender) SetTimeout(value int32) error

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

int32

TransactionId Property (GISBSender Component)

The transaction ID of the message.

Syntax

func (obj *GISBSender) TransactionId() (string, error)

Default Value

""

Remarks

A unique ID for the transaction. In GISB the TransactionId will be generated by the server, so this property will be populated whenever you receive a response from the server.

This property is read-only.

Data Type

string

URL Property (GISBSender Component)

The URL to post to.

Syntax

func (obj *GISBSender) URL() (string, error)
func (obj *GISBSender) SetURL(value string) error

Default Value

""

Remarks

SSL will be used if and only if the URL scheme is "https". Note that generally signed, unencrypted messages would be sent using SSL, as encrypting the message would be redundant.

Data Type

string

UserAgent Property (GISBSender Component)

Information about the user agent.

Syntax

func (obj *GISBSender) UserAgent() (string, error)
func (obj *GISBSender) SetUserAgent(value string) error

Default Value

"IPWorks EDI GISBSender Component - www.nsoftware.com"

Remarks

Override the default with the name and version of your software.

Data Type

string

Config Method (GISBSender Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *GISBSender) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (GISBSender Component)

This method processes events from the internal message queue.

Syntax

func (obj *GISBSender) DoEvents() error

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Post Method (GISBSender Component)

Post data to the server, and check the receipt.

Syntax

func (obj *GISBSender) Post() error

Remarks

Post will generate the request and post it to the server. The reply will be checked; if a receipt was requested it will be validated, and any response will be checked for error messages.

Reset Method (GISBSender Component)

Resets the state of the control.

Syntax

func (obj *GISBSender) Reset() error

Remarks

Resets all HTTP headers as well as EDIData, etc. After invoking this method the component may be reused as if it were newly created.

SetPGPParam Method (GISBSender Component)

Sets a parameter in the PGP provider.

Syntax

func (obj *GISBSender) SetPGPParam(Name string, Value string) error

Remarks

Invoke SetPGPParam to set parameters of your PGP provider. Please refer to the documentation provided with the PGP provider for the parameters required.

The following table defines possible values that may be passed to the SetPGPParam.

Connected Event (GISBSender Component)

Fired immediately after a connection completes (or fails).

Syntax

// GISBSenderConnectedEventArgs carries the GISBSender Connected event's parameters.
type GISBSenderConnectedEventArgs struct {...}

func (args *GISBSenderConnectedEventArgs) StatusCode() int32
func (args *GISBSenderConnectedEventArgs) Description() string

// GISBSenderConnectedEvent defines the signature of the GISBSender Connected event's handler function.
type GISBSenderConnectedEvent func(sender *GISBSender, args *GISBSenderConnectedEventArgs)

func (obj *GISBSender) GetOnConnectedHandler() GISBSenderConnectedEvent
func (obj *GISBSender) SetOnConnectedHandler(handlerFunc GISBSenderConnectedEvent)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Disconnected Event (GISBSender Component)

Fired when a connection is closed.

Syntax

// GISBSenderDisconnectedEventArgs carries the GISBSender Disconnected event's parameters.
type GISBSenderDisconnectedEventArgs struct {...}

func (args *GISBSenderDisconnectedEventArgs) StatusCode() int32
func (args *GISBSenderDisconnectedEventArgs) Description() string

// GISBSenderDisconnectedEvent defines the signature of the GISBSender Disconnected event's handler function.
type GISBSenderDisconnectedEvent func(sender *GISBSender, args *GISBSenderDisconnectedEventArgs)

func (obj *GISBSender) GetOnDisconnectedHandler() GISBSenderDisconnectedEvent
func (obj *GISBSender) SetOnDisconnectedHandler(handlerFunc GISBSenderDisconnectedEvent)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (GISBSender Component)

Fired when a document finishes transferring.

Syntax

// GISBSenderEndTransferEventArgs carries the GISBSender EndTransfer event's parameters.
type GISBSenderEndTransferEventArgs struct {...}

func (args *GISBSenderEndTransferEventArgs) Direction() int32

// GISBSenderEndTransferEvent defines the signature of the GISBSender EndTransfer event's handler function.
type GISBSenderEndTransferEvent func(sender *GISBSender, args *GISBSenderEndTransferEventArgs)

func (obj *GISBSender) GetOnEndTransferHandler() GISBSenderEndTransferEvent
func (obj *GISBSender) SetOnEndTransferHandler(handlerFunc GISBSenderEndTransferEvent)

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (GISBSender Component)

Fired when information is available about errors during data delivery.

Syntax

// GISBSenderErrorEventArgs carries the GISBSender Error event's parameters.
type GISBSenderErrorEventArgs struct {...}

func (args *GISBSenderErrorEventArgs) ErrorCode() int32
func (args *GISBSenderErrorEventArgs) Description() string

// GISBSenderErrorEvent defines the signature of the GISBSender Error event's handler function.
type GISBSenderErrorEvent func(sender *GISBSender, args *GISBSenderErrorEventArgs)

func (obj *GISBSender) GetOnErrorHandler() GISBSenderErrorEvent
func (obj *GISBSender) SetOnErrorHandler(handlerFunc GISBSenderErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (GISBSender Component)

Fired every time a header line comes in.

Syntax

// GISBSenderHeaderEventArgs carries the GISBSender Header event's parameters.
type GISBSenderHeaderEventArgs struct {...}

func (args *GISBSenderHeaderEventArgs) Field() string
func (args *GISBSenderHeaderEventArgs) Value() string

// GISBSenderHeaderEvent defines the signature of the GISBSender Header event's handler function.
type GISBSenderHeaderEvent func(sender *GISBSender, args *GISBSenderHeaderEventArgs)

func (obj *GISBSender) GetOnHeaderHandler() GISBSenderHeaderEvent
func (obj *GISBSender) SetOnHeaderHandler(handlerFunc GISBSenderHeaderEvent)

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (GISBSender Component)

Fired with log information while processing a message.

Syntax

// GISBSenderLogEventArgs carries the GISBSender Log event's parameters.
type GISBSenderLogEventArgs struct {...}

func (args *GISBSenderLogEventArgs) LogType() string
func (args *GISBSenderLogEventArgs) LogMessage() []byte

// GISBSenderLogEvent defines the signature of the GISBSender Log event's handler function.
type GISBSenderLogEvent func(sender *GISBSender, args *GISBSenderLogEventArgs)

func (obj *GISBSender) GetOnLogHandler() GISBSenderLogEvent
func (obj *GISBSender) SetOnLogHandler(handlerFunc GISBSenderLogEvent)

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are:

SetCookie Event (GISBSender Component)

Fired for every cookie set by the server.

Syntax

// GISBSenderSetCookieEventArgs carries the GISBSender SetCookie event's parameters.
type GISBSenderSetCookieEventArgs struct {...}

func (args *GISBSenderSetCookieEventArgs) Name() string
func (args *GISBSenderSetCookieEventArgs) Value() string
func (args *GISBSenderSetCookieEventArgs) Expires() string
func (args *GISBSenderSetCookieEventArgs) Domain() string
func (args *GISBSenderSetCookieEventArgs) Path() string
func (args *GISBSenderSetCookieEventArgs) Secure() bool

// GISBSenderSetCookieEvent defines the signature of the GISBSender SetCookie event's handler function.
type GISBSenderSetCookieEvent func(sender *GISBSender, args *GISBSenderSetCookieEventArgs)

func (obj *GISBSender) GetOnSetCookieHandler() GISBSenderSetCookieEvent
func (obj *GISBSender) SetOnSetCookieHandler(handlerFunc GISBSenderSetCookieEvent)

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (GISBSender Component)

Fired after the server presents its certificate to the client.

Syntax

// GISBSenderSSLServerAuthenticationEventArgs carries the GISBSender SSLServerAuthentication event's parameters.
type GISBSenderSSLServerAuthenticationEventArgs struct {...}

func (args *GISBSenderSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *GISBSenderSSLServerAuthenticationEventArgs) CertSubject() string
func (args *GISBSenderSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *GISBSenderSSLServerAuthenticationEventArgs) Status() string
func (args *GISBSenderSSLServerAuthenticationEventArgs) Accept() bool
func (args *GISBSenderSSLServerAuthenticationEventArgs) SetAccept(value bool)

// GISBSenderSSLServerAuthenticationEvent defines the signature of the GISBSender SSLServerAuthentication event's handler function.
type GISBSenderSSLServerAuthenticationEvent func(sender *GISBSender, args *GISBSenderSSLServerAuthenticationEventArgs)

func (obj *GISBSender) GetOnSSLServerAuthenticationHandler() GISBSenderSSLServerAuthenticationEvent
func (obj *GISBSender) SetOnSSLServerAuthenticationHandler(handlerFunc GISBSenderSSLServerAuthenticationEvent)

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLStatus Event (GISBSender Component)

Fired when secure connection progress messages are available.

Syntax

// GISBSenderSSLStatusEventArgs carries the GISBSender SSLStatus event's parameters.
type GISBSenderSSLStatusEventArgs struct {...}

func (args *GISBSenderSSLStatusEventArgs) Message() string

// GISBSenderSSLStatusEvent defines the signature of the GISBSender SSLStatus event's handler function.
type GISBSenderSSLStatusEvent func(sender *GISBSender, args *GISBSenderSSLStatusEventArgs)

func (obj *GISBSender) GetOnSSLStatusHandler() GISBSenderSSLStatusEvent
func (obj *GISBSender) SetOnSSLStatusHandler(handlerFunc GISBSenderSSLStatusEvent)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (GISBSender Component)

Fired when a document starts transferring (after the headers).

Syntax

// GISBSenderStartTransferEventArgs carries the GISBSender StartTransfer event's parameters.
type GISBSenderStartTransferEventArgs struct {...}

func (args *GISBSenderStartTransferEventArgs) Direction() int32

// GISBSenderStartTransferEvent defines the signature of the GISBSender StartTransfer event's handler function.
type GISBSenderStartTransferEvent func(sender *GISBSender, args *GISBSenderStartTransferEventArgs)

func (obj *GISBSender) GetOnStartTransferHandler() GISBSenderStartTransferEvent
func (obj *GISBSender) SetOnStartTransferHandler(handlerFunc GISBSenderStartTransferEvent)

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (GISBSender Component)

Fired while a document transfers (delivers document).

Syntax

// GISBSenderTransferEventArgs carries the GISBSender Transfer event's parameters.
type GISBSenderTransferEventArgs struct {...}

func (args *GISBSenderTransferEventArgs) Direction() int32
func (args *GISBSenderTransferEventArgs) BytesTransferred() int64
func (args *GISBSenderTransferEventArgs) PercentDone() int32
func (args *GISBSenderTransferEventArgs) Text() []byte

// GISBSenderTransferEvent defines the signature of the GISBSender Transfer event's handler function.
type GISBSenderTransferEvent func(sender *GISBSender, args *GISBSenderTransferEventArgs)

func (obj *GISBSender) GetOnTransferHandler() GISBSenderTransferEvent
func (obj *GISBSender) SetOnTransferHandler(handlerFunc GISBSenderTransferEvent)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (GISBSender Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

GISBSender Config Settings

Base Config Settings

Trappable Errors (GISBSender Component)

GISBSender Errors

MIME Errors

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

TCP/IP Errors