I2Rest Gate URL definition using Unix socket - Revision history

Pavel.lobko at 11:20, 9 July 2020

2020-07-09T11:20:46Z

Pavel.lobko at 11:19, 9 July 2020

2020-07-09T11:19:26Z

Alexei.baranov at 06:36, 8 July 2020

2020-07-08T06:36:33Z

Pavel.lobko at 12:35, 6 July 2020

2020-07-06T12:35:01Z

Pavel.lobko at 11:38, 30 June 2020

2020-06-30T11:38:49Z

Pavel.lobko at 11:38, 30 June 2020

2020-06-30T11:38:32Z

Pavel.lobko at 11:38, 30 June 2020

2020-06-30T11:38:04Z

Pavel.lobko at 11:36, 30 June 2020

2020-06-30T11:36:18Z

Pavel.lobko at 11:34, 30 June 2020

2020-06-30T11:34:00Z

Pavel.lobko at 11:33, 30 June 2020

2020-06-30T11:33:24Z

@@ Line 15: / Line 15: @@
 ;Step 2
-:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Сopy and paste the snippet bellow. Replace with appropriate values highlighted with <b>bold</b> parts: host_name, ports, IFS file, pcml.<br>''Note that IFS file folder must exist, but the file must not. i2Rest Server will create this file automatically.''<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Сopy and paste the snippet bellow. Replace with appropriate values highlighted with <b>bold</b> parts: host_name, ports, IFS file, pcml_file.<br>''Note that IFS file folder must exist, but the file must not. i2Rest Server will create this file automatically.''<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+  {

@@ Line 15: / Line 15: @@
 ;Step 2
-:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports pcml_file and IFS file (highlighted with <b>bold</b>) with appropriate values.<br/>''Note that IFS file folder must exist, but the file must not. i2Rest Server will create this file automatically.''<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Сopy and paste the snippet bellow. Replace with appropriate values highlighted with <b>bold</b> parts: host_name, ports, IFS file, pcml.<br>''Note that IFS file folder must exist, but the file must not. i2Rest Server will create this file automatically.''<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+  {

@@ Line 1: / Line 1: @@
-[[I2Rest_Gates#i2Rest_Gates|i2Rest Server Gates]] are able to listen incoming requests at some unix socket defined as a file at IFS. In this case, the server gate will not be accessible externally, so your i2Rest Server instance and its clients both should be located on the same IBM i server. As an example of such a case -  [[I2Rest_anonymous_sessions|Anonymous session]] (which is an IBM i job serving request to ECHO test program), and i2Rest Session Gate (which is the internal endpoint requested by submited sessions).<br>
+{{DISPLAYTITLE:Serving incoming connections using Unix sockets}}
-In the basic configuration Session Gate is defined by default - when i2Rest Server can't find configuration for some gate, it creates temporary unix socket endpoint at /tmp folder, for example /tmp/AS5WRD7DCJ.<br> Configuration bellow shows how to [[Gate_object|define I2Rest Gate]] URL using Unix socket explicitly.
+[[I2Rest_Gates#i2Rest_Gates|i2Rest Server Gates]] are able to listen incoming requests at some unix socket defined as a file at IFS. In this case, the server gate will not be accessible externally, so your i2Rest Server instance and its clients both should be located on the same IBM i server. This is typically used for interaction of i2Rest Server and local session jobs.<br/>
 ;Step 1
-:Create text file named I2RESTECHO.PCML anywhere on IFS, for example "/tmp/PCML/i2restecho.pcml". Copy and paste following code. It represents a description for the sample program I2RESTECHO, that is included into i2Rest Server installation for demonstration purposes:
+:''This step is the same as in the basic example. You can skip this step if you've done the basic scenario.''<br/>Create text file named I2RESTECHO.PCML anywhere on IFS, for example "/tmp/PCML/i2restecho.pcml". Copy and paste following code. It represents a description for the sample program I2RESTECHO, that is included into i2Rest Server installation for demonstration purposes:
 <pre>
 <pcml version="1.0">
@@ Line 14: / Line 15: @@
 ;Step 2
-:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports and pcml_file with appropriate values.
+:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports pcml_file and IFS file (highlighted with <b>bold</b>) with appropriate values.<br/>''Note that IFS file folder must exist, but the file must not. i2Rest Server will create this file automatically.''<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+  {
@@ Line 21: / Line 21: @@
+     {
         "main"       : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:1234)'''"},
-        "management" : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:4321)'''"},
+        "management" : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:4321)'''"}<span style="background:#D3D3D3;">,
-       <span style="background:#D3D3D3;">"session"    : {"url":"file://'''<IFS file> (for example /i2Rest/Session)'''"}</span>
+       "session"    : {"url":"file://'''<IFS file> (for example /i2Rest/Session)'''"}</span>
      },
      "session_systems":

@@ Line 15: / Line 15: @@
 ;Step 2
 :Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports and pcml_file with appropriate values.
-[[I2Rest_quick_config|Basic configuration]] with Unix socket defined gate (differences are highlighted in <span style="background:#00FFFF;">blue</span>):
+[[I2Rest_quick_config|Basic configuration]] with Unix socket defined gate (differences are highlighted in <span style="background:#D3D3D3;">gray</span>):
+  {
      "gates":
+     {
-        "main"       : {"url":"http://<span style="color:red;"><host_name>[:port] (for example api.i2rest.com:1234)</span>"},
+        "main"       : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:1234)'''"},
-        "management" : {"url":"http://<span style="color:red;"><host_name>[:port] (for example api.i2rest.com:4321)</span>"},
+        "management" : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:4321)'''"},
-        <span style="background:#00FFFF;">"session"    : {"url":"file://<span style="color:red;"><IFS file> (for example /i2Rest/Session)</span>"}</span>
+        <span style="background:#D3D3D3;">"session"    : {"url":"file://'''<IFS file> (for example /i2Rest/Session)'''"}</span>
      },
      "session_systems":
@@ Line 41: / Line 41: @@
+        {
            "pcml_mount"         : "echo",
-           "pcml_file"          : "<span style="color:red;"><complete name of i2restecho.pcml on IFS (for example /tmp/PCML/i2restecho.pcml)></span>",
+           "pcml_file"          : "'''<complete name of i2restecho.pcml on IFS (for example /tmp/PCML/i2restecho.pcml)>'''",
            "valid_in_anonymous" : true
+        }
+     ]
+  }

@@ Line 1: / Line 1: @@
 [[I2Rest_Gates#i2Rest_Gates|i2Rest Server Gates]] are able to listen incoming requests at some unix socket defined as a file at IFS. In this case, the server gate will not be accessible externally, so your i2Rest Server instance and its clients both should be located on the same IBM i server. As an example of such a case -  [[I2Rest_anonymous_sessions|Anonymous session]] (which is an IBM i job serving request to ECHO test program), and i2Rest Session Gate (which is the internal endpoint requested by submited sessions).<br>
-In the basic configuration Session Gate is defined by default - when i2Rest Server can't find configuration for some gate, it creates temporary unix socket endpoint at /tmp folder, for example /tmp/AS5WRD7DCJ.<br> Configuration bellow shows how to [[define Gate_object|I2Rest Gate]] URL using Unix socket explicitly.
+In the basic configuration Session Gate is defined by default - when i2Rest Server can't find configuration for some gate, it creates temporary unix socket endpoint at /tmp folder, for example /tmp/AS5WRD7DCJ.<br> Configuration bellow shows how to [[Gate_object|define I2Rest Gate]] URL using Unix socket explicitly.
 ;Step 1
 :Create text file named I2RESTECHO.PCML anywhere on IFS, for example "/tmp/PCML/i2restecho.pcml". Copy and paste following code. It represents a description for the sample program I2RESTECHO, that is included into i2Rest Server installation for demonstration purposes: