WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:NKPProtocolRequest
Description:issue adhoc SOURCE protocol requests to an nkp:// Server
Id:NKPProtocolRequest
Category:accessor
Identifier Syntax

NKPProtocolRequest is an accessor using a standard identifier grammar:

<grammar>
  <group>
    <group name="base">
      <regex>nkp[s]?+://.*?/</regex>
    </group>
    <group name="path">
      <regex type="anything" />
    </group>
  </group>
</grammar>

with the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
baseString (unknown)(no description available)
pathString (anything)(no description available)
Request Verbs

The following verbs are supported:

Verbs
SOURCESINKEXISTSDELETENEW
Response

The response representation of this accessor for SOURCE requests is unknown.

This accessor throws no documented exceptions.

Import Requirements

To use NKPProtocolRequest accessor you must import the module urn:com:ten60:netkernel:nkp:

<import>
  <uri>urn:com:ten60:netkernel:nkp</uri>
</import>

nkp://

This endpoint provides a protocol handler for the nkp:// scheme. It essentially offers a shorthand alias for the full active:NKPRequest. Requests for the nkp:// scheme are treated as oneshot.

nkp:// URI scheme consists of scheme identifier, host and port followed by an arbitrary path

nkp://host:port/path

This URI is used to construct an NKP client connection to the NKP server at host:port. The path of the nkp: URI is converted to a generic res:/ request which is issued into the server's NKP host space. [ You can use the active:NKPRequest if you require the full richness of general declarative requests on the server side. ]

Example

If you have an NKP server on host myhost.com at port 10601 and which has an endpoint resolving "res:/some/service" then you can make a one-shot request for this resource with

SOURCE nkp://myhost.com:10601/some/service

which becomes on the NKP serverside...

SOURCE res:/some/service

nkps:// TLS/SSL

By using the nkps:// scheme you indicate that the endpoint should negotiate TLS encryption of the connection to the NKP server.

Configuration res:/etc/NKPClientConfig.xml

You must provide in the client-side address space a resource res:/etc/NKPClientConfig.xml. This contains detailed configuration state for the NKP connection which the nkp:// request will use.

The configuration options are the same as for active:NKPRequest and are covered here.

Note the values for host and port in the nkp:// URI will override any settings for these in the configuration. Also specifying nkps:// will always force TLS encryption.

Security

As a bare minimum we recommend that the configuration specifies how to treat server-side requests. The following configuration will explicitly prevent server-side requests into the client address space during the the execution of the nkp:// request...

<config>
  <exposeRequestScope>false</exposeRequestScope>
</config>