Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Orion/Server API/Site Configuration API

The Site Configuration API is a web server API for creating, editing, starting and stopping site configurations. A site configuration is a set of URI-mapping rules that allow users to run files from their Orion workspace, or remote URLs, as a "hosted site" — that is, a virtual host on an Orion server.


Setting up hosting

To successfully start a site, the Orion server must be correctly configured for hosting. If you don't configure it yourself, it uses some default settings, which will work if you're running the server locally under Windows or Linux (not Mac OS). For any other cases, you'll need to configure it yourself: see Server admin guide:Configuring virtual host names.

Status codes

The following HTTP response status codes may be returned by this API:

  • 200 OK for most requests that succeeded.
  • 201 Created when a site configuration was created successfully.
  • 400 Bad Request when any of the request URI, request headers, or request body is malformed, or missing required information.
  • 404 Not Found when the site configuration id given in the request URI does not exist.
  • 500 Internal Server Error when a request is made to start a site, but a problem with the server's hosting configuration prevented it from being started.

Whenever a 4xx status code is returned, the response body will contain detailed information about the error. See Server_API#Exception_Handling for a full explanation.

Actions

Getting all site configurations

Overview
To retrieve all the logged-in-user's site configurations, send GET to the site config API.
HTTP Method
GET
Example Request
GET /site
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 333

{
   "SiteConfigurations": [
       {
           "HostingStatus": {
               "Status": "stopped"
           },
           "Id": "G",
           "Location": "http://localhost:8080/site/G",
           "Mappings": [
               {
                   "Source": "/",
                   "Target": "/I" 
               },
               {
                   "Source": "/github",
                   "Target": "http://mamacdon.github.com" 
               } 
           ],
           "Name": "SiteConfig",
           "Workspace": "A"
       }
   ]}
Detailed Explanation
On success, the response body contains the JSON representation of all the logged-in user's site configurations. The representation is of type Site configurations list.


Getting a single site configuration

Overview
To retrieve a single site configuration, send GET to its location.
HTTP Method
GET
Example Request
GET /site/{:site_id}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 307

{
 "HostingStatus" : {
   "Status" : "stopped"
 },
 "Id" : "G",
 "Location" : "http://localhost:8080/site/G",
 "Mappings" : [ {
   "Source" : "/",
   "Target" : "/I"
 }, {
   "Source" : "/github",
   "Target" : "http://mamacdon.github.com"
 } ],
 "Name" : "MarkConfig",
 "Workspace" : "A"
}
Detailed Explanation
On success, the response body contains the JSON representation of the site configuration. The representation is of type Site configuration.


Creating a site configuration

Overview
To create a site configuration, send POST to the site configuration API.
HTTP Method
POST
Example Request
POST /site
Slug: My site configuration

{
 "Workspace" : "A"
}
Example Response
HTTP/1.1 201 Created
Content-Type: application/json; charset=UTF-8
Content-Length: 176

{
  "HostingStatus" : {
    "Status" : "stopped"
  },
  "Id" : "d",
  "Location" : "http://localhost:8080/site/d",
  "Mappings" : [ ],
  "Name" : "My site configuration",
  "Workspace" : "A"
}
Detailed Explanation
The Slug header contains the name of the site configuration to be created. If the Slug header is not present, there must instead be a Name field in the request body giving the name.

The request body must contain a Workspace field, whose value gives the nonnull, nonempty workspace id that the site configuration is associated to. Minimally, name and workspace are required to create a site configuration. Other fields may optionally be included; see Site configuration for a full list.

On success, the response body contains the representation of the site configuration that was created. The representation type is Site configuration.


Editing a site configuration

Overview
To update one or more fields of a site configuration, send PUT to the site configuration's location.
HTTP Method
PUT
Example Request
PUT /site/{:site_id}
Content-Type: application/json

{
  "Name": "New name for my site configuration"
}
Example Response
HTTP/1.1 HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 189

{
  "HostingStatus" : {
    "Status" : "stopped"
  },
  "Id" : "d",
  "Location" : "http://localhost:8080/site/d",
  "Mappings" : [ ],
  "Name" : "New name for my site configuration",
  "Workspace" : "A"
}
Detailed Explanation
The request body contains the fields of the site configuration that will be updated and their new values. If Name or Workspace fields appear in the request body, then their values must be nonnull and nonempty. On success, the response body contains the updated site configuration. The representation type of the response body is Site configuration.

For a detailed explanation of how to update the HostingStatus field, see the following two sections about starting and stopping.


Starting a site configuration

Overview
To start a site configuration, send PUT to the site configuration's location with a HostingStatus in the body that has its Status field set to "started".
HTTP Method
PUT
Example Request
PUT /site/{:site_id}

{
  "HostingStatus" : {
    "Status" : "started",
  }
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 353

{
  "HostingStatus" : {
    "Status" : "started",
    "URL" : "http://127.0.0.102:8080"
  },
  "Id" : "G",
  "Location" : "http://localhost:8080/site/G",
  "Mappings" : [ {
    "Source" : "/",
    "Target" : "/I"
  }, {
    "Source" : "/github",
    "Target" : "http://mamacdon.github.com"
  } ],
  "Name" : "MarkConfig",
  "Workspace" : "A"
}
Detailed Explanation
Successful start of the site configuration is indicated by a 200 OK response. The response body gives the JSON representation of the site configuration (see Site configuration), and will include a URL field in the HostingStatus. The URL gives the web URL at which the running site can be accessed.

Possible error responses include:

  • 400 Bad Request — If a bogus value was provided in the Status field of the request.
  • 500 Internal Server Error — If the site couldn't be started because no virtual host name was available to assign to it. This usually indicates a problem with the server's hosting configuration that must be fixed by the server administrator (see Server admin guide).


Stopping a site configuration

Overview
To stop a site configuration, send PUT to the site configuration's location, with a HostingStatus field in the request JSON that has its Status field set to "stopped".
HTTP Method
PUT
Example Request
PUT /site/{:site_id}

{
  "HostingStatus" : {
    "Status" : "stopped",
  }
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 307

{
  "HostingStatus" : {
    "Status" : "stopped"
  },
  "Id" : "G",
  "Location" : "http://localhost:8080/site/G",
  "Mappings" : [ {
    "Source" : "/",
    "Target" : "/I"
  }, {
    "Source" : "/github",
    "Target" : "http://mamacdon.github.com"
  } ],
  "Name" : "MarkConfig",
  "Workspace" : "A"
}
Detailed Explanation
Successful stop of the site configuration is indicated by a 200 OK response. The response body gives the JSON representation of the site configuration (see Site configuration).

Possible error responses include:

  • 400 Bad Request — If a bogus value was provided in the Status field of the request.


Deleting a site configuration

Overview
To delete a site configuration, send DELETE to the site configuration's location.
HTTP Method
DELETE
Example Request
DELETE /site/{:site_id}
Example Response
HTTP/1.1 200 OK
Content-Length: 0
Detailed Explanation
Successful deletion is indicated by a 200 OK response. Deleting a non-existent resource fails with a 404 Not Found response.
TODO: Should success be indicated by 204 No Content instead?


JSON representations

Site configuration

Field Data type Value
Id string Globally unique id of the site configuration.
Location string The URL of this site configuration resource.
Name string The name of the site configuration.
Workspace string The Id of the Workspace that the site configuration is associated to.
Mappings Array Mappings defined by the site configuration.
Each element of the array is a Mappings object (see Mapping).
HostHint string A hint used to determine what the hostname for the site configuration will be when launched.
(Only relevant when a hosting subdomain has been configured on the server.)
HostingStatus object Details about the hosting status of this site configuration. (See Hosting Status.)


Mapping

Field Data type Value
Source string The source path.
Begins with a slash, and gives a request path on the running site configuration which will be mapped to the Target path.
Target string The path to which requests matching the Source field will be mapped.
This can be an absolute path to a resource in the Orion user's workspace. Alternately, it may be a web URL.

Examples of Source paths:

  • "/" would map requests for the root of the site (/).
  • "/index.html" would map requests for the index page (/index.html) of the site.


Examples of Target paths:


Hosting Status

If present, the HostingStatus object within the JSON representation of the site configuration may contain the following fields:

Field Data type Value
Status string started or stopped.
URL string The URL where the hosted site can be accessed.
(This field is only present when Status is started).

Site configurations list

Field Data type Value
SiteConfigurations Array The site configurations.
Each element of the array is a site configuration object (see Site configuration).


See also

Retrieved from "http://wiki.eclipse.org/index.php?title=Orion/Server_API/Site_Configuration_API&oldid=417234"

This page was last modified 10:02, 25 May 2017 by Eclipsepedia anonymous user Unnamed Poltroon.

Back to the top