RESTServer Class

Properties   Methods   Events   Config Settings   Errors  

The RESTServer class supports server-side functionality of the REST protocol.

Syntax

secureblackbox.Restserver

Remarks

Use this control to add REST server functionality to your application.

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.

Active Property (RESTServer Class)

Indicates whether the server is active and is listening to new connections.

Syntax

public boolean isActive();

Default Value

False

Remarks

This read-only property returns True if the server is listening to incoming connections.

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

AllowKeepAlive Property (RESTServer Class)

Enables or disables keep-alive mode.

Syntax

public boolean isAllowKeepAlive();


public void setAllowKeepAlive(boolean allowKeepAlive);

Default Value

True

Remarks

Use this property to enable or disable the keep-alive connection mode. If keep-alive is enabled, clients that choose to use it may stay connected for a while.

AuthBasic Property (RESTServer Class)

Enables or disables basic authentication.

Syntax

public boolean isAuthBasic();


public void setAuthBasic(boolean authBasic);

Default Value

False

Remarks

Use this property to enable or disable basic user authentication in the HTTP server.

AuthDigest Property (RESTServer Class)

Enables or disables digest authentication.

Syntax

public boolean isAuthDigest();


public void setAuthDigest(boolean authDigest);

Default Value

False

Remarks

Use this property to enable or disable digest-based user authentication in the HTTP server.

AuthDigestExpire Property (RESTServer Class)

Specifies digest expiration time for digest authentication.

Syntax

public int getAuthDigestExpire();


public void setAuthDigestExpire(int authDigestExpire);

Default Value

20

Remarks

Use this property to specify the digest expiration time for digest authentication, in seconds.

AuthRealm Property (RESTServer Class)

Specifies authentication realm for digest and NTLM authentication.

Syntax

public String getAuthRealm();


public void setAuthRealm(String authRealm);

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

BoundPort Property (RESTServer Class)

Indicates the bound listening port.

Syntax

public int getBoundPort();

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

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

ClientAuth Property (RESTServer Class)

Enables or disables certificate-based client authentication.

Syntax

public int getClientAuth();


public void setClientAuth(int clientAuth);


Enumerated values:
  public final static int ccatNoAuth = 0;
  public final static int ccatRequestCert = 1;
  public final static int ccatRequireCert = 2;

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

CompressionLevel Property (RESTServer Class)

The default compression level to use.

Syntax

public int getCompressionLevel();


public void setCompressionLevel(int compressionLevel);

Default Value

6

Remarks

Assign this property with the compression level (1 to 9) to apply for gzipped responses. 1 stands for the lightest but fastest compression, and 9 for the best but the slowest.

DocumentRoot Property (RESTServer Class)

The document root of the server.

Syntax

public String getDocumentRoot();


public void setDocumentRoot(String documentRoot);

Default Value

""

Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

ErrorOrigin Property (RESTServer Class)

Indicates the endpoint where the error originates from.

Syntax

public int getErrorOrigin();


public void setErrorOrigin(int errorOrigin);


Enumerated values:
  public final static int eoLocal = 0;
  public final static int eoRemote = 1;

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

This property is not available at design time.

ErrorSeverity Property (RESTServer Class)

The severity of the error that happened.

Syntax

public int getErrorSeverity();


public void setErrorSeverity(int errorSeverity);


Enumerated values:
  public final static int esInfo = 0;
  public final static int esWarning = 1;
  public final static int esFatal = 2;

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

ExternalCrypto Property (RESTServer 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.

FIPSMode Property (RESTServer Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (RESTServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

public int getHandshakeTimeout();


public void setHandshakeTimeout(int handshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (RESTServer Class)

The host to bind the listening port to.

Syntax

public String getHost();


public void setHost(String host);

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

PinnedClient Property (RESTServer Class)

Populates the pinned client details.

Syntax

public TLSClientEntry getPinnedClient();

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

PinnedClientChain Property (RESTServer Class)

Contains the certificate chain of the pinned client.

Syntax

public CertificateList getPinnedClientChain();

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Port Property (RESTServer Class)

Specifies the port number to listen for connections on.

Syntax

public int getPort();


public void setPort(int port);

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.

PortRangeFrom Property (RESTServer Class)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

public int getPortRangeFrom();


public void setPortRangeFrom(int portRangeFrom);

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

PortRangeTo Property (RESTServer Class)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

public int getPortRangeTo();


public void setPortRangeTo(int portRangeTo);

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via Port), the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Note that this property is ignored if the Port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

ServerCertificates Property (RESTServer Class)

The server's TLS certificates.

Syntax

public CertificateList getServerCertificates();


public void setServerCertificates(CertificateList serverCertificates);

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

SessionTimeout Property (RESTServer Class)

Specifies the default session timeout value in milliseconds.

Syntax

public int getSessionTimeout();


public void setSessionTimeout(int sessionTimeout);

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

SocketSettings Property (RESTServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

TLSSettings Property (RESTServer 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.

UseChunkedTransfer Property (RESTServer Class)

Enables chunked transfer.

Syntax

public boolean isUseChunkedTransfer();


public void setUseChunkedTransfer(boolean useChunkedTransfer);

Default Value

False

Remarks

Use this property to enable chunked content encoding.

UseCompression Property (RESTServer Class)

Enables or disables server-side compression.

Syntax

public boolean isUseCompression();


public void setUseCompression(boolean useCompression);

Default Value

False

Remarks

Use this property to enable or disable server-side content compression.

Users Property (RESTServer Class)

Provides a list of registered users.

Syntax

public UserAccountList getUsers();


public void setUsers(UserAccountList users);

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the class.

This property is not available at design time.

WebsiteName Property (RESTServer Class)

Specifies the web site name to use in the certificate.

Syntax

public String getWebsiteName();


public void setWebsiteName(String websiteName);

Default Value

"SecureBlackbox"

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

Config Method (Restserver 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.

DoAction Method (Restserver 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;....

DropClient Method (Restserver Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetRequestBytes Method (Restserver Class)

Returns the contents of the client's HTTP request.

Syntax

public byte[] getRequestBytes(long connectionId, String requestFilter);

Remarks

Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The RequestFilter parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestHeader Method (Restserver Class)

Returns a request header value.

Syntax

public String getRequestHeader(long connectionId, String headerName);

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

GetRequestStream Method (Restserver Class)

Returns the contents of the client's HTTP request.

Syntax

public void getRequestStream(long connectionId, String requestFilter, java.io.OutputStream outputStream);

Remarks

Use this method to get the body of the client's HTTP request into a stream. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestString Method (Restserver Class)

Returns the contents of the client's HTTP request.

Syntax

public String getRequestString(long connectionId, String requestFilter);

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

GetRequestUsername Method (Restserver Class)

Returns the username for a connection.

Syntax

public String getRequestUsername(long connectionId);

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

GetResponseHeader Method (Restserver Class)

Returns a response header value.

Syntax

public String getResponseHeader(long connectionId, String headerName);

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

ListClients Method (Restserver Class)

Enumerates the connected clients.

Syntax

public String listClients();

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (Restserver Class)

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessGenericRequest Method (Restserver Class)

Processes a generic HTTP request.

Syntax

public byte[] processGenericRequest(long connectionId, byte[] requestBytes);

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. ConnectionId allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

ProcessGenericRequestStream Method (Restserver Class)

Processes a generic HTTP request from a stream.

Syntax

public void processGenericRequestStream(long connectionId, String requestHeaders, java.io.InputStream requestData, java.io.OutputStream responseData);

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

The method expects the request headers in RequestHeaders, and the request data is read from RequestData stream. Once the request is processed, the response headers are reported through HeadersPrepared event before any data is written to ResponseData stream. ConnectionId allows to identify the request in the events.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application.

SetResponseBytes Method (Restserver Class)

Sets a byte array to be served as a response.

Syntax

public void setResponseBytes(long connectionId, byte[] bytes, String contentType, String responseFilter);

Remarks

Use this property to provide the response content in a byte array. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseFile Method (Restserver Class)

Sets a file to be served as a response.

Syntax

public void setResponseFile(long connectionId, String fileName, String contentType, String responseFilter);

Remarks

Use this property to provide the response content in a file. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseHeader Method (Restserver Class)

Sets a response header.

Syntax

public boolean setResponseHeader(long connectionId, String headerName, String value);

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

SetResponseJSON Method (Restserver Class)

Sets a string to be served as a JSON response.

Syntax

public void setResponseJSON(long connectionId, String data, String responseFilter);

Remarks

Use this property to provide the JSON response content in a string.

SetResponseStatus Method (Restserver Class)

Sets an HTTP status to be sent with the response.

Syntax

public void setResponseStatus(long connectionId, int statusCode);

Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as GetRequest.

SetResponseStream Method (Restserver Class)

Sets a stream to be served as a response.

Syntax

public void setResponseStream(long connectionId, java.io.InputStream dataStream, boolean closeStream, String contentType, String responseFilter);

Remarks

Use this property to provide the response content in a stream. Set CloseStream to indicate that the stream should be disposed of once sent. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseString Method (Restserver Class)

Sets a string to be served as a response.

Syntax

public void setResponseString(long connectionId, String dataStr, String contentType, String responseFilter);

Remarks

Use this property to provide the response content in a string. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

SetResponseXML Method (Restserver Class)

Sets a string to be served as an XML response.

Syntax

public void setResponseXML(long connectionId, String data, String responseFilter);

Remarks

Use this property to provide the XML response content in a string.

Start Method (Restserver Class)

Starts the server.

Syntax

public void start();

Remarks

Use this method to activate the server and start listening to incoming connections.

Stop Method (Restserver Class)

Stops the server.

Syntax

public void stop();

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Accept Event (Restserver Class)

Reports an incoming connection.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void accept(RestserverAcceptEvent e) {}
  ...
}

public class RestserverAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept;
}

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AuthAttempt Event (Restserver Class)

Fires when a connected client makes an authentication attempt.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void authAttempt(RestserverAuthAttemptEvent e) {}
  ...
}

public class RestserverAuthAttemptEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public String authMethod;
  public String username;
  public String password;
  public boolean allow;
}

Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

Connect Event (Restserver Class)

Reports an accepted connection.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void connect(RestserverConnectEvent e) {}
  ...
}

public class RestserverConnectEvent {
  public long connectionID;
  public String remoteAddress;
  public int remotePort;
}

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or AuthAttempt.

CustomRequest Event (Restserver Class)

Reports a request of a non-standard type (method).

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void customRequest(RestserverCustomRequestEvent e) {}
  ...
}

public class RestserverCustomRequestEvent {
  public long connectionID;
  public String URI;
  public String HTTPMethod;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a non-standard request received from the client. The HTTPMethod contains the non-standard HTTP method.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Data Event (Restserver Class)

Supplies a data chunk received within a POST or PUT upload.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void data(RestserverDataEvent e) {}
  ...
}

public class RestserverDataEvent {
  public long connectionID;
  public byte[] buffer;
}

Remarks

This event is fired to supply another piece of data received within a POST or PUT upload operation. This event may fire multiple times during a single request upload to pass the uploaded data to the application chunk-by-chunk.

DeleteRequest Event (Restserver Class)

Reports a DELETE request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void deleteRequest(RestserverDeleteRequestEvent e) {}
  ...
}

public class RestserverDeleteRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a DELETE request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Disconnect Event (Restserver Class)

Fires to report a disconnected client.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void disconnect(RestserverDisconnectEvent e) {}
  ...
}

