HTTPResponseCode

Home > Books > NetKernel API and Services Reference > Accessor Listing > HTTP Transport > HTTPResponseCode

Module

The HTTPResponseCode accessor is exported by the urn:org:ten60:netkernel:tpt:http module. Import this module to gain access to the accessor.

Syntax

URI

active:HTTPResponseCode

Argument	Rules	Description
operand	Mandatory	an optional resource to attach the response code to
param	Mandatory	the response code document

Example Usage

DPML

<instr>
  <type>HTTPResponseCode</type>
  <operand>this:response</operand>
  <param>
    <HTTPResponseCode>
      <code>303</code>
      <header>
        <name>Location</name>
        <value>http://www.1060.org/</value>
      </header>
    </HTTPResponseCode>
  </param>
  <target>this:response</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:HTTPResponseCode");
req.addArgument("operand", [resource representation, aspect, or URI] );
req.addArgument("param", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The HTTPResponseCode accessor creates an HTTP Response code. If an operand is supplied the response code is attached to the operand resource and returned as a multipart. If no operand is supplied then the response code aspect is returned on its own.

The HTTP Bridge detects a resource with an HTTPResponseCode aspect and sets the HTTP Response response code and any specified HTTP headers on the HTTP response stream. If HTTP Bridge detects the HTTPResponseCode in conjunction with a multipart the companion part will be written to the body of the HTTP response stream - in this way detailed response messages can be returned to the client.

Response Code Document

A response code is supplied as an XML document in the param argument. The document has the following form

<HTTPResponseCode>
  <code>303</code>
  <reason>Redirected by the application</reason>
  <header>
    <name>Location</name>
    <value>http://www.1060.org/</value>
  </header>
        ...
    
</HTTPResponseCode>

Any number of header sections may be provided. The name field should be an appropriate HTTP/1.0 header name.