RESTClient Class

Properties   Methods   Events   Config Settings   Errors  

The RESTClient class implements client-side functionality for the REST protocol.

Syntax

secureblackbox.Restclient

Remarks

RESTClient allows you to send requests to a REST server and receive server responses. It supports both plain (HTTP) and secure (HTTPS) modes.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

BlockedCertificates Property (RESTClient Class)

The certificates that must be rejected as trust anchors.

Syntax

public CertificateList getBlockedCertificates();


public void setBlockedCertificates(CertificateList blockedCertificates);

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ClientChain Property (RESTClient Class)

The TLS client certificate chain.

Syntax

public CertificateList getClientChain();


public void setClientChain(CertificateList clientChain);

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ConnectionInfo Property (RESTClient Class)

Returns the details of the underlying network connection.

Syntax

public ConnectionInfo getConnectionInfo();

Remarks

Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.

This property is read-only and not available at design time.

Please refer to the ConnectionInfo type for a complete list of fields.

CustomRequest Property (RESTClient Class)

Specifies a custom request verb.

Syntax

public String getCustomRequest();


public void setCustomRequest(String customRequest);

Default Value

""

Remarks

Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs.

This property is not available at design time.

DynamicData Property (RESTClient Class)

Takes a piece of data to be sent to the server within a dynamic POST or PUT request.

Syntax

public byte[] getDynamicData();


public void setDynamicData(byte[] dynamicData);

Remarks

Assign the next chunk of data to this property from your DynamicDataNeeded event handler to pass it to the server. Leave it empty to tell the component that no more data is available.

This property is not available at design time.

ExternalCrypto Property (RESTClient Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

Please refer to the ExternalCrypto type for a complete list of fields.

FIPSMode Property (RESTClient Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

KeepAlivePolicy Property (RESTClient Class)

Defines the keep-alive handling policy.

Syntax

public int getKeepAlivePolicy();


public void setKeepAlivePolicy(int keepAlivePolicy);


Enumerated values:
  public final static int ckapStandardDefined = 0;
  public final static int ckapPreferKeepAlive = 1;
  public final static int ckapRelyOnServer = 2;
  public final static int ckapKeepAlivesDisabled = 3;

Default Value

0

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.

KnownCertificates Property (RESTClient Class)

Additional certificates for chain validation.

Syntax

public CertificateList getKnownCertificates();


public void setKnownCertificates(CertificateList knownCertificates);

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

KnownCRLs Property (RESTClient Class)

Additional CRLs for chain validation.

Syntax

public CRLList getKnownCRLs();


public void setKnownCRLs(CRLList knownCRLs);

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

Please refer to the CRL type for a complete list of fields.

KnownOCSPs Property (RESTClient Class)

Additional OCSP responses for chain validation.

Syntax

public OCSPResponseList getKnownOCSPs();


public void setKnownOCSPs(OCSPResponseList knownOCSPs);

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

Please refer to the OCSPResponse type for a complete list of fields.

OutputBytes Property (RESTClient Class)

Contains the response content.

Syntax

public byte[] getOutputBytes();

Remarks

Use this property to access the content received from the server in response to a prior request.

This property is read-only and not available at design time.

OutputString Property (RESTClient Class)

Contains the response content.

Syntax

public String getOutputString();

Default Value

""

Remarks

Use this property to access the content received from the server in response to a prior request, as a string.

This property is read-only and not available at design time.

Proxy Property (RESTClient Class)

The proxy server settings.

Syntax

public ProxySettings getProxy();

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Please refer to the ProxySettings type for a complete list of fields.

ReasonPhrase Property (RESTClient Class)

Contains the Reason Phrase element of the server's response.

Syntax

public String getReasonPhrase();

Default Value

""

Remarks

Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).

This property is read-only and not available at design time.

RequestHeaders Property (RESTClient Class)

Contains HTTP request headers.

Syntax

public StringNameValuePairList getRequestHeaders();

Remarks

Use this property to check and/or adjust the HTTP request headers from your HeadersPrepared event handler.

This property is read-only and not available at design time.

Please refer to the StringNameValuePair type for a complete list of fields.

RequestParameters Property (RESTClient Class)

Provides access to common HTTP request properties.

Syntax

public HTTPRequestParameters getRequestParameters();


public void setRequestParameters(HTTPRequestParameters requestParameters);

Remarks

Use this property to configure the HTTP request properties.

This property is not available at design time.

Please refer to the HTTPRequestParameters type for a complete list of fields.

ResponseHeaders Property (RESTClient Class)

Contains the HTTP server's response headers.

Syntax

public StringNameValuePairList getResponseHeaders();

Remarks

Use this property to check the headers of the HTTP response received from the server. The headers become available as soon as HeadersReceived event is fired.

This property is read-only and not available at design time.

Please refer to the StringNameValuePair type for a complete list of fields.

ResponseParameters Property (RESTClient Class)

Contains the HTTP server's response parameters.

Syntax

public HTTPResponseParameters getResponseParameters();

Remarks

Use this property to access the properties of the received HTTP response.

This property is read-only and not available at design time.

Please refer to the HTTPResponseParameters type for a complete list of fields.

ServerChain Property (RESTClient Class)

The TLS server's certificate chain.

Syntax

public CertificateList getServerChain();

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when OnCertificateValidate event is fired by the client component.

This property is read-only and not available at design time.

Please refer to the Certificate type for a complete list of fields.

SocketSettings Property (RESTClient Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Please refer to the SocketSettings type for a complete list of fields.

StatusCode Property (RESTClient Class)

Contains the Status Code element of the server's response.

Syntax

public int getStatusCode();

Default Value

0

Remarks

Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).

This property is read-only and not available at design time.

TLSSettings Property (RESTClient Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Please refer to the TLSSettings type for a complete list of fields.

TrustedCertificates Property (RESTClient Class)

A list of trusted certificates for chain validation.

Syntax

public CertificateList getTrustedCertificates();


public void setTrustedCertificates(CertificateList trustedCertificates);

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

UseDigestAuth Property (RESTClient Class)

Enables or disables the HTTP Digest authentication.

Syntax

public boolean isUseDigestAuth();


public void setUseDigestAuth(boolean useDigestAuth);

Default Value

False

Remarks

Digest authentication is more advanced than the Basic scheme, as it does not send the username and password in plain text and is immune to replay attacks.

Digest authentication is standardized in RFC 2617.

UseNTLMAuth Property (RESTClient Class)

Enables or disables NTLM authentication.

Syntax

public boolean isUseNTLMAuth();


public void setUseNTLMAuth(boolean useNTLMAuth);

Default Value

False

Remarks

NT LAN Manager (NTLM) authentication relies on Windows credentials to authenticate the user, and requires multiple exchanges between the client and server. Generally it is considered more secure and SSO-friendly than the Digest authentication.

Config Method (Restclient Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Delete Method (Restclient Class)

Sends a DELETE request to the server.

Syntax

public void delete(String url);

Remarks

Use this method to send a DELETE request to server. In response to this request, the server may (without any guarantees) delete the resource specified in Url. Most of the servers disable DELETE requests.

If this request fails, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

DoAction Method (Restclient Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Get Method (Restclient Class)

Sends a GET request to the server.

Syntax

public void get(String url);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the received content will be available in OutputBytes and OutputString properties. Otherwise an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

GetBytes Method (Restclient Class)

Sends a GET request to the server and returns the output.

Syntax

public byte[] getBytes(String url);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the method returns the received content. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

GetFile Method (Restclient Class)

Sends a GET request to the server and saves the output to a file.

Syntax

public void getFile(String url, String filename);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the received content will be saved to Filename. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

GetStream Method (Restclient Class)

Sends a GET request to the server and saves the output in a stream.

Syntax

public void getStream(String url, java.io.OutputStream outputStream);

Remarks

GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.

If the request is successful, the method saves the received content to OutputStream. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Head Method (Restclient Class)

Sends a HEAD request to the server.

Syntax

public void head(String url);

Remarks

HEAD is very similar to GET, with the only difference being that only the headers (but not the content) is returned.

HEAD is often use to retrieve the parameters of the resource, such as its size and modification date. If the request is successful, those details will be available via ResponseParameters and ResponseHeaders properties. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Options Method (Restclient Class)

Sends an OPTIONS request to the server.

Syntax

public void options(String url);

Remarks

This request gets various information about the server such as supported HTTP methods. No content is included in the response.

Post Method (Restclient Class)

Sends a POST request to the server.

Syntax

public void post(String url, String content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostBytes Method (Restclient Class)

Sends a POST request to the server.

Syntax

public void postBytes(String url, byte[] contentBytes);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the ContentBytes parameter. If content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostFile Method (Restclient Class)

Sends a file to the server using a POST request.

Syntax

public void postFile(String url, String filename);

Remarks

POST is used to send data to the remote HTTP endpoint/script. The content to send will be taken from Filename.

To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostJSON Method (Restclient Class)

Sends a JSON POST request to the server.

Syntax

public void postJSON(String url, String content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the JSON data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a regular (non-JSON) data, use Post method. To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostStream Method (Restclient Class)

Sends a POST request to the server.

Syntax

public void postStream(String url, java.io.InputStream inputStream);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the data you need to send via the InputStream parameter.

To post a web form data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostWebForm Method (Restclient Class)

Posts a web form data to the server.

Syntax

public void postWebForm(String url, String fields, String fileField, String fileName, String contentType);

Remarks

This variant of the POST method provides means to submit a form (as in a web browser) with an optional file attachment. Fields are expected to contain a list of field names and values in "Name=Value" format separated with EOLs. This list can be empty.

If including a file with your request, use the FileField and FileName properties to specify the file field name and the local filename for the uploaded file. Use ContentType to override the default content type chosen by the client, e.g., "application/x-www-form-urlencoded".

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PostXML Method (Restclient Class)

Posts an XML request to the server.

Syntax

public void postXML(String url, String content);

Remarks

POST is used to send data to the remote HTTP endpoint/script.

Provide the XML data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event.

To post a regular (non-XML) data, use Post method. To post a web form's data (including file attachments to the form) use PostWebForm method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Put Method (Restclient Class)

Sends a PUT request to the server.

Syntax

public void put(String url, String content);

Remarks

PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutBytes Method (Restclient Class)

Sends a PUT request to the server.

Syntax

public void putBytes(String url, byte[] contentBytes);

Remarks

PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.

If ContentBytes is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutFile Method (Restclient Class)

Sends a file to the server using a PUT request.

Syntax

public void putFile(String url, String filename);

Remarks

PUT is an alternative to POST and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. The content to send will be taken from Filename.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutJSON Method (Restclient Class)

PUTs a JSON to the server.

Syntax

public void putJSON(String url, String content);

Remarks

PUT method is used to write data to the server.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

To PUT a regular (non-JSON) data, use Put method. To post JSON data, use PostJSON method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutStream Method (Restclient Class)

Sends a PUT request to the server.

Syntax

public void putStream(String url, java.io.InputStream inputStream);

Remarks

PUT is an alternative to POST, and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off.

Provide the data you need to send via the InputStream parameter.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

PutXML Method (Restclient Class)

PUTs an XML to the server.

Syntax

public void putXML(String url, String content);

Remarks

PUT method is used to write data to the server.

If Content is not present, and only Url is set, the data will be streamed dynamically using the DynamicDataNeeded event. Note that some servers do not support streaming.

To PUT a regular (non-XML) data, use Put method. To post XML data, use PostXML method.

Note that any parameters you intend to pass to this method should be properly encoded before this method is called.

Trace Method (Restclient Class)

Sends a TRACE request to the server.

Syntax

public void trace(String url);

Remarks

TRACE is a debug command and is typically switched off and/or not supported by web servers.

Cookie Event (Restclient Class)

Fired to report a received cookie.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void cookie(RestclientCookieEvent e) {}
  ...
}

public class RestclientCookieEvent {
  public String cookieText;
}

Remarks

The CookieText parameter contains the text of the cookie.

DocumentBegin Event (Restclient Class)

Marks the start of the incoming HTML document or file.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void documentBegin(RestclientDocumentBeginEvent e) {}
  ...
}

public class RestclientDocumentBeginEvent {
}

Remarks

This event is followed by one or more Progress calls. When the document has been received in full, the DocumentEnd event is fired.

DocumentEnd Event (Restclient Class)

Marks the successful receipt of the incoming HTML document or file.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void documentEnd(RestclientDocumentEndEvent e) {}
  ...
}

public class RestclientDocumentEndEvent {
}

Remarks

This event fires when the document has been received in full.

DynamicDataNeeded Event (Restclient Class)

Requests a portion of data to be uploaded from the application.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void dynamicDataNeeded(RestclientDynamicDataNeededEvent e) {}
  ...
}

public class RestclientDynamicDataNeededEvent {
  public int bytesNeeded;
}

Remarks

If dynamic ('streaming') variants of PUT or POST methods are used, this event is fired periodically to request portions of data to be sent to the server.

When handling this event, assign the next portion of data of BytesNeeded length (or less) to DynamicData. If no more data is available to upload (the whole document has been sent), leave DynamicData empty.

Error Event (Restclient Class)

Information about errors during data delivery.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void error(RestclientErrorEvent e) {}
  ...
}

public class RestclientErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The event is fired in case of exceptional conditions during message processing.

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

ExternalSign Event (Restclient Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void externalSign(RestclientExternalSignEvent e) {}
  ...
}

public class RestclientExternalSignEvent {
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData;
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

HeadersPrepared Event (Restclient Class)

Fires when the request headers have been formed and are about to be sent to the server.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void headersPrepared(RestclientHeadersPreparedEvent e) {}
  ...
}

public class RestclientHeadersPreparedEvent {
}

Remarks

The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.

HeadersReceived Event (Restclient Class)

Fires when the HTTP response headers have just been received from the server.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void headersReceived(RestclientHeadersReceivedEvent e) {}
  ...
}

public class RestclientHeadersReceivedEvent {
}

Remarks

The received headers are available via the ResponseHeaders property.

Notification Event (Restclient Class)

This event notifies the application about an underlying control flow event.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void notification(RestclientNotificationEvent e) {}
  ...
}

public class RestclientNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (Restclient Class)

Fires periodically during the data transfer.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void progress(RestclientProgressEvent e) {}
  ...
}

public class RestclientProgressEvent {
  public long total;
  public long current;
  public boolean cancel;
}

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

Redirection Event (Restclient Class)

Fires when the server suggests a redirect.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void redirection(RestclientRedirectionEvent e) {}
  ...
}

public class RestclientRedirectionEvent {
  public String oldURL;
  public String newURL;
  public boolean allowRedirection;
}

Remarks

This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.

Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.

TLSCertNeeded Event (Restclient Class)

Fires when a remote TLS party requests a client certificate.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void TLSCertNeeded(RestclientTLSCertNeededEvent e) {}
  ...
}

public class RestclientTLSCertNeededEvent {
  public String host;
  public String CANames;
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (Restclient Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void TLSCertValidate(RestclientTLSCertValidateEvent e) {}
  ...
}

public class RestclientTLSCertValidateEvent {
  public String serverHost;
  public String serverIP;
  public boolean accept;
}

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (Restclient Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void TLSEstablished(RestclientTLSEstablishedEvent e) {}
  ...
}

public class RestclientTLSEstablishedEvent {
  public String host;
  public String version;
  public String ciphersuite;
  public byte[] connectionId;
  public boolean abort;
}

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (Restclient Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void TLSHandshake(RestclientTLSHandshakeEvent e) {}
  ...
}

public class RestclientTLSHandshakeEvent {
  public String host;
  public boolean abort;
}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (Restclient Class)

Notifies the application about the PSK key exchange.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void TLSPSK(RestclientTLSPSKEvent e) {}
  ...
}