public class RestserverDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Error Event (Restserver Class)

Information about errors during data delivery.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void error(RestserverErrorEvent e) {}
  ...
}

public class RestserverErrorEvent {
  public long connectionId;
  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 (Restserver Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void externalSign(RestserverExternalSignEvent e) {}
  ...
}

public class RestserverExternalSignEvent {
  public long connectionID;
  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:

 
 Copy
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();
};

FileError Event (Restserver Class)

Reports a file access error to the application.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void fileError(RestserverFileErrorEvent e) {}
  ...
}

public class RestserverFileErrorEvent {
  public long connectionID;
  public String fileName;
  public int errorCode;
}

Remarks

The class uses this event to report a file access errors. FileName and ErrorCode contain the file path and the error code respectively.

GetRequest Event (Restserver Class)

Reports a GET request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void getRequest(RestserverGetRequestEvent e) {}
  ...
}

public class RestserverGetRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a GET request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, SetResponseFile or SetResponseString methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

HeadersPrepared Event (Restserver Class)

Fires when the response headers have been formed and are ready to be sent to the server.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void headersPrepared(RestserverHeadersPreparedEvent e) {}
  ...
}

public class RestserverHeadersPreparedEvent {
  public long connectionID;
}

Remarks

The class fires this event when the response headers are ready to be sent to the server. ConnectionID indicates the connection that processed the request.

Use GetResponseHeader method with an empty header name to get the whole response header.

HeadRequest Event (Restserver Class)

Reports a HEAD request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void headRequest(RestserverHeadRequestEvent e) {}
  ...
}

public class RestserverHeadRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a HEAD request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

Notification Event (Restserver Class)

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

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void notification(RestserverNotificationEvent e) {}
  ...
}

public class RestserverNotificationEvent {
  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.

OptionsRequest Event (Restserver Class)

Reports an OPTIONS request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void optionsRequest(RestserverOptionsRequestEvent e) {}
  ...
}

public class RestserverOptionsRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about an OPTIONS request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

PatchRequest Event (Restserver Class)

Reports a PATCH request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void patchRequest(RestserverPatchRequestEvent e) {}
  ...
}

public class RestserverPatchRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a PATCH request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

PostRequest Event (Restserver Class)

Reports a POST request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void postRequest(RestserverPostRequestEvent e) {}
  ...
}

public class RestserverPostRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a POST request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

PutRequest Event (Restserver Class)

Reports a PUT request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void putRequest(RestserverPutRequestEvent e) {}
  ...
}

public class RestserverPutRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a PUT request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

ResourceAccess Event (Restserver Class)

Reports an attempt to access a resource.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void resourceAccess(RestserverResourceAccessEvent e) {}
  ...
}

public class RestserverResourceAccessEvent {
  public long connectionID;
  public String HTTPMethod;
  public String URI;
  public boolean allow;
  public String redirectURI;
}

Remarks

The class fires this event to notify the application about a request received from the client. The HTTPMethod parameter indicates the HTTP method used (GET, POST, etc.)

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Allow to false to prevent the client from accessing the resource. The class will automatically send a "forbidden" status code (403).

Set a non-empty value to RedirectURI to notify the client that the resource has moved to another place. The class will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

TLSCertValidate Event (Restserver Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void TLSCertValidate(RestserverTLSCertValidateEvent e) {}
  ...
}

public class RestserverTLSCertValidateEvent {
  public long connectionID;
  public boolean accept;
}

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (Restserver Class)

Reports the setup of a TLS session.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void TLSEstablished(RestserverTLSEstablishedEvent e) {}
  ...
}

public class RestserverTLSEstablishedEvent {
  public long connectionID;
}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (Restserver Class)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void TLSHandshake(RestserverTLSHandshakeEvent e) {}
  ...
}

public class RestserverTLSHandshakeEvent {
  public long connectionID;
  public String serverName;
  public boolean abort;
}

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (Restserver Class)

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void TLSPSK(RestserverTLSPSKEvent e) {}
  ...
}

public class RestserverTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK;
  public String ciphersuite;
}

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (Restserver Class)

Reports closure of a TLS session.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void TLSShutdown(RestserverTLSShutdownEvent e) {}
  ...
}

public class RestserverTLSShutdownEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

TraceRequest Event (Restserver Class)

Reports a TRACE request.

Syntax

public class DefaultRestserverEventListener implements RestserverEventListener {
  ...
  public void traceRequest(RestserverTraceRequestEvent e) {}
  ...
}

public class RestserverTraceRequestEvent {
  public long connectionID;
  public String URI;
  public boolean handled;
}

Remarks

The class fires this event to notify the application about a TRACE request received from the client.

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Handled to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via SetResponseStatus, SetResponseHeader, and SetResponseFile methods. If the returned value of Handled is false, the server will try to take care of the request automatically by searching for the requested resource in DocumentRoot.

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.

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

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Constructors

public ExternalCrypto();

Creates a new ExternalCrypto object with default field values.

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.

TLSClientEntry Type

A container for a connected TLS client's details.

Remarks

Use this property to access the details of a particular connected client.

Fields

Constructors

public TLSClientEntry();

Creates a new TLSClientEntry 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.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

public UserAccount();

Creates a new UserAccount object.

Config Settings (Restserver Class)

RESTServer Config Settings

Base Config Settings