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:ScratchPad
Description:Provides a transient space to all subrequests with the URI scheme scratch:
Id:layer1.Endpoint.ScratchPad
Category:transparent overlay

ScratchPad is a transparent overlay. You must instantiate an instance of the overlay from its prototype, this will create a new instance within your application space.

Parameters

The layer1.Endpoint.ScratchPad prototype has the following initialisation parameters:

NameRulesTypingDefaultDescription
spaceMandatorySpace(none)
A nested space definition which the overlay will delegate all requests in to.

Here is an auto-generated example of how to instantiate an instance of ScratchPad:

<overlay>
  <prototype>layer1.Endpoint.ScratchPad</prototype>
  <space>
    <!--wrapped space...-->
  </space>
</overlay>
Import Requirements

To use ScratchPad transparent overlay you must import the module urn:org:netkernel:ext:layer1:

<import>
  <uri>urn:org:netkernel:ext:layer1</uri>
</import>

Details

The ScatchPad overlay creates a scratchpad space which is injected into the request scope above the wrapper space. Any request that passes through the scratch pad overlay is able to use the scratch: scheme to store and retrieve values for the duration of that request within the wrapped space.

If long-lived storage of temporary information is needed during, e.g. an HTTP session, then the HTTP Session overlay may be more appropriate.