public class RestclientTLSPSKEvent {
  public String host;
  public String hint;
}

Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (Restclient Class)

Reports the graceful closure of a TLS connection.

Syntax

public class DefaultRestclientEventListener implements RestclientEventListener {
  ...
  public void TLSShutdown(RestclientTLSShutdownEvent e) {}
  ...
}

public class RestclientTLSShutdownEvent {
  public String host;
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

public Certificate( stream);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public Certificate( stream,  password);

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

ConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public ConnectionInfo();

Creates a new ConnectionInfo object.

CRL Type

Represents a Certificate Revocation List.

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Constructors

public CRL( bytes,  startIndex,  count);

Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.

public CRL( location);

Creates a CRL object by downloading it from a remote location.

public CRL( stream);

Creates a CRL object from data contained in a stream.

public CRL();

Creates an empty CRL object.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

public ExternalCrypto();

Creates a new ExternalCrypto object with default field values.

HTTPRequestParameters Type

Represents the headers of the HTTP request to make.

Remarks

If a header is not assigned but required for a successful request (such as Connection or Host), it will be generated automatically by the class.

Fields

Constructors

public HTTPRequestParameters();

Creates a new HTTPRequestParameters object.

HTTPResponseParameters Type

This object is a container for HTTP server response details.

Remarks

An HTTP response is sent by the server when it has processed the client's request. The response consists of the status code (perhaps, the most annoying and widely known one is 404), the reason phrase, the response headers, and the body (the actual data) of the response.

Fields

Constructors

public HTTPResponseParameters();

Creates a new HTTPResponseParameters object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Constructors

public OCSPResponse( bytes,  startIndex,  count);

Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.

public OCSPResponse( location);

Downloads an OCSP response from a remote location.

public OCSPResponse( stream);

Initializes the response with the data from a stream.

public OCSPResponse();

Creates an empty OCSP response object.

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Constructors

public ProxySettings();

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

Creates a new SocketSettings object.

StringNameValuePair Type

A simple name-value pair object.

Remarks

The class represents a name-value string pair used in a variety of network components.

Fields

Constructors

public StringNameValuePair( name,  value);

Creates a name-value pair from a name and a value.

public StringNameValuePair();

Creates an empty name-value object.

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public TLSSettings();

Creates a new TLSSettings object.

Config Settings (Restclient Class)

The class 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 class, access to these internal properties is provided through the Config method.

RESTClient Config Settings

Base Config Settings

Trappable Errors (Restclient Class)

HTTPClient Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	19922945   Unsupported keep-alive policy (SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY)