201 lines
7.0 KiB
HTML
201 lines
7.0 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>
|
|
bindings/http/http_receiver.js - Documentation
|
|
</title>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/collapse.css">
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<svg style="display: none;">
|
|
<defs>
|
|
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
|
|
<path d="M0 0h24v24H0z" fill="none"/>
|
|
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
|
|
</symbol>
|
|
</defs>
|
|
</svg>
|
|
|
|
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
<label for="nav-trigger" class="navicon-button x">
|
|
<div class="navicon"></div>
|
|
</label>
|
|
|
|
<label for="nav-trigger" class="overlay"></label>
|
|
|
|
<div class="top-nav-wrapper">
|
|
<ul>
|
|
<li >
|
|
<a href="index.html">
|
|
|
|
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
|
|
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
|
|
<path d="M0 0h24v24H0z" fill="none"/>
|
|
</svg>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<nav>
|
|
<h3 class="reference-title">
|
|
cloudevents-sdk
|
|
</h3>
|
|
|
|
|
|
<h3>
|
|
Resources
|
|
</h3>
|
|
|
|
<a href="concepts.html">Concepts</a>
|
|
|
|
|
|
|
|
<h3>Classes</h3><ul><li id="CloudEvent-nav"><a href="CloudEvent.html">CloudEvent</a><ul class='methods'><li data-type="method" id="CloudEvent-addExtension-nav"><a href="CloudEvent.html#addExtension">addExtension</a></li><li data-type="method" id="CloudEvent-data-nav"><a href="CloudEvent.html#data">data</a></li><li data-type="method" id="CloudEvent-dataContenttype-nav"><a href="CloudEvent.html#dataContenttype">dataContenttype</a></li><li data-type="method" id="CloudEvent-format-nav"><a href="CloudEvent.html#format">format</a></li><li data-type="method" id="CloudEvent-getData-nav"><a href="CloudEvent.html#getData">getData</a></li><li data-type="method" id="CloudEvent-getDataContenttype-nav"><a href="CloudEvent.html#getDataContenttype">getDataContenttype</a></li><li data-type="method" id="CloudEvent-getExtensions-nav"><a href="CloudEvent.html#getExtensions">getExtensions</a></li><li data-type="method" id="CloudEvent-getFormats-nav"><a href="CloudEvent.html#getFormats">getFormats</a></li><li data-type="method" id="CloudEvent-getId-nav"><a href="CloudEvent.html#getId">getId</a></li><li data-type="method" id="CloudEvent-getSource-nav"><a href="CloudEvent.html#getSource">getSource</a></li><li data-type="method" id="CloudEvent-getSpecversion-nav"><a href="CloudEvent.html#getSpecversion">getSpecversion</a></li><li data-type="method" id="CloudEvent-getTime-nav"><a href="CloudEvent.html#getTime">getTime</a></li><li data-type="method" id="CloudEvent-getType-nav"><a href="CloudEvent.html#getType">getType</a></li><li data-type="method" id="CloudEvent-id-nav"><a href="CloudEvent.html#id">id</a></li><li data-type="method" id="CloudEvent-source-nav"><a href="CloudEvent.html#source">source</a></li><li data-type="method" id="CloudEvent-time-nav"><a href="CloudEvent.html#time">time</a></li><li data-type="method" id="CloudEvent-toString-nav"><a href="CloudEvent.html#toString">toString</a></li><li data-type="method" id="CloudEvent-type-nav"><a href="CloudEvent.html#type">type</a></li></ul></li><li id="HTTPReceiver-nav"><a href="HTTPReceiver.html">HTTPReceiver</a><ul class='methods'><li data-type="method" id="HTTPReceiver-accept-nav"><a href="HTTPReceiver.html#accept">accept</a></li></ul></li></ul>
|
|
</nav>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">
|
|
bindings/http/http_receiver.js
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>const V03Binary = require("./receiver_binary_0_3");
|
|
const V03Structured = require("./receiver_structured_0_3.js");
|
|
const V1Binary = require("./receiver_binary_1.js");
|
|
const V1Structured = require("./receiver_structured_1.js");
|
|
const {
|
|
SPEC_V03,
|
|
SPEC_V1,
|
|
HEADER_CONTENT_TYPE,
|
|
MIME_CE,
|
|
BINARY_HEADERS_1,
|
|
DEFAULT_SPEC_VERSION_HEADER
|
|
} = require("./constants");
|
|
|
|
/**
|
|
* A class to receive a CloudEvent from an HTTP POST request.
|
|
*/
|
|
class HTTPReceiver {
|
|
/**
|
|
* Create an instance of an HTTPReceiver to accept incoming CloudEvents.
|
|
*/
|
|
constructor() {
|
|
this.receivers = {
|
|
v1: {
|
|
structured: new V1Structured(),
|
|
binary: new V1Binary()
|
|
},
|
|
v03: {
|
|
structured: new V03Structured(),
|
|
binary: new V03Binary()
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Acceptor for an incoming HTTP CloudEvent POST. Can process
|
|
* binary and structured incoming CloudEvents.
|
|
*
|
|
* @param {Object} headers HTTP headers keyed by header name ("Content-Type")
|
|
* @param {Object|JSON} body The body of the HTTP request
|
|
* @return {CloudEvent} A new {CloudEvent} instance
|
|
*/
|
|
accept(headers, body) {
|
|
const mode = getMode(headers);
|
|
const version = getVersion(mode, headers, body);
|
|
switch (version) {
|
|
case SPEC_V1:
|
|
return this.receivers.v1[mode].parse(body, headers);
|
|
case SPEC_V03:
|
|
return this.receivers.v03[mode].parse(body, headers);
|
|
default:
|
|
console.error(
|
|
`Unknown spec version ${version}. Default to ${SPEC_V1}`);
|
|
return this.receivers.v1[mode].parse(body, headers);
|
|
}
|
|
}
|
|
}
|
|
|
|
function getMode(headers) {
|
|
let mode = "unknown";
|
|
const contentType = headers[HEADER_CONTENT_TYPE];
|
|
if (contentType && contentType.startsWith(MIME_CE)) {
|
|
mode = "structured";
|
|
} else if (headers[BINARY_HEADERS_1.ID]) {
|
|
mode = "binary";
|
|
} else {
|
|
throw new TypeError("no cloud event detected");
|
|
}
|
|
return mode;
|
|
}
|
|
|
|
function getVersion(mode, headers, body) {
|
|
let version = SPEC_V1; // default to 1.0
|
|
|
|
if (mode === "binary") {
|
|
// Check the headers for the version
|
|
const versionHeader = headers[DEFAULT_SPEC_VERSION_HEADER];
|
|
if (versionHeader) { version = versionHeader; }
|
|
} else {
|
|
// structured mode - the version is in the body
|
|
version = body instanceof String
|
|
? JSON.parse(body).specversion : body.specversion;
|
|
}
|
|
return version;
|
|
}
|
|
|
|
module.exports = HTTPReceiver;
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
|
|
</footer>
|
|
|
|
<script src="scripts/linenumber.js"></script>
|
|
<script src="scripts/pagelocation.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|