Enabling the HTTP interface and OSLC interface in the ObjectServer

The ObjectServer HTTP and OSLC interfaces are disabled by default, because the interfaces need to be configured for a secure setup.

Before you begin

Work out which ObjectServers in your environment need to be accessed via HTTP or HTTPS. Not all ObjectServers in an environment need to grant access to ObjectServer data through an HTTP-based mechanism.

About this task

Because the hosting of the HTTP and OSLC interfaces in the ObjectServer requires an embedded HTTP server, the ObjectServer can serve files to HTTP clients. Although the ObjectServer can serve pages, it is not optimized for page-serving, unlike an Apache web server. For this reason, do not use the ObjectServer to host anything other than rudimentary HTML or JavaScript pages.

Procedure

  1. To enable the interfaces, set the NRestOS.Enable property to TRUE.
  2. To configure the embedded HTTP server so that the interfaces are active on an HTTP port, specify the listening port for the connection type.
    For example, to make the interfaces listen on port 8080, set the properties as follows:
    NHttpd.EnableHTTP : TRUE
    NHttpd.ListeningPort : 8080
  3. If you want the interfaces to be active on an HTTPS port on 9090, set the properties that are shown in the following example.
    Because an HTTPS port is SSL encrypted, a certificate file that contains an appropriate certificate needs to be created and protected by a password.
    NHttpd.SSLEnable : TRUE
    NHttpd.SSLListeningPort : 9090
    NHttpd.SSLCertificate : “certificatelabel
  4. To enable file-serving from the ObjectServer, set the NHttpd.EnableFileServing property.
    The root of the served pages is defined by the NHttpd.DocumentRoot property.
  5. To generate the members resource reference list in the RDF/XML payload of Event, Journal, and Detail query capability responses in both Collection and ResponseInfo resource instances, set the NRestOS.OSLCRDFMsgFormat to MIGRATION.
    For more information about this parameter and why you might need to set it, see the section Updates to the HTTP interface and OSLC interface in the Release Notes.