- element ul. tree is the tree's root
- element for document.CALLGRAPH node cgn to
+ // the parent
- element ul. tree is the tree's root
- Standard library - -
- Other packages -
- Sub-repositories -
- Community -
- benchmarks — benchmarks to measure Go as it is developed. -
- blog — blog.golang.org's implementation. -
- build — build.golang.org's implementation. -
- crypto — additional cryptography packages. -
- debug — an experimental debugger for Go. -
- image — additional imaging packages. -
- mobile — experimental support for Go on mobile platforms. -
- net — additional networking packages. -
- perf — packages and tools for performance measurement, storage, and analysis. -
- pkgsite — home of the pkg.go.dev website. -
- review — a tool for working with Gerrit code reviews. -
- sync — additional concurrency primitives. -
- sys — packages for making system calls. -
- text — packages for working with text. -
- time — additional time packages. -
- tools — godoc, goimports, gorename, and other tools. -
- tour — tour.golang.org's implementation. -
- exp — experimental and deprecated packages (handle with care; may change without warning). -
- Pkg.go.dev - the Go package discovery site. -
- Projects at the Go Wiki - a curated list of Go projects. -
- Standard library + +
- Other packages +
- Sub-repositories +
- Community +
- benchmarks — benchmarks to measure Go as it is developed. +
- blog — blog.golang.org's implementation. +
- build — build.golang.org's implementation. +
- crypto — additional cryptography packages. +
- debug — an experimental debugger for Go. +
- image — additional imaging packages. +
- mobile — experimental support for Go on mobile platforms. +
- net — additional networking packages. +
- perf — packages and tools for performance measurement, storage, and analysis. +
- pkgsite — home of the pkg.go.dev website. +
- review — a tool for working with Gerrit code reviews. +
- sync — additional concurrency primitives. +
- sys — packages for making system calls. +
- text — packages for working with text. +
- time — additional time packages. +
- tools — godoc, goimports, gorename, and other tools. +
- tour — tour.golang.org's implementation. +
- exp — experimental and deprecated packages (handle with care; may change without warning). +
- Pkg.go.dev - the Go package discovery site. +
- Projects at the Go Wiki - a curated list of Go projects. +
- element.
+ function cgAddChild(tree, ul, cgn) {
+ var li = document.createElement('li');
+ ul.appendChild(li);
+ li.className = 'closed';
+
+ var code = document.createElement('code');
+
+ if (cgn.Callees != null) {
+ $(li).addClass('expandable');
+
+ // Event handlers and innerHTML updates don't play nicely together,
+ // hence all this explicit DOM manipulation.
+ var hitarea = document.createElement('div');
+ hitarea.className = 'hitarea expandable-hitarea';
+ li.appendChild(hitarea);
+
+ li.appendChild(code);
+
+ var childUL = document.createElement('ul');
+ li.appendChild(childUL);
+ childUL.setAttribute('style', 'display: none;');
+
+ var onClick = function() {
+ document.cgAddChildren(tree, childUL, cgn.Callees);
+ hitarea.removeEventListener('click', onClick);
+ };
+ hitarea.addEventListener('click', onClick);
+ } else {
+ li.appendChild(code);
+ }
+ code.innerHTML += ' ' + makeAnchor(cgn.Func);
+ return li;
+ }
+})();
diff --git a/docs/lib/godoc/jquery.js b/docs/lib/godoc/jquery.js
index bc3fbc8..f65cf1d 100644
--- a/docs/lib/godoc/jquery.js
+++ b/docs/lib/godoc/jquery.js
@@ -1,2 +1,2 @@
-/*! jQuery v1.8.2 jquery.com | jquery.org/license */
+/*! jQuery v1.8.2 jquery.com | jquery.org/license */
(function(a,b){function G(a){var b=F[a]={};return p.each(a.split(s),function(a,c){b[c]=!0}),b}function J(a,c,d){if(d===b&&a.nodeType===1){var e="data-"+c.replace(I,"-$1").toLowerCase();d=a.getAttribute(e);if(typeof d=="string"){try{d=d==="true"?!0:d==="false"?!1:d==="null"?null:+d+""===d?+d:H.test(d)?p.parseJSON(d):d}catch(f){}p.data(a,c,d)}else d=b}return d}function K(a){var b;for(b in a){if(b==="data"&&p.isEmptyObject(a[b]))continue;if(b!=="toJSON")return!1}return!0}function ba(){return!1}function bb(){return!0}function bh(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function bi(a,b){do a=a[b];while(a&&a.nodeType!==1);return a}function bj(a,b,c){b=b||0;if(p.isFunction(b))return p.grep(a,function(a,d){var e=!!b.call(a,d,a);return e===c});if(b.nodeType)return p.grep(a,function(a,d){return a===b===c});if(typeof b=="string"){var d=p.grep(a,function(a){return a.nodeType===1});if(be.test(b))return p.filter(b,d,!c);b=p.filter(b,d)}return p.grep(a,function(a,d){return p.inArray(a,b)>=0===c})}function bk(a){var b=bl.split("|"),c=a.createDocumentFragment();if(c.createElement)while(b.length)c.createElement(b.pop());return c}function bC(a,b){return a.getElementsByTagName(b)[0]||a.appendChild(a.ownerDocument.createElement(b))}function bD(a,b){if(b.nodeType!==1||!p.hasData(a))return;var c,d,e,f=p._data(a),g=p._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;d
a",c=n.getElementsByTagName("*"),d=n.getElementsByTagName("a")[0],d.style.cssText="top:1px;float:left;opacity:.5";if(!c||!c.length)return{};f=e.createElement("select"),g=f.appendChild(e.createElement("option")),h=n.getElementsByTagName("input")[0],b={leadingWhitespace:n.firstChild.nodeType===3,tbody:!n.getElementsByTagName("tbody").length,htmlSerialize:!!n.getElementsByTagName("link").length,style:/top/.test(d.getAttribute("style")),hrefNormalized:d.getAttribute("href")==="/a",opacity:/^0.5/.test(d.style.opacity),cssFloat:!!d.style.cssFloat,checkOn:h.value==="on",optSelected:g.selected,getSetAttribute:n.className!=="t",enctype:!!e.createElement("form").enctype,html5Clone:e.createElement("nav").cloneNode(!0).outerHTML!=="<:nav>",boxModel:e.compatMode==="CSS1Compat",submitBubbles:!0,changeBubbles:!0,focusinBubbles:!1,deleteExpando:!0,noCloneEvent:!0,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableMarginRight:!0,boxSizingReliable:!0,pixelPosition:!1},h.checked=!0,b.noCloneChecked=h.cloneNode(!0).checked,f.disabled=!0,b.optDisabled=!g.disabled;try{delete n.test}catch(o){b.deleteExpando=!1}!n.addEventListener&&n.attachEvent&&n.fireEvent&&(n.attachEvent("onclick",m=function(){b.noCloneEvent=!1}),n.cloneNode(!0).fireEvent("onclick"),n.detachEvent("onclick",m)),h=e.createElement("input"),h.value="t",h.setAttribute("type","radio"),b.radioValue=h.value==="t",h.setAttribute("checked","checked"),h.setAttribute("name","t"),n.appendChild(h),i=e.createDocumentFragment(),i.appendChild(n.lastChild),b.checkClone=i.cloneNode(!0).cloneNode(!0).lastChild.checked,b.appendChecked=h.checked,i.removeChild(h),i.appendChild(n);if(n.attachEvent)for(k in{submit:!0,change:!0,focusin:!0})j="on"+k,l=j in n,l||(n.setAttribute(j,"return;"),l=typeof n[j]=="function"),b[k+"Bubbles"]=l;return p(function(){var c,d,f,g,h="padding:0;margin:0;border:0;display:block;overflow:hidden;",i=e.getElementsByTagName("body")[0];if(!i)return;c=e.createElement("div"),c.style.cssText="visibility:hidden;border:0;width:0;height:0;position:static;top:0;margin-top:1px",i.insertBefore(c,i.firstChild),d=e.createElement("div"),c.appendChild(d),d.innerHTML="
",f=d.getElementsByTagName("td"),f[0].style.cssText="padding:0;margin:0;border:0;display:none",l=f[0].offsetHeight===0,f[0].style.display="",f[1].style.display="none",b.reliableHiddenOffsets=l&&f[0].offsetHeight===0,d.innerHTML="",d.style.cssText="box-sizing:border-box;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;padding:1px;border:1px;display:block;width:4px;margin-top:1%;position:absolute;top:1%;",b.boxSizing=d.offsetWidth===4,b.doesNotIncludeMarginInBodyOffset=i.offsetTop!==1,a.getComputedStyle&&(b.pixelPosition=(a.getComputedStyle(d,null)||{}).top!=="1%",b.boxSizingReliable=(a.getComputedStyle(d,null)||{width:"4px"}).width==="4px",g=e.createElement("div"),g.style.cssText=d.style.cssText=h,g.style.marginRight=g.style.width="0",d.style.width="1px",d.appendChild(g),b.reliableMarginRight=!parseFloat((a.getComputedStyle(g,null)||{}).marginRight)),typeof d.style.zoom!="undefined"&&(d.innerHTML="",d.style.cssText=h+"width:1px;padding:1px;display:inline;zoom:1",b.inlineBlockNeedsLayout=d.offsetWidth===3,d.style.display="block",d.style.overflow="visible",d.innerHTML="",d.firstChild.style.width="5px",b.shrinkWrapBlocks=d.offsetWidth!==3,c.style.zoom=1),i.removeChild(c),c=d=f=g=null}),i.removeChild(n),c=d=f=g=h=i=n=null,b}();var H=/(?:\{[\s\S]*\}|\[[\s\S]*\])$/,I=/([A-Z])/g;p.extend({cache:{},deletedIds:[],uuid:0,expando:"jQuery"+(p.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(a){return a=a.nodeType?p.cache[a[p.expando]]:a[p.expando],!!a&&!K(a)},data:function(a,c,d,e){if(!p.acceptData(a))return;var f,g,h=p.expando,i=typeof c=="string",j=a.nodeType,k=j?p.cache:a,l=j?a[h]:a[h]&&h;if((!l||!k[l]||!e&&!k[l].data)&&i&&d===b)return;l||(j?a[h]=l=p.deletedIds.pop()||p.guid++:l=h),k[l]||(k[l]={},j||(k[l].toJSON=p.noop));if(typeof c=="object"||typeof c=="function")e?k[l]=p.extend(k[l],c):k[l].data=p.extend(k[l].data,c);return f=k[l],e||(f.data||(f.data={}),f=f.data),d!==b&&(f[p.camelCase(c)]=d),i?(g=f[c],g==null&&(g=f[p.camelCase(c)])):g=f,g},removeData:function(a,b,c){if(!p.acceptData(a))return;var d,e,f,g=a.nodeType,h=g?p.cache:a,i=g?a[p.expando]:p.expando;if(!h[i])return;if(b){d=c?h[i]:h[i].data;if(d){p.isArray(b)||(b in d?b=[b]:(b=p.camelCase(b),b in d?b=[b]:b=b.split(" ")));for(e=0,f=b.length;et ","
"],tr:[2,"","
"],td:[3,"
"],col:[2,"","
"],area:[1,""],_default:[0,"",""]},bA=bk(e),bB=bA.appendChild(e.createElement("div"));bz.optgroup=bz.option,bz.tbody=bz.tfoot=bz.colgroup=bz.caption=bz.thead,bz.th=bz.td,p.support.htmlSerialize||(bz._default=[1,"X"," ",""]),p.fn.extend({text:function(a){return p.access(this,function(a){return a===b?p.text(this):this.empty().append((this[0]&&this[0].ownerDocument||e).createTextNode(a))},null,a,arguments.length)},wrapAll:function(a){if(p.isFunction(a))return this.each(function(b){p(this).wrapAll(a.call(this,b))});if(this[0]){var b=p(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){return p.isFunction(a)?this.each(function(b){p(this).wrapInner(a.call(this,b))}):this.each(function(){var b=p(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=p.isFunction(a);return this.each(function(c){p(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return this.parent().each(function(){p.nodeName(this,"body")||p(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(a){(this.nodeType===1||this.nodeType===11)&&this.appendChild(a)})},prepend:function(){return this.domManip(arguments,!0,function(a){(this.nodeType===1||this.nodeType===11)&&this.insertBefore(a,this.firstChild)})},before:function(){if(!bh(this[0]))return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var a=p.clean(arguments);return this.pushStack(p.merge(a,this),"before",this.selector)}},after:function(){if(!bh(this[0]))return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var a=p.clean(arguments);return this.pushStack(p.merge(this,a),"after",this.selector)}},remove:function(a,b){var c,d=0;for(;(c=this[d])!=null;d++)if(!a||p.filter(a,[c]).length)!b&&c.nodeType===1&&(p.cleanData(c.getElementsByTagName("*")),p.cleanData([c])),c.parentNode&&c.parentNode.removeChild(c);return this},empty:function(){var a,b=0;for(;(a=this[b])!=null;b++){a.nodeType===1&&p.cleanData(a.getElementsByTagName("*"));while(a.firstChild)a.removeChild(a.firstChild)}return this},clone:function(a,b){return a=a==null?!1:a,b=b==null?a:b,this.map(function(){return p.clone(this,a,b)})},html:function(a){return p.access(this,function(a){var c=this[0]||{},d=0,e=this.length;if(a===b)return c.nodeType===1?c.innerHTML.replace(bm,""):b;if(typeof a=="string"&&!bs.test(a)&&(p.support.htmlSerialize||!bu.test(a))&&(p.support.leadingWhitespace||!bn.test(a))&&!bz[(bp.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(bo,"<$1>");try{for(;d"&&!m?l.childNodes:[];for(g=n.length-1;g>=0;--g)p.nodeName(n[g],"tbody")&&!n[g].childNodes.length&&n[g].parentNode.removeChild(n[g])}!p.support.leadingWhitespace&&bn.test(h)&&l.insertBefore(b.createTextNode(bn.exec(h)[0]),l.firstChild),h=l.childNodes,l.parentNode.removeChild(l)}h.nodeType?t.push(h):p.merge(t,h)}l&&(h=l=s=null);if(!p.support.appendChecked)for(f=0;(h=t[f])!=null;f++)p.nodeName(h,"input")?bG(h):typeof h.getElementsByTagName!="undefined"&&p.grep(h.getElementsByTagName("input"),bG);if(c){q=function(a){if(!a.type||bx.test(a.type))return d?d.push(a.parentNode?a.parentNode.removeChild(a):a):c.appendChild(a)};for(f=0;(h=t[f])!=null;f++)if(!p.nodeName(h,"script")||!q(h))c.appendChild(h),typeof h.getElementsByTagName!="undefined"&&(r=p.grep(p.merge([],h.getElementsByTagName("script")),q),t.splice.apply(t,[f+1,0].concat(r)),f+=r.length)}return t},cleanData:function(a,b){var c,d,e,f,g=0,h=p.expando,i=p.cache,j=p.support.deleteExpando,k=p.event.special;for(;(e=a[g])!=null;g++)if(b||p.acceptData(e)){d=e[h],c=d&&i[d];if(c){if(c.events)for(f in c.events)k[f]?p.event.remove(e,f):p.removeEvent(e,f,c.handle);i[d]&&(delete i[d],j?delete e[h]:e.removeAttribute?e.removeAttribute(h):e[h]=null,p.deletedIds.push(d))}}}}),function(){var a,b;p.uaMatch=function(a){a=a.toLowerCase();var b=/(chrome)[ \/]([\w.]+)/.exec(a)||/(webkit)[ \/]([\w.]+)/.exec(a)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(a)||/(msie) ([\w.]+)/.exec(a)||a.indexOf("compatible")<0&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(a)||[];return{browser:b[1]||"",version:b[2]||"0"}},a=p.uaMatch(g.userAgent),b={},a.browser&&(b[a.browser]=!0,b.version=a.version),b.chrome?b.webkit=!0:b.webkit&&(b.safari=!0),p.browser=b,p.sub=function(){function a(b,c){return new a.fn.init(b,c)}p.extend(!0,a,this),a.superclass=this,a.fn=a.prototype=this(),a.fn.constructor=a,a.sub=this.sub,a.fn.init=function c(c,d){return d&&d instanceof p&&!(d instanceof a)&&(d=a(d)),p.fn.init.call(this,c,d,b)},a.fn.init.prototype=a.fn;var b=a(e);return a}}();var bH,bI,bJ,bK=/alpha\([^)]*\)/i,bL=/opacity=([^)]*)/,bM=/^(top|right|bottom|left)$/,bN=/^(none|table(?!-c[ea]).+)/,bO=/^margin/,bP=new RegExp("^("+q+")(.*)$","i"),bQ=new RegExp("^("+q+")(?!px)[a-z%]+$","i"),bR=new RegExp("^([-+])=("+q+")","i"),bS={},bT={position:"absolute",visibility:"hidden",display:"block"},bU={letterSpacing:0,fontWeight:400},bV=["Top","Right","Bottom","Left"],bW=["Webkit","O","Moz","ms"],bX=p.fn.toggle;p.fn.extend({css:function(a,c){return p.access(this,function(a,c,d){return d!==b?p.style(a,c,d):p.css(a,c)},a,c,arguments.length>1)},show:function(){return b$(this,!0)},hide:function(){return b$(this)},toggle:function(a,b){var c=typeof a=="boolean";return p.isFunction(a)&&p.isFunction(b)?bX.apply(this,arguments):this.each(function(){(c?a:bZ(this))?p(this).show():p(this).hide()})}}),p.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=bH(a,"opacity");return c===""?"1":c}}}},cssNumber:{fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":p.support.cssFloat?"cssFloat":"styleFloat"},style:function(a,c,d,e){if(!a||a.nodeType===3||a.nodeType===8||!a.style)return;var f,g,h,i=p.camelCase(c),j=a.style;c=p.cssProps[i]||(p.cssProps[i]=bY(j,i)),h=p.cssHooks[c]||p.cssHooks[i];if(d===b)return h&&"get"in h&&(f=h.get(a,!1,e))!==b?f:j[c];g=typeof d,g==="string"&&(f=bR.exec(d))&&(d=(f[1]+1)*f[2]+parseFloat(p.css(a,c)),g="number");if(d==null||g==="number"&&isNaN(d))return;g==="number"&&!p.cssNumber[i]&&(d+="px");if(!h||!("set"in h)||(d=h.set(a,d,e))!==b)try{j[c]=d}catch(k){}},css:function(a,c,d,e){var f,g,h,i=p.camelCase(c);return c=p.cssProps[i]||(p.cssProps[i]=bY(a.style,i)),h=p.cssHooks[c]||p.cssHooks[i],h&&"get"in h&&(f=h.get(a,!0,e)),f===b&&(f=bH(a,c)),f==="normal"&&c in bU&&(f=bU[c]),d||e!==b?(g=parseFloat(f),d||p.isNumeric(g)?g||0:f):f},swap:function(a,b,c){var d,e,f={};for(e in b)f[e]=a.style[e],a.style[e]=b[e];d=c.call(a);for(e in b)a.style[e]=f[e];return d}}),a.getComputedStyle?bH=function(b,c){var d,e,f,g,h=a.getComputedStyle(b,null),i=b.style;return h&&(d=h[c],d===""&&!p.contains(b.ownerDocument,b)&&(d=p.style(b,c)),bQ.test(d)&&bO.test(c)&&(e=i.width,f=i.minWidth,g=i.maxWidth,i.minWidth=i.maxWidth=i.width=d,d=h.width,i.width=e,i.minWidth=f,i.maxWidth=g)),d}:e.documentElement.currentStyle&&(bH=function(a,b){var c,d,e=a.currentStyle&&a.currentStyle[b],f=a.style;return e==null&&f&&f[b]&&(e=f[b]),bQ.test(e)&&!bM.test(b)&&(c=f.left,d=a.runtimeStyle&&a.runtimeStyle.left,d&&(a.runtimeStyle.left=a.currentStyle.left),f.left=b==="fontSize"?"1em":e,e=f.pixelLeft+"px",f.left=c,d&&(a.runtimeStyle.left=d)),e===""?"auto":e}),p.each(["height","width"],function(a,b){p.cssHooks[b]={get:function(a,c,d){if(c)return a.offsetWidth===0&&bN.test(bH(a,"display"))?p.swap(a,bT,function(){return cb(a,b,d)}):cb(a,b,d)},set:function(a,c,d){return b_(a,c,d?ca(a,b,d,p.support.boxSizing&&p.css(a,"boxSizing")==="border-box"):0)}}}),p.support.opacity||(p.cssHooks.opacity={get:function(a,b){return bL.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?.01*parseFloat(RegExp.$1)+"":b?"1":""},set:function(a,b){var c=a.style,d=a.currentStyle,e=p.isNumeric(b)?"alpha(opacity="+b*100+")":"",f=d&&d.filter||c.filter||"";c.zoom=1;if(b>=1&&p.trim(f.replace(bK,""))===""&&c.removeAttribute){c.removeAttribute("filter");if(d&&!d.filter)return}c.filter=bK.test(f)?f.replace(bK,e):f+" "+e}}),p(function(){p.support.reliableMarginRight||(p.cssHooks.marginRight={get:function(a,b){return p.swap(a,{display:"inline-block"},function(){if(b)return bH(a,"marginRight")})}}),!p.support.pixelPosition&&p.fn.position&&p.each(["top","left"],function(a,b){p.cssHooks[b]={get:function(a,c){if(c){var d=bH(a,b);return bQ.test(d)?p(a).position()[b]+"px":d}}}})}),p.expr&&p.expr.filters&&(p.expr.filters.hidden=function(a){return a.offsetWidth===0&&a.offsetHeight===0||!p.support.reliableHiddenOffsets&&(a.style&&a.style.display||bH(a,"display"))==="none"},p.expr.filters.visible=function(a){return!p.expr.filters.hidden(a)}),p.each({margin:"",padding:"",border:"Width"},function(a,b){p.cssHooks[a+b]={expand:function(c){var d,e=typeof c=="string"?c.split(" "):[c],f={};for(d=0;d<4;d++)f[a+bV[d]+b]=e[d]||e[d-2]||e[0];return f}},bO.test(a)||(p.cssHooks[a+b].set=b_)});var cd=/%20/g,ce=/\[\]$/,cf=/\r?\n/g,cg=/^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,ch=/^(?:select|textarea)/i;p.fn.extend({serialize:function(){return p.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?p.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ch.test(this.nodeName)||cg.test(this.type))}).map(function(a,b){var c=p(this).val();return c==null?null:p.isArray(c)?p.map(c,function(a,c){return{name:b.name,value:a.replace(cf,"\r\n")}}):{name:b.name,value:c.replace(cf,"\r\n")}}).get()}}),p.param=function(a,c){var d,e=[],f=function(a,b){b=p.isFunction(b)?b():b==null?"":b,e[e.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};c===b&&(c=p.ajaxSettings&&p.ajaxSettings.traditional);if(p.isArray(a)||a.jquery&&!p.isPlainObject(a))p.each(a,function(){f(this.name,this.value)});else for(d in a)ci(d,a[d],c,f);return e.join("&").replace(cd,"+")};var cj,ck,cl=/#.*$/,cm=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,cn=/^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/,co=/^(?:GET|HEAD)$/,cp=/^\/\//,cq=/\?/,cr=/
").append(a.replace(cr,"")).find(e):a)}),this},p.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){p.fn[b]=function(a){return this.on(b,a)}}),p.each(["get","post"],function(a,c){p[c]=function(a,d,e,f){return p.isFunction(d)&&(f=f||e,e=d,d=b),p.ajax({type:c,url:a,data:d,success:e,dataType:f})}}),p.extend({getScript:function(a,c){return p.get(a,b,c,"script")},getJSON:function(a,b,c){return p.get(a,b,c,"json")},ajaxSetup:function(a,b){return b?cB(a,p.ajaxSettings):(b=a,a=p.ajaxSettings),cB(a,b),a},ajaxSettings:{url:ck,isLocal:cn.test(cj[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded; charset=UTF-8",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":cx},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":p.parseJSON,"text xml":p.parseXML},flatOptions:{context:!0,url:!0}},ajaxPrefilter:cz(cv),ajaxTransport:cz(cw),ajax:function(a,c){function y(a,c,f,i){var k,s,t,u,w,y=c;if(v===2)return;v=2,h&&clearTimeout(h),g=b,e=i||"",x.readyState=a>0?4:0,f&&(u=cC(l,x,f));if(a>=200&&a<300||a===304)l.ifModified&&(w=x.getResponseHeader("Last-Modified"),w&&(p.lastModified[d]=w),w=x.getResponseHeader("Etag"),w&&(p.etag[d]=w)),a===304?(y="notmodified",k=!0):(k=cD(l,u),y=k.state,s=k.data,t=k.error,k=!t);else{t=y;if(!y||a)y="error",a<0&&(a=0)}x.status=a,x.statusText=(c||y)+"",k?o.resolveWith(m,[s,y,x]):o.rejectWith(m,[x,y,t]),x.statusCode(r),r=b,j&&n.trigger("ajax"+(k?"Success":"Error"),[x,l,k?s:t]),q.fireWith(m,[x,y]),j&&(n.trigger("ajaxComplete",[x,l]),--p.active||p.event.trigger("ajaxStop"))}typeof a=="object"&&(c=a,a=b),c=c||{};var d,e,f,g,h,i,j,k,l=p.ajaxSetup({},c),m=l.context||l,n=m!==l&&(m.nodeType||m instanceof p)?p(m):p.event,o=p.Deferred(),q=p.Callbacks("once memory"),r=l.statusCode||{},t={},u={},v=0,w="canceled",x={readyState:0,setRequestHeader:function(a,b){if(!v){var c=a.toLowerCase();a=u[c]=u[c]||a,t[a]=b}return this},getAllResponseHeaders:function(){return v===2?e:null},getResponseHeader:function(a){var c;if(v===2){if(!f){f={};while(c=cm.exec(e))f[c[1].toLowerCase()]=c[2]}c=f[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){return v||(l.mimeType=a),this},abort:function(a){return a=a||w,g&&g.abort(a),y(0,a),this}};o.promise(x),x.success=x.done,x.error=x.fail,x.complete=q.add,x.statusCode=function(a){if(a){var b;if(v<2)for(b in a)r[b]=[r[b],a[b]];else b=a[x.status],x.always(b)}return this},l.url=((a||l.url)+"").replace(cl,"").replace(cp,cj[1]+"//"),l.dataTypes=p.trim(l.dataType||"*").toLowerCase().split(s),l.crossDomain==null&&(i=ct.exec(l.url.toLowerCase())||!1,l.crossDomain=i&&i.join(":")+(i[3]?"":i[1]==="http:"?80:443)!==cj.join(":")+(cj[3]?"":cj[1]==="http:"?80:443)),l.data&&l.processData&&typeof l.data!="string"&&(l.data=p.param(l.data,l.traditional)),cA(cv,l,c,x);if(v===2)return x;j=l.global,l.type=l.type.toUpperCase(),l.hasContent=!co.test(l.type),j&&p.active++===0&&p.event.trigger("ajaxStart");if(!l.hasContent){l.data&&(l.url+=(cq.test(l.url)?"&":"?")+l.data,delete l.data),d=l.url;if(l.cache===!1){var z=p.now(),A=l.url.replace(cs,"$1_="+z);l.url=A+(A===l.url?(cq.test(l.url)?"&":"?")+"_="+z:"")}}(l.data&&l.hasContent&&l.contentType!==!1||c.contentType)&&x.setRequestHeader("Content-Type",l.contentType),l.ifModified&&(d=d||l.url,p.lastModified[d]&&x.setRequestHeader("If-Modified-Since",p.lastModified[d]),p.etag[d]&&x.setRequestHeader("If-None-Match",p.etag[d])),x.setRequestHeader("Accept",l.dataTypes[0]&&l.accepts[l.dataTypes[0]]?l.accepts[l.dataTypes[0]]+(l.dataTypes[0]!=="*"?", "+cx+"; q=0.01":""):l.accepts["*"]);for(k in l.headers)x.setRequestHeader(k,l.headers[k]);if(!l.beforeSend||l.beforeSend.call(m,x,l)!==!1&&v!==2){w="abort";for(k in{success:1,error:1,complete:1})x[k](l[k]);g=cA(cw,l,c,x);if(!g)y(-1,"No Transport");else{x.readyState=1,j&&n.trigger("ajaxSend",[x,l]),l.async&&l.timeout>0&&(h=setTimeout(function(){x.abort("timeout")},l.timeout));try{v=1,g.send(t,y)}catch(B){if(v<2)y(-1,B);else throw B}}return x}return x.abort()},active:0,lastModified:{},etag:{}});var cE=[],cF=/\?/,cG=/(=)\?(?=&|$)|\?\?/,cH=p.now();p.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=cE.pop()||p.expando+"_"+cH++;return this[a]=!0,a}}),p.ajaxPrefilter("json jsonp",function(c,d,e){var f,g,h,i=c.data,j=c.url,k=c.jsonp!==!1,l=k&&cG.test(j),m=k&&!l&&typeof i=="string"&&!(c.contentType||"").indexOf("application/x-www-form-urlencoded")&&cG.test(i);if(c.dataTypes[0]==="jsonp"||l||m)return f=c.jsonpCallback=p.isFunction(c.jsonpCallback)?c.jsonpCallback():c.jsonpCallback,g=a[f],l?c.url=j.replace(cG,"$1"+f):m?c.data=i.replace(cG,"$1"+f):k&&(c.url+=(cF.test(j)?"&":"?")+c.jsonp+"="+f),c.converters["script json"]=function(){return h||p.error(f+" was not called"),h[0]},c.dataTypes[0]="json",a[f]=function(){h=arguments},e.always(function(){a[f]=g,c[f]&&(c.jsonpCallback=d.jsonpCallback,cE.push(f)),h&&p.isFunction(g)&&g(h[0]),h=g=b}),"script"}),p.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){return p.globalEval(a),a}}}),p.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),p.ajaxTransport("script",function(a){if(a.crossDomain){var c,d=e.head||e.getElementsByTagName("head")[0]||e.documentElement;return{send:function(f,g){c=e.createElement("script"),c.async="async",a.scriptCharset&&(c.charset=a.scriptCharset),c.src=a.url,c.onload=c.onreadystatechange=function(a,e){if(e||!c.readyState||/loaded|complete/.test(c.readyState))c.onload=c.onreadystatechange=null,d&&c.parentNode&&d.removeChild(c),c=b,e||g(200,"success")},d.insertBefore(c,d.firstChild)},abort:function(){c&&c.onload(0,1)}}}});var cI,cJ=a.ActiveXObject?function(){for(var a in cI)cI[a](0,1)}:!1,cK=0;p.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&cL()||cM()}:cL,function(a){p.extend(p.support,{ajax:!!a,cors:!!a&&"withCredentials"in a})}(p.ajaxSettings.xhr()),p.support.ajax&&p.ajaxTransport(function(c){if(!c.crossDomain||p.support.cors){var d;return{send:function(e,f){var g,h,i=c.xhr();c.username?i.open(c.type,c.url,c.async,c.username,c.password):i.open(c.type,c.url,c.async);if(c.xhrFields)for(h in c.xhrFields)i[h]=c.xhrFields[h];c.mimeType&&i.overrideMimeType&&i.overrideMimeType(c.mimeType),!c.crossDomain&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(h in e)i.setRequestHeader(h,e[h])}catch(j){}i.send(c.hasContent&&c.data||null),d=function(a,e){var h,j,k,l,m;try{if(d&&(e||i.readyState===4)){d=b,g&&(i.onreadystatechange=p.noop,cJ&&delete cI[g]);if(e)i.readyState!==4&&i.abort();else{h=i.status,k=i.getAllResponseHeaders(),l={},m=i.responseXML,m&&m.documentElement&&(l.xml=m);try{l.text=i.responseText}catch(a){}try{j=i.statusText}catch(n){j=""}!h&&c.isLocal&&!c.crossDomain?h=l.text?200:404:h===1223&&(h=204)}}}catch(o){e||f(-1,o)}l&&f(h,j,l,k)},c.async?i.readyState===4?setTimeout(d,0):(g=++cK,cJ&&(cI||(cI={},p(a).unload(cJ)),cI[g]=d),i.onreadystatechange=d):d()},abort:function(){d&&d(0,1)}}}});var cN,cO,cP=/^(?:toggle|show|hide)$/,cQ=new RegExp("^(?:([-+])=|)("+q+")([a-z%]*)$","i"),cR=/queueHooks$/,cS=[cY],cT={"*":[function(a,b){var c,d,e=this.createTween(a,b),f=cQ.exec(b),g=e.cur(),h=+g||0,i=1,j=20;if(f){c=+f[2],d=f[3]||(p.cssNumber[a]?"":"px");if(d!=="px"&&h){h=p.css(e.elem,a,!0)||c||1;do i=i||".5",h=h/i,p.style(e.elem,a,h+d);while(i!==(i=e.cur()/g)&&i!==1&&--j)}e.unit=d,e.start=h,e.end=f[1]?h+(f[1]+1)*c:c}return e}]};p.Animation=p.extend(cW,{tweener:function(a,b){p.isFunction(a)?(b=a,a=["*"]):a=a.split(" ");var c,d=0,e=a.length;for(;dauth - Go Documentation Server - - - - - - - - - - - - - --... -- -- - - --- - + + + + + + + +- - --- Package auth - -
- - - - - - - - - - - - - - - - - - - --- --- -Overview ▹
--- - - - - - - - - --- -Index ▹
-type BasicAuthManager - ¶ - - -
- -type BasicAuthManager struct { -} -- - - - - - - - - - - - - -func (*BasicAuthManager) Anybody - ¶ - - -
-func (c *BasicAuthManager) Anybody() func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - -func (*BasicAuthManager) Signed - ¶ - - -
-func (c *BasicAuthManager) Signed() func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - - - -type OwnerAuthManager - ¶ - - -
- -type OwnerAuthManager struct { -} -- - - - - - - - - - - - - -func (*OwnerAuthManager) Owner - ¶ - - -
-func (c *OwnerAuthManager) Owner(idParam string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - -func (*OwnerAuthManager) OwnerOrAdmin - ¶ - - -
-func (c *OwnerAuthManager) OwnerOrAdmin(idParam string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - - - -type RoleAuthManager - ¶ - - -
- -type RoleAuthManager struct { -} -- - - - - - - - - - - - - -func (*RoleAuthManager) Admin - ¶ - - -
-func (c *RoleAuthManager) Admin() func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - -func (*RoleAuthManager) UserInRole - ¶ - - -
-func (c *RoleAuthManager) UserInRole(role string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - -func (*RoleAuthManager) UserInRoles - ¶ - - -
-func (c *RoleAuthManager) UserInRoles(roles []string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
- - - - - - - - - - - - - - - - - - -auth - Go Documentation Server + + + + + + + + + + + + + ++... ++ ++ + + +++ + diff --git a/docs/pkg/build/index.html b/docs/pkg/build/index.html index b01f2b4..29867c6 100644 --- a/docs/pkg/build/index.html +++ b/docs/pkg/build/index.html @@ -1,216 +1,216 @@ - - - - - - - -+ + +++ Package auth + +
+ + + + + + + + + + + + + + + + + + + +++ +++ +Overview ▹
+++ + + + + + + + + +++ +Index ▹
+type BasicAuthManager + ¶ + + +
+ +type BasicAuthManager struct { +} ++ + + + + + + + + + + + + +func (*BasicAuthManager) Anybody + ¶ + + +
+func (c *BasicAuthManager) Anybody() func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + +func (*BasicAuthManager) Signed + ¶ + + +
+func (c *BasicAuthManager) Signed() func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + + + +type OwnerAuthManager + ¶ + + +
+ +type OwnerAuthManager struct { +} ++ + + + + + + + + + + + + +func (*OwnerAuthManager) Owner + ¶ + + +
+func (c *OwnerAuthManager) Owner(idParam string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + +func (*OwnerAuthManager) OwnerOrAdmin + ¶ + + +
+func (c *OwnerAuthManager) OwnerOrAdmin(idParam string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + + + +type RoleAuthManager + ¶ + + +
+ +type RoleAuthManager struct { +} ++ + + + + + + + + + + + + +func (*RoleAuthManager) Admin + ¶ + + +
+func (c *RoleAuthManager) Admin() func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + +func (*RoleAuthManager) UserInRole + ¶ + + +
+func (c *RoleAuthManager) UserInRole(role string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + +func (*RoleAuthManager) UserInRoles + ¶ + + +
+func (c *RoleAuthManager) UserInRoles(roles []string) func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc)
+ + + + + + + + + + + + + + + + + + +build - Go Documentation Server - - - - - - - - - - - - - --... -- -- - - --- - + + + + + + + +- - --- Package build - -
- - - - - - - - - - - - - - - - - - - --- --- -Overview ▹
--- - - - - - - - - --- -Index ▹
-type DefaultRpcFactory - ¶ - - -
--See Factory -See HttpEndpoint -See HeartbeatRestService -See StatusRestService -
- -type DefaultRpcFactory struct { - cbuild.Factory -} -- - - - - - - - - - - -func NewDefaultRpcFactory - ¶ - - -
-func NewDefaultRpcFactory() *DefaultRpcFactory
--NewDefaultRpcFactorymethod create a new instance of the factory. -
- - - - - - - - - - - - - - - - - - - -build - Go Documentation Server + + + + + + + + + + + + + ++... ++ ++ + + +++ + diff --git a/docs/pkg/clients/index.html b/docs/pkg/clients/index.html index ada761b..bdfb2c1 100644 --- a/docs/pkg/clients/index.html +++ b/docs/pkg/clients/index.html @@ -1,992 +1,992 @@ - - - - - - - -+ + +++ Package build + +
+ + + + + + + + + + + + + + + + + + + +++ +++ +Overview ▹
+++ + + + + + + + + +++ +Index ▹
+type DefaultRpcFactory + ¶ + + +
++See Factory +See HttpEndpoint +See HeartbeatRestService +See StatusRestService +
+ +type DefaultRpcFactory struct { + cbuild.Factory +} ++ + + + + + + + + + + +func NewDefaultRpcFactory + ¶ + + +
+func NewDefaultRpcFactory() *DefaultRpcFactory
++NewDefaultRpcFactorymethod create a new instance of the factory. +
+ + + + + + + + + + + + + + + + + + + +clients - Go Documentation Server - - - - - - - - - - - - - --... -- -- - - --- - + + + + + + + +- - --- Package clients - -
- - - - - - - - - - - - - - - - - - - --- --- -Overview ▹
--- - - - - - - - --- -Index ▹
-func ConvertComandResult - ¶ - - -
-func ConvertComandResult(comRes interface{}, prototype reflect.Type) (convRes interface{}, err error)--ConvertComandResult method helps get correct result from JSON by prototype -Parameters: -
-- comRes interface{} input JSON string -- prototype reflect.Type output object prototype ---Returns: convRes interface{}, err error -
- - - - - - - - -type CommandableHttpClient - ¶ - - -
--CommandableHttpClient is abstract client that calls commandable HTTP service. -
--Commandable services are generated automatically for ICommandable objects. -Each command is exposed as POST operation that receives all parameters -in body object. -
--Configuration parameters: -
-base_route: base route for remote URI -- connection(s): - - discovery_key: (optional) a key to retrieve the connection from connect.idiscovery.html IDiscovery]] - - protocol: connection protocol: http or https - - host: host name or IP address - - port: port number - - uri: resource URI or connection string with all parameters in it -- options: - - retries: number of retries (default: 3) - - connect_timeout: connection timeout in milliseconds (default: 10 sec) - - timeout: invocation timeout in milliseconds (default: 10 sec) -
--References: -
--- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection -
--Example: -
-type MyCommandableHttpClient struct{ - *CommandableHttpClient - prototype reflect.Type // type of operation data - ... -} - result, err := func (c * MyCommandableHttpClient) GetData(correlationId string, id string)(result MyData, err error){ - - params:= cdata.NewEmptyStringValueMap() - params.Set("id",id) - res, err := c.CallCommand( - prototype - "get_data", - correlationId, - params) - ... - // convert response to MyData - ... - return result, err - } - -client = NewMyCommandableHttpClient(); -client.Configure(cconf.NewConfigParamsFromTuples( - "connection.protocol", "http", - "connection.host", "localhost", - "connection.port", 8080 -)); - -result, err := client.GetData("123", "1") -... -- -type CommandableHttpClient struct { - *RestClient -} -- - - - - - - - - - - -func NewCommandableHttpClient - ¶ - - -
-func NewCommandableHttpClient(baseRoute string) *CommandableHttpClient
--NewCommandableHttpClient is creates a new instance of the client. -Parameters: -
-- baseRoute string a base route for remote service. -
--Returns: *CommandableHttpClient -pointer on new instance -
- - - - - - - -func (*CommandableHttpClient) CallCommand - ¶ - - -
-func (c *CommandableHttpClient) CallCommand(prototype reflect.Type, name string, correlationId string, params *cdata.AnyValueMap) (result interface{}, err error)
--CallCommand is calls a remote method via HTTP commadable protocol. -The call is made via POST operation and all parameters are sent in body object. -The complete route to remote method is defined as baseRoute + "/" + name. -Parameters: -
-- prototype reflect.Type type of returned data -- name string a name of the command to call. -- correlationId string (optional) transaction id to trace execution through call chain. -- params cdata.StringValueMap command parameters. -
--Returns: result interface{}, err error -result or error. -
- - - - - - - - -type DirectClient - ¶ - - -
--DirectClient is bstract client that calls controller directly in the same memory space. -
--It is used when multiple microservices are deployed in a single container (monolyth) -and communication between them can be done by direct calls rather then through -the network. -
--Configuration parameters: -
--- dependencies: -
-- controller: override controller descriptor -
--References: -
--- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:controller:*:*:1.0 controller to call business methods -
--Example: -
-type MyDirectClient struct { - *DirectClient - } - func MyDirectClient()* MyDirectClient { - c:= MyDirectClient{} - c.DirectClient = NewDirectClient() - c.DependencyResolver.Put("controller", cref.NewDescriptor( - "mygroup", "controller", "*", "*", "*")); - } - - func (c *MyDirectClient) SetReferences(references cref.IReferences) { - c.DirectClient.SetReferences(references) - specificController, ok := c.Controller.(tdata.IMyDataController) - if !ok { - panic("MyDirectClient: Cant't resolv dependency 'controller' to IMyDataController") - } - c.specificController = specificController - } - ... - - func (c * MyDirectClient) GetData(correlationId string, id string)(result MyData, err error) { - timing := c.Instrument(correlationId, "myclient.get_data") - cmRes, cmdErr := c.specificController.GetData(correlationId, id) - timing.EndTiming(); - return c.InstrumentError(correlationId, "myclient.get_data", cmdRes, cmdErr) - } - ... - - client = NewMyDirectClient(); - client.SetReferences(cref.NewReferencesFromTuples( - cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller, - )); - - res, err := client.GetData("123", "1") -- -type DirectClient struct { - //The controller reference. - Controller interface{} - //The open flag. - Opened bool - //The logger. - Logger *clog.CompositeLogger - //The performance counters - Counters *ccount.CompositeCounters - //The dependency resolver to get controller reference. - DependencyResolver crefer.DependencyResolver - // The tracer. - Tracer *ctrace.CompositeTracer -} -- - - - - - - - - - - -func NewDirectClient - ¶ - - -
-func NewDirectClient() *DirectClient
--NewDirectClient is creates a new instance of the client. -
- - - - - - - -func (*DirectClient) Close - ¶ - - -
-func (c *DirectClient) Close(correlationId string) error
--Close method are closes component and frees used resources. -
-- correlationId string (optional) transaction id to trace execution through call chain. -
--Returns: error -error or nil no errors occured. -
- - - - - - -func (*DirectClient) Configure - ¶ - - -
-func (c *DirectClient) Configure(config *cconf.ConfigParams)
--Configure method are configures component by passing configuration parameters. -Parameters: -
-- config *cconf.ConfigParams configuration parameters to be set. -
- - - - - - -func (*DirectClient) Instrument - ¶ - - -
-func (c *DirectClient) Instrument(correlationId string, name string) *service.InstrumentTiming
--Instrument method are adds instrumentation to log calls and measure call time. -It returns a Timing object that is used to end the time measurement. -Parameters: -
-- correlationId string (optional) transaction id to trace execution through call chain. -- name string a method name. -
--Returns Timing object to end the time measurement. -
- - - - - - -func (*DirectClient) IsOpen - ¶ - - -
-func (c *DirectClient) IsOpen() bool
--IsOpen method are checks if the component is opened. -Returns true if the component has been opened and false otherwise. -
- - - - - - -func (*DirectClient) Open - ¶ - - -
-func (c *DirectClient) Open(correlationId string) error
--Open method are opens the component. -
-- correlationId string (optional) transaction id to trace execution through call chain. -
--Returns: error -error or nil no errors occured. -
- - - - - - -func (*DirectClient) SetReferences - ¶ - - -
-func (c *DirectClient) SetReferences(references crefer.IReferences)
--SetReferences method are sets references to dependent components. -Parameters: -- references crefer.IReferences references to locate the component dependencies. -
- - - - - - - - -type RestClient - ¶ - - -
--RestClient is abstract client that calls remove endpoints using HTTP/REST protocol. -
--Configuration parameters: -
-- base_route: base route for remote URI - - connection(s): - - discovery_key: (optional) a key to retrieve the connection from IDiscovery - - protocol: connection protocol: http or https - - host: host name or IP address - - port: port number - - uri: resource URI or connection string with all parameters in it - - options: - - retries: number of retries (default: 3) - - connectTimeout: connection timeout in milliseconds (default: 10 sec) - - timeout: invocation timeout in milliseconds (default: 10 sec) - - correlation_id_place place for adding correalationId, query - in query string, headers - in headers, both - in query and headers (default: query) -
--References: -- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection -
--See RestService -See CommandableHttpService -
-Example: - type MyRestClient struct { - *RestClient - } - ... - func (c *MyRestClient) GetData(correlationId string, id string) (result *tdata.MyDataPage, err error) { - - params := cdata.NewEmptyStringValueMap() - params.Set("id", id) - - calValue, calErr := c.Call(MyDataPageType, "get", "/data", correlationId, params, nil) - if calErr != nil { - return nil, calErr - } - - result, _ = calValue.(*tdata.MyDataPage) - c.Instrument(correlationId, "myData.get_page_by_filter") - return result, nil - } - - client := NewMyRestClient(); - client.Configure(cconf.NewConfigParamsFromTuples( - "connection.protocol", "http", - "connection.host", "localhost", - "connection.port", 8080, - )); - - result, err := client.GetData("123", "1") - ... -- -type RestClient struct { - - //The HTTP client. - Client *http.Client - //The connection resolver. - ConnectionResolver rpccon.HttpConnectionResolver - //The logger. - Logger *clog.CompositeLogger - //The performance counters. - Counters *ccount.CompositeCounters - // The tracer. - Tracer *ctrace.CompositeTracer - //The configuration options. - Options cconf.ConfigParams - //The base route. - BaseRoute string - //The number of retries. - Retries int - //The default headers to be added to every request. - Headers cdata.StringValueMap - //The connection timeout in milliseconds. - ConnectTimeout int - //The invocation timeout in milliseconds. - Timeout int - //The remote service uri which is calculated on open. - Uri string - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewRestClient - ¶ - - -
-func NewRestClient() *RestClient
--NewRestClient creates new instance of RestClient -Retruns pointer on NewRestClient -
- - - - - - - -func (*RestClient) AddCorrelationId - ¶ - - -
-func (c *RestClient) AddCorrelationId(params *cdata.StringValueMap, correlationId string) *cdata.StringValueMap
--AddCorrelationId method are adds a correlation id (correlation_id) to invocation parameter map. -Parameters: -
-- params *cdata.StringValueMap invocation parameters. - - correlationId string (optional) a correlation id to be added. -Return invocation parameters with added correlation id. -
- - - - - - -func (*RestClient) AddFilterParams - ¶ - - -
-func (c *RestClient) AddFilterParams(params *cdata.StringValueMap, filter *cdata.FilterParams) *cdata.StringValueMap
--AddFilterParams method are adds filter parameters (with the same name as they defined) -to invocation parameter map. -Parameters: -
-- params *cdata.StringValueMap invocation parameters. -- filter *cdata.FilterParams (optional) filter parameters -
--Return invocation parameters with added filter parameters. -
- - - - - - -func (*RestClient) AddPagingParams - ¶ - - -
-func (c *RestClient) AddPagingParams(params *cdata.StringValueMap, paging *cdata.PagingParams) *cdata.StringValueMap
--AddPagingParams method are adds paging parameters (skip, take, total) to invocation parameter map. -Parameters: -
-- params invocation parameters. -- paging (optional) paging parameters -
--Return invocation parameters with added paging parameters. -
- - - - - - -func (*RestClient) Call - ¶ - - -
-func (c *RestClient) Call(prototype reflect.Type, method string, route string, correlationId string, params *cdata.StringValueMap, - data interface{}) (result interface{}, err error)
--Call method are calls a remote method via HTTP/REST protocol. -Parameters: -
-- prototype reflect.Type type for convert JSON result. Set nil for return raw JSON string - - method string HTTP method: "get", "head", "post", "put", "delete" - - route string a command route. Base route will be added to this route - - correlationId string (optional) transaction id to trace execution through call chain. - - params cdata.StringValueMap (optional) query parameters. - - data interface{} (optional) body object. ---Returns: result interface{}, err error -result object or error. -
- - - - - - -func (*RestClient) Close - ¶ - - -
-func (c *RestClient) Close(correlationId string) error
--Close method are closes component and frees used resources. -Parameters: -
-- correlationId string (optional) transaction id to trace execution through call chain. -
--Retruns: error -error or nil no errors occured. -
- - - - - - -func (*RestClient) Configure - ¶ - - -
-func (c *RestClient) Configure(config *cconf.ConfigParams)
--Configures component by passing configuration parameters. -Parameters: -- config *cconf.ConfigParams configuration parameters to be set. -
- - - - - - -func (*RestClient) Instrument - ¶ - - -
-func (c *RestClient) Instrument(correlationId string, name string) *service.InstrumentTiming
--Instrument method are adds instrumentation to log calls and measure call time. -It returns a Timing object that is used to end the time measurement. -Parameters: -- correlationId string (optional) transaction id to trace execution through call chain. -- name string a method name. -Return Timing object to end the time measurement. -
- - - - - - -func (*RestClient) InstrumentError - ¶ - - -
-func (c *RestClient) InstrumentError(correlationId string, name string, inErr error, inRes interface{}) (result interface{}, err error)
--InstrumentError method are dds instrumentation to error handling. -
-- correlationId string (optional) transaction id to trace execution through call chain. -- name string a method name. -- err error an occured error -- result interface{} (optional) an execution result ---Returns: result interface{}, err error -an execution result and error -
- - - - - - -func (*RestClient) IsOpen - ¶ - - -
-func (c *RestClient) IsOpen() bool
--IsOpen are checks if the component is opened. -Return true if the component has been opened and false otherwise. -
- - - - - - -func (*RestClient) Open - ¶ - - -
-func (c *RestClient) Open(correlationId string) error
--Open method are opens the component. -
-- correlationId string (optional) transaction id to trace execution through call chain. -
--Returns: error -error or nil no errors occured. -
- - - - - - -func (*RestClient) SetReferences - ¶ - - -
-func (c *RestClient) SetReferences(references crefer.IReferences)
--Sets references to dependent components. -Parameters: -- references crefer.IReferences references to locate the component dependencies. -
- - - - - - - - - - - - - - - - - - -clients - Go Documentation Server + + + + + + + + + + + + + ++... ++ ++ + + +++ + diff --git a/docs/pkg/connect/index.html b/docs/pkg/connect/index.html index 403a54e..d87d8d1 100644 --- a/docs/pkg/connect/index.html +++ b/docs/pkg/connect/index.html @@ -1,361 +1,361 @@ - - - - - - - -+ + +++ Package clients + +
+ + + + + + + + + + + + + + + + + + + +++ +++ +Overview ▹
+++ + + + + + + + +++ +Index ▹
+func ConvertComandResult + ¶ + + +
+func ConvertComandResult(comRes interface{}, prototype reflect.Type) (convRes interface{}, err error)++ConvertComandResult method helps get correct result from JSON by prototype +Parameters: +
+- comRes interface{} input JSON string +- prototype reflect.Type output object prototype +++Returns: convRes interface{}, err error +
+ + + + + + + + +type CommandableHttpClient + ¶ + + +
++CommandableHttpClient is abstract client that calls commandable HTTP service. +
++Commandable services are generated automatically for ICommandable objects. +Each command is exposed as POST operation that receives all parameters +in body object. +
++Configuration parameters: +
+base_route: base route for remote URI +- connection(s): + - discovery_key: (optional) a key to retrieve the connection from connect.idiscovery.html IDiscovery]] + - protocol: connection protocol: http or https + - host: host name or IP address + - port: port number + - uri: resource URI or connection string with all parameters in it +- options: + - retries: number of retries (default: 3) + - connect_timeout: connection timeout in milliseconds (default: 10 sec) + - timeout: invocation timeout in milliseconds (default: 10 sec) +
++References: +
++- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection +
++Example: +
+type MyCommandableHttpClient struct{ + *CommandableHttpClient + prototype reflect.Type // type of operation data + ... +} + result, err := func (c * MyCommandableHttpClient) GetData(correlationId string, id string)(result MyData, err error){ + + params:= cdata.NewEmptyStringValueMap() + params.Set("id",id) + res, err := c.CallCommand( + prototype + "get_data", + correlationId, + params) + ... + // convert response to MyData + ... + return result, err + } + +client = NewMyCommandableHttpClient(); +client.Configure(cconf.NewConfigParamsFromTuples( + "connection.protocol", "http", + "connection.host", "localhost", + "connection.port", 8080 +)); + +result, err := client.GetData("123", "1") +... ++ +type CommandableHttpClient struct { + *RestClient +} ++ + + + + + + + + + + +func NewCommandableHttpClient + ¶ + + +
+func NewCommandableHttpClient(baseRoute string) *CommandableHttpClient
++NewCommandableHttpClient is creates a new instance of the client. +Parameters: +
+- baseRoute string a base route for remote service. +
++Returns: *CommandableHttpClient +pointer on new instance +
+ + + + + + + +func (*CommandableHttpClient) CallCommand + ¶ + + +
+func (c *CommandableHttpClient) CallCommand(prototype reflect.Type, name string, correlationId string, params *cdata.AnyValueMap) (result interface{}, err error)
++CallCommand is calls a remote method via HTTP commadable protocol. +The call is made via POST operation and all parameters are sent in body object. +The complete route to remote method is defined as baseRoute + "/" + name. +Parameters: +
+- prototype reflect.Type type of returned data +- name string a name of the command to call. +- correlationId string (optional) transaction id to trace execution through call chain. +- params cdata.StringValueMap command parameters. +
++Returns: result interface{}, err error +result or error. +
+ + + + + + + + +type DirectClient + ¶ + + +
++DirectClient is bstract client that calls controller directly in the same memory space. +
++It is used when multiple microservices are deployed in a single container (monolyth) +and communication between them can be done by direct calls rather then through +the network. +
++Configuration parameters: +
++- dependencies: +
+- controller: override controller descriptor +
++References: +
++- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:controller:*:*:1.0 controller to call business methods +
++Example: +
+type MyDirectClient struct { + *DirectClient + } + func MyDirectClient()* MyDirectClient { + c:= MyDirectClient{} + c.DirectClient = NewDirectClient() + c.DependencyResolver.Put("controller", cref.NewDescriptor( + "mygroup", "controller", "*", "*", "*")); + } + + func (c *MyDirectClient) SetReferences(references cref.IReferences) { + c.DirectClient.SetReferences(references) + specificController, ok := c.Controller.(tdata.IMyDataController) + if !ok { + panic("MyDirectClient: Cant't resolv dependency 'controller' to IMyDataController") + } + c.specificController = specificController + } + ... + + func (c * MyDirectClient) GetData(correlationId string, id string)(result MyData, err error) { + timing := c.Instrument(correlationId, "myclient.get_data") + cmRes, cmdErr := c.specificController.GetData(correlationId, id) + timing.EndTiming(); + return c.InstrumentError(correlationId, "myclient.get_data", cmdRes, cmdErr) + } + ... + + client = NewMyDirectClient(); + client.SetReferences(cref.NewReferencesFromTuples( + cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller, + )); + + res, err := client.GetData("123", "1") ++ +type DirectClient struct { + //The controller reference. + Controller interface{} + //The open flag. + Opened bool + //The logger. + Logger *clog.CompositeLogger + //The performance counters + Counters *ccount.CompositeCounters + //The dependency resolver to get controller reference. + DependencyResolver crefer.DependencyResolver + // The tracer. + Tracer *ctrace.CompositeTracer +} ++ + + + + + + + + + + +func NewDirectClient + ¶ + + +
+func NewDirectClient() *DirectClient
++NewDirectClient is creates a new instance of the client. +
+ + + + + + + +func (*DirectClient) Close + ¶ + + +
+func (c *DirectClient) Close(correlationId string) error
++Close method are closes component and frees used resources. +
+- correlationId string (optional) transaction id to trace execution through call chain. +
++Returns: error +error or nil no errors occured. +
+ + + + + + +func (*DirectClient) Configure + ¶ + + +
+func (c *DirectClient) Configure(config *cconf.ConfigParams)
++Configure method are configures component by passing configuration parameters. +Parameters: +
+- config *cconf.ConfigParams configuration parameters to be set. +
+ + + + + + +func (*DirectClient) Instrument + ¶ + + +
+func (c *DirectClient) Instrument(correlationId string, name string) *service.InstrumentTiming
++Instrument method are adds instrumentation to log calls and measure call time. +It returns a Timing object that is used to end the time measurement. +Parameters: +
+- correlationId string (optional) transaction id to trace execution through call chain. +- name string a method name. +
++Returns Timing object to end the time measurement. +
+ + + + + + +func (*DirectClient) IsOpen + ¶ + + +
+func (c *DirectClient) IsOpen() bool
++IsOpen method are checks if the component is opened. +Returns true if the component has been opened and false otherwise. +
+ + + + + + +func (*DirectClient) Open + ¶ + + +
+func (c *DirectClient) Open(correlationId string) error
++Open method are opens the component. +
+- correlationId string (optional) transaction id to trace execution through call chain. +
++Returns: error +error or nil no errors occured. +
+ + + + + + +func (*DirectClient) SetReferences + ¶ + + +
+func (c *DirectClient) SetReferences(references crefer.IReferences)
++SetReferences method are sets references to dependent components. +Parameters: +- references crefer.IReferences references to locate the component dependencies. +
+ + + + + + + + +type RestClient + ¶ + + +
++RestClient is abstract client that calls remove endpoints using HTTP/REST protocol. +
++Configuration parameters: +
+- base_route: base route for remote URI + - connection(s): + - discovery_key: (optional) a key to retrieve the connection from IDiscovery + - protocol: connection protocol: http or https + - host: host name or IP address + - port: port number + - uri: resource URI or connection string with all parameters in it + - options: + - retries: number of retries (default: 3) + - connectTimeout: connection timeout in milliseconds (default: 10 sec) + - timeout: invocation timeout in milliseconds (default: 10 sec) + - correlation_id_place place for adding correalationId, query - in query string, headers - in headers, both - in query and headers (default: query) +
++References: +- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection +
++See RestService +See CommandableHttpService +
+Example: + type MyRestClient struct { + *RestClient + } + ... + func (c *MyRestClient) GetData(correlationId string, id string) (result *tdata.MyDataPage, err error) { + + params := cdata.NewEmptyStringValueMap() + params.Set("id", id) + + calValue, calErr := c.Call(MyDataPageType, "get", "/data", correlationId, params, nil) + if calErr != nil { + return nil, calErr + } + + result, _ = calValue.(*tdata.MyDataPage) + c.Instrument(correlationId, "myData.get_page_by_filter") + return result, nil + } + + client := NewMyRestClient(); + client.Configure(cconf.NewConfigParamsFromTuples( + "connection.protocol", "http", + "connection.host", "localhost", + "connection.port", 8080, + )); + + result, err := client.GetData("123", "1") + ... ++ +type RestClient struct { + + //The HTTP client. + Client *http.Client + //The connection resolver. + ConnectionResolver rpccon.HttpConnectionResolver + //The logger. + Logger *clog.CompositeLogger + //The performance counters. + Counters *ccount.CompositeCounters + // The tracer. + Tracer *ctrace.CompositeTracer + //The configuration options. + Options cconf.ConfigParams + //The base route. + BaseRoute string + //The number of retries. + Retries int + //The default headers to be added to every request. + Headers cdata.StringValueMap + //The connection timeout in milliseconds. + ConnectTimeout int + //The invocation timeout in milliseconds. + Timeout int + //The remote service uri which is calculated on open. + Uri string + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewRestClient + ¶ + + +
+func NewRestClient() *RestClient
++NewRestClient creates new instance of RestClient +Retruns pointer on NewRestClient +
+ + + + + + + +func (*RestClient) AddCorrelationId + ¶ + + +
+func (c *RestClient) AddCorrelationId(params *cdata.StringValueMap, correlationId string) *cdata.StringValueMap
++AddCorrelationId method are adds a correlation id (correlation_id) to invocation parameter map. +Parameters: +
+- params *cdata.StringValueMap invocation parameters. + - correlationId string (optional) a correlation id to be added. +Return invocation parameters with added correlation id. +
+ + + + + + +func (*RestClient) AddFilterParams + ¶ + + +
+func (c *RestClient) AddFilterParams(params *cdata.StringValueMap, filter *cdata.FilterParams) *cdata.StringValueMap
++AddFilterParams method are adds filter parameters (with the same name as they defined) +to invocation parameter map. +Parameters: +
+- params *cdata.StringValueMap invocation parameters. +- filter *cdata.FilterParams (optional) filter parameters +
++Return invocation parameters with added filter parameters. +
+ + + + + + +func (*RestClient) AddPagingParams + ¶ + + +
+func (c *RestClient) AddPagingParams(params *cdata.StringValueMap, paging *cdata.PagingParams) *cdata.StringValueMap
++AddPagingParams method are adds paging parameters (skip, take, total) to invocation parameter map. +Parameters: +
+- params invocation parameters. +- paging (optional) paging parameters +
++Return invocation parameters with added paging parameters. +
+ + + + + + +func (*RestClient) Call + ¶ + + +
+func (c *RestClient) Call(prototype reflect.Type, method string, route string, correlationId string, params *cdata.StringValueMap, + data interface{}) (result interface{}, err error)
++Call method are calls a remote method via HTTP/REST protocol. +Parameters: +
+- prototype reflect.Type type for convert JSON result. Set nil for return raw JSON string + - method string HTTP method: "get", "head", "post", "put", "delete" + - route string a command route. Base route will be added to this route + - correlationId string (optional) transaction id to trace execution through call chain. + - params cdata.StringValueMap (optional) query parameters. + - data interface{} (optional) body object. +++Returns: result interface{}, err error +result object or error. +
+ + + + + + +func (*RestClient) Close + ¶ + + +
+func (c *RestClient) Close(correlationId string) error
++Close method are closes component and frees used resources. +Parameters: +
+- correlationId string (optional) transaction id to trace execution through call chain. +
++Retruns: error +error or nil no errors occured. +
+ + + + + + +func (*RestClient) Configure + ¶ + + +
+func (c *RestClient) Configure(config *cconf.ConfigParams)
++Configures component by passing configuration parameters. +Parameters: +- config *cconf.ConfigParams configuration parameters to be set. +
+ + + + + + +func (*RestClient) Instrument + ¶ + + +
+func (c *RestClient) Instrument(correlationId string, name string) *service.InstrumentTiming
++Instrument method are adds instrumentation to log calls and measure call time. +It returns a Timing object that is used to end the time measurement. +Parameters: +- correlationId string (optional) transaction id to trace execution through call chain. +- name string a method name. +Return Timing object to end the time measurement. +
+ + + + + + +func (*RestClient) InstrumentError + ¶ + + +
+func (c *RestClient) InstrumentError(correlationId string, name string, inErr error, inRes interface{}) (result interface{}, err error)
++InstrumentError method are dds instrumentation to error handling. +
+- correlationId string (optional) transaction id to trace execution through call chain. +- name string a method name. +- err error an occured error +- result interface{} (optional) an execution result +++Returns: result interface{}, err error +an execution result and error +
+ + + + + + +func (*RestClient) IsOpen + ¶ + + +
+func (c *RestClient) IsOpen() bool
++IsOpen are checks if the component is opened. +Return true if the component has been opened and false otherwise. +
+ + + + + + +func (*RestClient) Open + ¶ + + +
+func (c *RestClient) Open(correlationId string) error
++Open method are opens the component. +
+- correlationId string (optional) transaction id to trace execution through call chain. +
++Returns: error +error or nil no errors occured. +
+ + + + + + +func (*RestClient) SetReferences + ¶ + + +
+func (c *RestClient) SetReferences(references crefer.IReferences)
++Sets references to dependent components. +Parameters: +- references crefer.IReferences references to locate the component dependencies. +
+ + + + + + + + + + + + + + + + + + +connect - Go Documentation Server - - - - - - - - - - - - - --... -- -- - - --- - + + + + + + + +- - --- Package connect - -
- - - - - - - - - - - - - - - - - - - --- --- -Overview ▹
--- - - - - - - - - --- -Index ▹
-type HttpConnectionResolver - ¶ - - -
--HttpConnectionResolver helper class to retrieve connections for HTTP-based services abd clients. -
--In addition to regular functions of ConnectionResolver is able to parse http:// URIs -and validate connection parameters before returning them. -
--Configuration parameters: -
-- connection: - - discovery_key: (optional) a key to retrieve the connection from IDiscovery - - ... other connection parameters - - - connections: alternative to connection - - [connection params 1]: first connection parameters - - ... - - [connection params N]: Nth connection parameters - - ... - -References: -
--- *:discovery:*:*:1.0 (optional) IDiscovery services -
--See: ConnectionParams -See: ConnectionResolver -
--Example: -
-config := cconf.NewConfigParamsFromTuples( - "connection.host", "10.1.1.100", - "connection.port", 8080, - ); - - connectionResolver = NewHttpConnectionResolver(); - connectionResolver.Configure(config); - connectionResolver.SetReferences(references); - - connection, err := connectionResolver.Resolve("123") - // Now use connection... -- -type HttpConnectionResolver struct { - //The base connection resolver. - ConnectionResolver ccon.ConnectionResolver - //The base credential resolver. - CredentialResolver cauth.CredentialResolver -} -- - - - - - - - - - - -func NewHttpConnectionResolver - ¶ - - -
-func NewHttpConnectionResolver() *HttpConnectionResolver
--NewHttpConnectionResolver creates new instance NewHttpConnectionResolver -Returns pointer on NewHttpConnectionResolver -
- - - - - - - -func (*HttpConnectionResolver) Configure - ¶ - - -
-func (c *HttpConnectionResolver) Configure(config *cconf.ConfigParams)
--Configure method are configures component by passing configuration parameters. -Parameters: -
-- config *cconf.ConfigParams configuration parameters to be set. -
- - - - - - -func (*HttpConnectionResolver) Register - ¶ - - -
-func (c *HttpConnectionResolver) Register(correlationId string) error
- - - - - - -func (*HttpConnectionResolver) Resolve - ¶ - - -
-func (c *HttpConnectionResolver) Resolve(correlationId string) (connection *ccon.ConnectionParams, credential *cauth.CredentialParams, err error)
--Resolve method are resolves a single component connection. If connections are configured to be retrieved -from Discovery service it finds a IDiscovery and resolves the connection there. -Parameters: -- correlationId string (optional) transaction id to trace execution through call chain. -Returns: connection *ccon.ConnectionParams, credential *cauth.CredentialParams, err error -resolved connection and credential or error. -
- - - - - - -func (*HttpConnectionResolver) ResolveAll - ¶ - - -
-func (c *HttpConnectionResolver) ResolveAll(correlationId string) (connections []*ccon.ConnectionParams, credential *cauth.CredentialParams, err error)
--ResolveAll method are resolves all component connection. If connections are configured to be retrieved -from Discovery service it finds a IDiscovery and resolves the connection there. -Parameters: -- correlationId string (optional) transaction id to trace execution through call chain. -Returns: connections []*ccon.ConnectionParams, credential *cauth.CredentialParams, err error -resolved connections and credential or error. -
- - - - - - -func (*HttpConnectionResolver) SetReferences - ¶ - - -
-func (c *HttpConnectionResolver) SetReferences(references crefer.IReferences)
--SetReferences method are sets references to dependent components. -Parameters: -
-- references crefer.IReferences references to locate the component dependencies. -
- - - - - - - - - - - - - - - - - - -connect - Go Documentation Server + + + + + + + + + + + + + ++... ++ ++ + + +++ + diff --git a/docs/pkg/index.html b/docs/pkg/index.html index 1c5d9dd..7ee3124 100644 --- a/docs/pkg/index.html +++ b/docs/pkg/index.html @@ -1,291 +1,291 @@ - - - - - - - -+ + +++ Package connect + +
+ + + + + + + + + + + + + + + + + + + +++ +++ +Overview ▹
+++ + + + + + + + + +++ +Index ▹
+type HttpConnectionResolver + ¶ + + +
++HttpConnectionResolver helper class to retrieve connections for HTTP-based services abd clients. +
++In addition to regular functions of ConnectionResolver is able to parse http:// URIs +and validate connection parameters before returning them. +
++Configuration parameters: +
+- connection: + - discovery_key: (optional) a key to retrieve the connection from IDiscovery + - ... other connection parameters + + - connections: alternative to connection + - [connection params 1]: first connection parameters + - ... + - [connection params N]: Nth connection parameters + - ... + +References: +
++- *:discovery:*:*:1.0 (optional) IDiscovery services +
++See: ConnectionParams +See: ConnectionResolver +
++Example: +
+config := cconf.NewConfigParamsFromTuples( + "connection.host", "10.1.1.100", + "connection.port", 8080, + ); + + connectionResolver = NewHttpConnectionResolver(); + connectionResolver.Configure(config); + connectionResolver.SetReferences(references); + + connection, err := connectionResolver.Resolve("123") + // Now use connection... ++ +type HttpConnectionResolver struct { + //The base connection resolver. + ConnectionResolver ccon.ConnectionResolver + //The base credential resolver. + CredentialResolver cauth.CredentialResolver +} ++ + + + + + + + + + + +func NewHttpConnectionResolver + ¶ + + +
+func NewHttpConnectionResolver() *HttpConnectionResolver
++NewHttpConnectionResolver creates new instance NewHttpConnectionResolver +Returns pointer on NewHttpConnectionResolver +
+ + + + + + + +func (*HttpConnectionResolver) Configure + ¶ + + +
+func (c *HttpConnectionResolver) Configure(config *cconf.ConfigParams)
++Configure method are configures component by passing configuration parameters. +Parameters: +
+- config *cconf.ConfigParams configuration parameters to be set. +
+ + + + + + +func (*HttpConnectionResolver) Register + ¶ + + +
+func (c *HttpConnectionResolver) Register(correlationId string) error
+ + + + + + +func (*HttpConnectionResolver) Resolve + ¶ + + +
+func (c *HttpConnectionResolver) Resolve(correlationId string) (connection *ccon.ConnectionParams, credential *cauth.CredentialParams, err error)
++Resolve method are resolves a single component connection. If connections are configured to be retrieved +from Discovery service it finds a IDiscovery and resolves the connection there. +Parameters: +- correlationId string (optional) transaction id to trace execution through call chain. +Returns: connection *ccon.ConnectionParams, credential *cauth.CredentialParams, err error +resolved connection and credential or error. +
+ + + + + + +func (*HttpConnectionResolver) ResolveAll + ¶ + + +
+func (c *HttpConnectionResolver) ResolveAll(correlationId string) (connections []*ccon.ConnectionParams, credential *cauth.CredentialParams, err error)
++ResolveAll method are resolves all component connection. If connections are configured to be retrieved +from Discovery service it finds a IDiscovery and resolves the connection there. +Parameters: +- correlationId string (optional) transaction id to trace execution through call chain. +Returns: connections []*ccon.ConnectionParams, credential *cauth.CredentialParams, err error +resolved connections and credential or error. +
+ + + + + + +func (*HttpConnectionResolver) SetReferences + ¶ + + +
+func (c *HttpConnectionResolver) SetReferences(references crefer.IReferences)
++SetReferences method are sets references to dependent components. +Parameters: +
+- references crefer.IReferences references to locate the component dependencies. +
+ + + + + + + + + + + + + + + + + + +rpc - Go Documentation Server - - - - - - - - - - - - - --... -- -- - - --- - + + + + + + + +- - --- Package rpc - -
- - - - - - - - - - - - - - - - - -Subdirectories
- --- -
- -
-
-- - - --- -Standard library ▹
-Other packages
-Sub-repositories
-- These packages are part of the Go Project but outside the main Go tree. - They are developed under looser compatibility requirements than the Go core. - Install them with "go get". -
--
-
Community
-- These services can help you find Open Source packages provided by the community. -
--
-
rpc - Go Documentation Server + + + + + + + + + + + + + ++... ++ ++ + + +++ + diff --git a/docs/pkg/services/index.html b/docs/pkg/services/index.html index c7a1e07..1fc7867 100644 --- a/docs/pkg/services/index.html +++ b/docs/pkg/services/index.html @@ -1,3055 +1,3055 @@ - - - - - - - -+ + +++ Package rpc + +
+ + + + + + + + + + + + + + + + + +Subdirectories
+ +++ +
+ -
+
++ + + +++ +Standard library ▹
+Other packages
+Sub-repositories
++ These packages are part of the Go Project but outside the main Go tree. + They are developed under looser compatibility requirements than the Go core. + Install them with "go get". +
+-
+
Community
++ These services can help you find Open Source packages provided by the community. +
+-
+
services - Go Documentation Server - - - - - - - - - - - - - --... -- -- - - --- - + + + + + + + +- - --- Package services - -
- - - - - - - - - - - - - - - - - - - --- --- -Overview ▹
--- - - - - --- -Index ▹
-Variables
- --HttpRequestDetector рelper class that retrieves parameters from HTTP requests. -
- -var HttpRequestDetector = THttpRequestDetector{}
- - - - - - -type AboutOperations - ¶ - - -
- -type AboutOperations struct { - RestOperations - // contains filtered or unexported fields -} -- - - - - - - - - - - - - -func (*AboutOperations) About - ¶ - - -
-func (c *AboutOperations) About(res http.ResponseWriter, req *http.Request)
- - - - - - -func (*AboutOperations) GetAboutOperation - ¶ - - -
-func (c *AboutOperations) GetAboutOperation() func(res http.ResponseWriter, req *http.Request)
- - - - - - -func (*AboutOperations) GetNetworkAddresses - ¶ - - -
-func (c *AboutOperations) GetNetworkAddresses() []string
- - - - - - -func (*AboutOperations) SetReferences - ¶ - - -
-func (c *AboutOperations) SetReferences(references crefer.IReferences)
- - - - - - - - -type CommandableHttpService - ¶ - - -
--CommandableHttpService abstract service that receives remove calls via HTTP/REST protocol -to operations automatically generated for commands defined in ICommandable components. -Each command is exposed as POST operation that receives all parameters in body object. -
--Commandable services require only 3 lines of code to implement a robust external -HTTP-based remote interface. -
--Configuration parameters: -
-- base_route: base route for remote URI -- dependencies: - - endpoint: override for HTTP Endpoint dependency - - controller: override for Controller dependency -- connection(s): - - discovery_key: (optional) a key to retrieve the connection from IDiscovery - - protocol: connection protocol: http or https - - host: host name or IP address - - port: port number - - uri: resource URI or connection string with all parameters in it -
--References: -
--- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection -- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference -
--See CommandableHttpClient -See RestService -
--Example: -
-type MyCommandableHttpService struct { - *CommandableHttpService - } - - func NewMyCommandableHttpService() *MyCommandableHttpService { - c := MyCommandableHttpService{ - CommandableHttpService: services.NewCommandableHttpService("dummies"), - } - c.DependencyResolver.Put("controller", cref.NewDescriptor("pip-services-dummies", "controller", "default", "*", "*")) - return &c - - service := NewMyCommandableHttpService(); - service.Configure(cconf.NewConfigParamsFromTuples( - "connection.protocol", "http", - "connection.host", "localhost", - "connection.port", 8080, - )); - service.SetReferences(cref.NewReferencesFromTuples( - cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller - )); - - opnErr:=service.Open("123") - if opnErr == nil { - fmt.Println("The REST service is running on port 8080"); - } -- -type CommandableHttpService struct { - *RestService - - SwaggerAuto bool - // contains filtered or unexported fields -} -- - - - - - - - - - - -func InheritCommandableHttpService - ¶ - - -
-func InheritCommandableHttpService(overrides IRestServiceOverrides, baseRoute string) *CommandableHttpService
--InheritCommandableHttpService creates a new instance of the service. -Parameters: -
-- overrides references to child class that overrides virtual methods -- baseRoute string a service base route. -
--Returns: *CommandableHttpService -pointer on new instance CommandableHttpService -
- - - - - - - -func (*CommandableHttpService) Configure - ¶ - - -
-func (c *CommandableHttpService) Configure(config *cconf.ConfigParams)
--Configure method configures component by passing configuration parameters. -
-- config configuration parameters to be set. -
- - - - - - -func (*CommandableHttpService) Register - ¶ - - -
-func (c *CommandableHttpService) Register()
--Register method are registers all service routes in HTTP endpoint. -
- - - - - - - - -type CommandableSwaggerDocument - ¶ - - -
- -type CommandableSwaggerDocument struct { - Commands []ccomands.ICommand - - Version string - BaseRoute string - - InfoTitle string - InfoDescription string - InfoVersion string - InfoTermsOfService string - - InfoContactName string - InfoContactUrl string - InfoContactEmail string - - InfoLicenseName string - InfoLicenseUrl string - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewCommandableSwaggerDocument - ¶ - - -
-func NewCommandableSwaggerDocument(baseRoute string, config *cconf.ConfigParams, commands []ccomands.ICommand) *CommandableSwaggerDocument
- - - - - - - -func (*CommandableSwaggerDocument) GetSpaces - ¶ - - -
-func (c *CommandableSwaggerDocument) GetSpaces(length int) string
- - - - - - -func (*CommandableSwaggerDocument) ToString - ¶ - - -
-func (c *CommandableSwaggerDocument) ToString() string
- - - - - - -func (*CommandableSwaggerDocument) WriteData - ¶ - - -
-func (c *CommandableSwaggerDocument) WriteData(indent int, data map[string]interface{})
- - - - - - -func (*CommandableSwaggerDocument) WriteName - ¶ - - -
-func (c *CommandableSwaggerDocument) WriteName(indent int, name string)
- - - - - - - - -type HeartbeatOperations - ¶ - - -
- -type HeartbeatOperations struct { - RestOperations -} -- - - - - - - - - - - -func NewHeartbeatOperations - ¶ - - -
-func NewHeartbeatOperations() *HeartbeatOperations
--NewHeartbeatOperations creates new instance HeartbeatOperations -Returns: *HeartbeatOperations -
- - - - - - - -func (*HeartbeatOperations) GetHeartbeatOperation - ¶ - - -
-func (c *HeartbeatOperations) GetHeartbeatOperation() func(res http.ResponseWriter, req *http.Request)
--Heartbeat method are insert timestamp into HTTP result -
- - - - - - -func (*HeartbeatOperations) Heartbeat - ¶ - - -
-func (c *HeartbeatOperations) Heartbeat(res http.ResponseWriter, req *http.Request)
--Heartbeat method are insert timestamp into HTTP result -
- - - - - - - - -type HeartbeatRestService - ¶ - - -
--HeartbeatRestService service returns heartbeat via HTTP/REST protocol. -
--The service responds on /heartbeat route (can be changed) -with a string with the current time in UTC. -
--This service route can be used to health checks by loadbalancers and -container orchestrators. -
--Configuration parameters: -
-- baseroute: base route for remote URI (default: "") -- route: route to heartbeat operation (default: "heartbeat") -- dependencies: - - endpoint: override for HTTP Endpoint dependency -- connection(s): - - discovery_key: (optional) a key to retrieve the connection from IDiscovery - - protocol: connection protocol: http or https - - host: host name or IP address - - port: port number - - uri: resource URI or connection string with all parameters in it -
--References: -
--- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection -- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference -
--See RestService -See RestClient -
--Example: -
-service := NewHeartbeatService(); -service.Configure(cconf.NewConfigParamsFromTuples( - "route", "ping", - "connection.protocol", "http", - "connection.host", "localhost", - "connection.port", 8080, -)); - -opnErr := service.Open("123") -if opnErr == nil { - fmt.Println("The Heartbeat service is accessible at http://+:8080/ping"); -} -- -type HeartbeatRestService struct { - *RestService - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewHeartbeatRestService - ¶ - - -
-func NewHeartbeatRestService() *HeartbeatRestService
--* -
-Creates a new instance of c service. -
- - - - - - - -func (*HeartbeatRestService) Configure - ¶ - - -
-func (c *HeartbeatRestService) Configure(config *cconf.ConfigParams)
--* -
-Configures component by passing configuration parameters. - -@param config configuration parameters to be set. -
- - - - - - -func (*HeartbeatRestService) Register - ¶ - - -
-func (c *HeartbeatRestService) Register()
--* -
-Registers all service routes in HTTP endpoint. -
- - - - - - - - -type HttpEndpoint - ¶ - - -
-HttpEndpoint used for creating HTTP endpoints. An endpoint is a URL, at which a given service can be accessed by a client. -
--Configuration parameters: -
--Parameters to pass to the configure method for component configuration: -
-- cors_headers - a comma-separated list of allowed CORS headers -- cors_origins - a comma-separated list of allowed CORS origins -- connection(s) - the connection resolver"s connections: - - "connection.discovery_key" - the key to use for connection resolving in a discovery service; - - "connection.protocol" - the connection"s protocol; - - "connection.host" - the target host; - - "connection.port" - the target port; - - "connection.uri" - the target URI. -- credential - the HTTPS credentials: - - "credential.ssl_key_file" - the SSL func (c *HttpEndpoint )key in PEM - - "credential.ssl_crt_file" - the SSL certificate in PEM - - "credential.ssl_ca_file" - the certificate authorities (root cerfiticates) in PEM -
--References: -
--A logger, counters, and a connection resolver can be referenced by passing the -following references to the object"s setReferences method: -
-- logger: "*:logger:*:*:1.0"; -- counters: "*:counters:*:*:1.0"; -- discovery: "*:discovery:*:*:1.0" (for the connection resolver). -
--Examples: -
-endpoint := NewHttpEndpoint(); - endpoint.Configure(config); - endpoint.SetReferences(references); - ... - endpoint.Open(correlationId) -
- -type HttpEndpoint struct { - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewHttpEndpoint - ¶ - - -
-func NewHttpEndpoint() *HttpEndpoint
--NewHttpEndpoint creates new HttpEndpoint -
- - - - - - - -func (*HttpEndpoint) AddCorsHeader - ¶ - - -
-func (c *HttpEndpoint) AddCorsHeader(header string, origin string)
--AddCORSHeader method adds allowed header, ignore if it already exist -must be call before to opening endpoint -
- - - - - - -func (*HttpEndpoint) Close - ¶ - - -
-func (c *HttpEndpoint) Close(correlationId string) error
--Close method are closes this endpoint and the REST server (service) that was opened earlier. -Parameters: -
-- correlationId string (optional) transaction id to trace execution through call chain. -
--Returns: error -an error if one is raised. -
- - - - - - -func (*HttpEndpoint) Configure - ¶ - - -
-func (c *HttpEndpoint) Configure(config *cconf.ConfigParams)
--Configure method are configures this HttpEndpoint using the given configuration parameters. -Configuration parameters: -
-- connection(s) - the connection resolver"s connections; - - "connection.discovery_key" - the key to use for connection resolving in a discovery service; - - "connection.protocol" - the connection"s protocol; - - "connection.host" - the target host; - - "connection.port" - the target port; - - "connection.uri" - the target URI. - - "credential.ssl_key_file" - SSL func (c *HttpEndpoint )key in PEM - - "credential.ssl_crt_file" - SSL certificate in PEM - - "credential.ssl_ca_file" - Certificate authority (root certificate) in PEM -- config configuration parameters, containing a "connection(s)" section. -
- - - - - - -func (*HttpEndpoint) GetCorrelationId - ¶ - - -
-func (c *HttpEndpoint) GetCorrelationId(req *http.Request) string
--GetCorrelationId method returns CorrelationId from request -Parameters: -
-req *http.Request request -
--Returns: string -retrun correlation_id or empty string -
- - - - - - -func (*HttpEndpoint) IsOpen - ¶ - - -
-func (c *HttpEndpoint) IsOpen() bool
--IsOpen method is whether or not this endpoint is open with an actively listening REST server. -
- - - - - - -func (*HttpEndpoint) Open - ¶ - - -
-func (c *HttpEndpoint) Open(correlationId string) error
--Opens a connection using the parameters resolved by the referenced connection -resolver and creates a REST server (service) using the set options and parameters. -Parameters: -
-- correlationId string (optional) transaction id to trace execution through call chain. -
--Returns : error -an error if one is raised. -
- - - - - - -func (*HttpEndpoint) Register - ¶ - - -
-func (c *HttpEndpoint) Register(registration IRegisterable)
--Registers a registerable object for dynamic endpoint discovery. -Parameters: -
-- registration IRegisterable implements of IRegisterable interface. -
--See IRegisterable -
- - - - - - -func (*HttpEndpoint) RegisterInterceptor - ¶ - - -
-func (c *HttpEndpoint) RegisterInterceptor(route string, action func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc))
--RegisterInterceptor method are registers a middleware action for the given route. -
-- route the route to register in this object"s REST server (service). -- action the middleware action to perform at the given route. -
- - - - - - -func (*HttpEndpoint) RegisterRoute - ¶ - - -
-func (c *HttpEndpoint) RegisterRoute(method string, route string, schema *cvalid.Schema, - action http.HandlerFunc)
--RegisterRoute method are registers an action in this objects REST server (service) by the given method and route. -
-- method string the HTTP method of the route. -- route string the route to register in this object"s REST server (service). -- schema *cvalid.Schema the schema to use for parameter validation. -- action http.HandlerFunc the action to perform at the given route. -
- - - - - - -func (*HttpEndpoint) RegisterRouteWithAuth - ¶ - - -
-func (c *HttpEndpoint) RegisterRouteWithAuth(method string, route string, schema *cvalid.Schema, - authorize func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc), - action http.HandlerFunc)
--RegisterRouteWithAuth method are registers an action with authorization in this objects REST server (service) -by the given method and route. -Parameters: -
-- method string the HTTP method of the route. -- route string the route to register in this object"s REST server (service). -- schema *cvalid.Schema the schema to use for parameter validation. -- authorize the authorization interceptor -- action the action to perform at the given route. -
- - - - - - -func (*HttpEndpoint) SetReferences - ¶ - - -
-func (c *HttpEndpoint) SetReferences(references crefer.IReferences)
--SetReferences method are sets references to this endpoint"s logger, counters, and connection resolver. -
-References: -- logger: "*:logger:*:*:1.0" -- counters: "*:counters:*:*:1.0" -- discovery: "*:discovery:*:*:1.0" (for the connection resolver) -
--Parameters: -
-- references an IReferences object, containing references to a logger, counters, - and a connection resolver. -
- - - - - - -func (*HttpEndpoint) Unregister - ¶ - - -
-func (c *HttpEndpoint) Unregister(registration IRegisterable)
--Unregisters a registerable object, so that it is no longer used in dynamic -endpoint discovery. -Parameters: -
-- registration IRegisterable the registration to remove. -
--See IRegisterable -
- - - - - - - - -type IRegisterable - ¶ - - -
--IRegisterable is interface to perform on-demand registrations. -
- -type IRegisterable interface { - // Perform required registration steps. - Register() -}- - - - - - - - - - - - - - - -type IRestServiceOverrides - ¶ - - -
- -type IRestServiceOverrides interface { - Register() -}- - - - - - - - - - - - - - - -type ISwaggerService - ¶ - - -
--ISwaggerService Interface to perform Swagger registrations. -
- -type ISwaggerService interface { - - // Perform required Swagger registration steps. - RegisterOpenApiSpec(baseRoute string, swaggerRoute string) -}- - - - - - - - - - - - - - - -type InstrumentTiming - ¶ - - -
- -type InstrumentTiming struct { - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewInstrumentTiming - ¶ - - -
-func NewInstrumentTiming(correlationId string, name string, - verb string, logger clog.ILogger, counters ccount.ICounters, - counterTiming *ccount.CounterTiming, traceTiming *ctrace.TraceTiming) *InstrumentTiming
- - - - - - - -func (*InstrumentTiming) EndFailure - ¶ - - -
-func (c *InstrumentTiming) EndFailure(err error)
- - - - - - -func (*InstrumentTiming) EndSuccess - ¶ - - -
-func (c *InstrumentTiming) EndSuccess()
- - - - - - -func (*InstrumentTiming) EndTiming - ¶ - - -
-func (c *InstrumentTiming) EndTiming(err error)
- - - - - - - - -type RestOperations - ¶ - - -
--RestOperations helper class for REST operations -
- -type RestOperations struct { - Logger *clog.CompositeLogger - Counters *ccount.CompositeCounters - DependencyResolver *crefer.DependencyResolver -} -- - - - - - - - - - - -func NewRestOperations - ¶ - - -
-func NewRestOperations() *RestOperations
--NewRestOperations creates new instance of RestOperations -
- - - - - - - -func (*RestOperations) Configure - ¶ - - -
-func (c *RestOperations) Configure(config *cconf.ConfigParams)
--Configure method are configures this RestOperations using the given configuration parameters. -Parameters: -
-- config *cconf.ConfigParams confif parameters -
- - - - - - -func (*RestOperations) DecodeBody - ¶ - - -
-func (c *RestOperations) DecodeBody(req *http.Request, target interface{}) error
--DecodeBody methods helps decode body -
-- req - incoming request -- target - pointer on target variable for decode -
--Returns error -
- - - - - - -func (*RestOperations) GetCorrelationId - ¶ - - -
-func (c *RestOperations) GetCorrelationId(req *http.Request) string
--GetCorrelationId method returns CorrelationId from request -Parameters: -
-req *http.Request request -
--Returns: string -retrun correlation_id or empty string -
- - - - - - -func (*RestOperations) GetFilterParams - ¶ - - -
-func (c *RestOperations) GetFilterParams(req *http.Request) *cdata.FilterParams
--GetFilterParams method retruns filter params object from request -Parameters: -
-req *http.Request request -
--Returns: *cdata.FilterParams -filter params object -
- - - - - - -func (*RestOperations) GetPagingParams - ¶ - - -
-func (c *RestOperations) GetPagingParams(req *http.Request) *cdata.PagingParams
--GetPagingParams method retruns paging params object from request -Parameters: -
-req *http.Request request -
--Returns: *cdata.PagingParams -pagings params object -
- - - - - - -func (*RestOperations) GetParam - ¶ - - -
-func (c *RestOperations) GetParam(req *http.Request, name string) string
--GetParam methods helps get all params from query -
-- req - incoming request -- name - parameter name -
--Returns value or empty string if param not exists -
- - - - - - -func (*RestOperations) SendBadRequest - ¶ - - -
-func (c *RestOperations) SendBadRequest(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SendConflict - ¶ - - -
-func (c *RestOperations) SendConflict(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SendCreatedResult - ¶ - - -
-func (c *RestOperations) SendCreatedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
- - - - - - -func (*RestOperations) SendDeletedResult - ¶ - - -
-func (c *RestOperations) SendDeletedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
- - - - - - -func (*RestOperations) SendEmptyResult - ¶ - - -
-func (c *RestOperations) SendEmptyResult(res http.ResponseWriter, req *http.Request, err error)
- - - - - - -func (*RestOperations) SendError - ¶ - - -
-func (c *RestOperations) SendError(res http.ResponseWriter, req *http.Request, err error)
- - - - - - -func (*RestOperations) SendInternalError - ¶ - - -
-func (c *RestOperations) SendInternalError(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SendNotFound - ¶ - - -
-func (c *RestOperations) SendNotFound(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SendResult - ¶ - - -
-func (c *RestOperations) SendResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
- - - - - - -func (*RestOperations) SendServerUnavailable - ¶ - - -
-func (c *RestOperations) SendServerUnavailable(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SendSessionExpired - ¶ - - -
-func (c *RestOperations) SendSessionExpired(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SendUnauthorized - ¶ - - -
-func (c *RestOperations) SendUnauthorized(res http.ResponseWriter, req *http.Request, message string)
- - - - - - -func (*RestOperations) SetReferences - ¶ - - -
-func (c *RestOperations) SetReferences(references crefer.IReferences)
--SetReferences method are sets references to this RestOperations logger, counters, and connection resolver. -Parameters: -
-- references an IReferences object, containing references to a logger, counters, -and a dependency resolver. -
- - - - - - - - -type RestService - ¶ - - -
--RestService Abstract service that receives remove calls via HTTP/REST protocol. -
--Configuration parameters: -
-- base_route: base route for remote URI -- dependencies: - - endpoint: override for HTTP Endpoint dependency - - controller: override for Controller dependency -- connection(s): - - discovery_key: (optional) a key to retrieve the connection from IDiscovery - - protocol: connection protocol: http or https - - host: host name or IP address - - port: port number - - uri: resource URI or connection string with all parameters in it -- credential - the HTTPS credentials: - - ssl_key_file: the SSL private key in PEM - - ssl_crt_file: the SSL certificate in PEM - - ssl_ca_file: the certificate authorities (root cerfiticates) in PEM -
--References: -
--- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection -- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference -
-See RestClient
--Example: -
-type MyRestService struct { - *RestService - controller IMyController - } - - ... - func NewMyRestService() *MyRestService { - c := MyRestService{} - c.RestService = services.NewRestService() - c.RestService.IRegisterable = &c - c.numberOfCalls = 0 - c.DependencyResolver.Put("controller", crefer.NewDescriptor("mygroup", "controller", "*", "*", "1.0")) - return &c - } - - func (c * MyRestService) SetReferences(references IReferences) { - c.RestService.SetReferences(references); - resolv := c.DependencyResolver.GetRequired("controller"); - if resolv != nil { - c.controller, _ = resolv.(IMyController) - } - } - - func (c *MyRestService) getOneById(res http.ResponseWriter, req *http.Request) { - params := req.URL.Query() - vars := mux.Vars(req) - - mydataId := params.Get("mydata_id") - if mydataId == "" { - mydataId = vars["mydatay_id"] - } - result, err := c.controller.GetOneById( - params.Get("correlation_id"), - mydataId) - c.SendResult(res, req, result, err) - - } - func (c * MyRestService) Register() { - - c.RegisterRoute( - "get", "get_mydata/{mydata_id}", - &cvalid.NewObjectSchema(). - WithRequiredProperty("mydata_id", cconv.String).Schema, - c.getOneById) - ... - } - - service := NewMyRestService(); - service.Configure(cconf.NewConfigParamsFromTuples( - "connection.protocol", "http", - "connection.host", "localhost", - "connection.port", 8080, - )); - service.SetReferences(cref.NewReferencesFromTuples( - cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller - )); - - opnRes := service.Open("123") - if opnErr == nil { - fmt.Println("The REST service is running on port 8080"); - } -- -type RestService struct { - Overrides IRestServiceOverrides - - //The base route. - BaseRoute string - //The HTTP endpoint that exposes this service. - Endpoint *HttpEndpoint - //The dependency resolver. - DependencyResolver *crefer.DependencyResolver - //The logger. - Logger *clog.CompositeLogger - //The performance counters. - Counters *ccount.CompositeCounters - // The tracer. - Tracer *ctrace.CompositeTracer - - SwaggerService ISwaggerService - SwaggerEnabled bool - SwaggerRoute string - // contains filtered or unexported fields -} -- - - - - - - - - - - -func InheritRestService - ¶ - - -
-func InheritRestService(overrides IRestServiceOverrides) *RestService
--InheritRestService is create new instance of RestService -
- - - - - - - -func (*RestService) Close - ¶ - - -
-func (c *RestService) Close(correlationId string) error
--Close method are closes component and frees used resources. -Parameters: -
-- correlationId (optional) transaction id to trace execution through call chain. -
--Returns: error -error or nil no errors occured. -
- - - - - - -func (*RestService) Configure - ¶ - - -
-func (c *RestService) Configure(config *cconf.ConfigParams)
--Configure method are configures component by passing configuration parameters. -Parameters: -
-- config *cconf.ConfigParams configuration parameters to be set. -
- - - - - - -func (*RestService) DecodeBody - ¶ - - -
-func (c *RestService) DecodeBody(req *http.Request, target interface{}) error
--DecodeBody methods helps decode body -
-- req - incoming request -- target - pointer on target variable for decode -
--Returns error -
- - - - - - -func (*RestService) GetCorrelationId - ¶ - - -
-func (c *RestService) GetCorrelationId(req *http.Request) string
--GetCorrelationId method returns CorrelationId from request -Parameters: -
-req *http.Request request -
--Returns: string -retrun correlation_id or empty string -
- - - - - - -func (*RestService) GetFilterParams - ¶ - - -
-func (c *RestService) GetFilterParams(req *http.Request) *cdata.FilterParams
--GetFilterParams methods helps decode filter params -
-- req - incoming request -
--Returns filter params -
- - - - - - -func (*RestService) GetPagingParams - ¶ - - -
-func (c *RestService) GetPagingParams(req *http.Request) *cdata.PagingParams
--GetPagingParams methods helps decode paging params -
-- req - incoming request -
--Returns paging params -
- - - - - - -func (*RestService) GetParam - ¶ - - -
-func (c *RestService) GetParam(req *http.Request, name string) string
--GetParam methods helps get all params from query -
-- req - incoming request -- name - parameter name -
--Returns value or empty string if param not exists -
- - - - - - -func (*RestService) Instrument - ¶ - - -
-func (c *RestService) Instrument(correlationId string, name string) *InstrumentTiming
--Instrument method are adds instrumentation to log calls and measure call time. -It returns a Timing object that is used to end the time measurement. -Parameters: -
-- correlationId (optional) transaction id to trace execution through call chain. -- name a method name. -
--Returns Timing object to end the time measurement. -
- - - - - - -func (*RestService) InstrumentError - ¶ - - -
-func (c *RestService) InstrumentError(correlationId string, name string, errIn error, - resIn interface{}) (result interface{}, err error)
--InstrumentError method are adds instrumentation to error handling. -Parameters: -
-- correlationId string (optional) transaction id to trace execution through call chain. -- name string a method name. -- err error an occured error -- result interface{} (optional) an execution result ---Returns: result interface{}, err error -
-(optional) an execution callback -
- - - - - - -func (*RestService) IsOpen - ¶ - - -
-func (c *RestService) IsOpen() bool
--IsOpen method checks if the component is opened. -Returrns true if the component has been opened and false otherwise. -
- - - - - - -func (*RestService) Open - ¶ - - -
-func (c *RestService) Open(correlationId string) error
--Open method are opens the component. -Parameters: -
-- correlationId string: (optional) transaction id to trace execution through call chain. - Returns: error -
--error or nil no errors occured. -
- - - - - - -func (*RestService) Register - ¶ - - -
-func (c *RestService) Register()
--Register method are registers all service routes in HTTP endpoint. -
- - - - - - -func (*RestService) RegisterInterceptor - ¶ - - -
-func (c *RestService) RegisterInterceptor(route string, - action func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc))
--RegisterInterceptor method are registers a middleware for a given route in HTTP endpoint. -Parameters: -
-- route a command route. Base route will be added to this route -- action an action function that is called when middleware is invoked. -
- - - - - - -func (*RestService) RegisterOpenApiSpec - ¶ - - -
-func (c *RestService) RegisterOpenApiSpec(content string)
- - - - - - -func (*RestService) RegisterOpenApiSpecFromFile - ¶ - - -
-func (c *RestService) RegisterOpenApiSpecFromFile(path string)
- - - - - - -func (*RestService) RegisterRoute - ¶ - - -
-func (c *RestService) RegisterRoute(method string, route string, schema *cvalid.Schema, - action func(res http.ResponseWriter, req *http.Request))
--RegisterRoute method are registers a route in HTTP endpoint. -Parameters: -
-- method HTTP method: "get", "head", "post", "put", "delete" -- route a command route. Base route will be added to this route -- schema a validation schema to validate received parameters. -- action an action function that is called when operation is invoked. -
- - - - - - -func (*RestService) RegisterRouteWithAuth - ¶ - - -
-func (c *RestService) RegisterRouteWithAuth(method string, route string, schema *cvalid.Schema, - authorize func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc), - action func(res http.ResponseWriter, req *http.Request))
--RegisterRouteWithAuth method are registers a route with authorization in HTTP endpoint. -Parameters: -
-- method HTTP method: "get", "head", "post", "put", "delete" -- route a command route. Base route will be added to this route -- schema a validation schema to validate received parameters. -- authorize an authorization interceptor -- action an action function that is called when operation is invoked. -
- - - - - - -func (*RestService) SendCreatedResult - ¶ - - -
-func (c *RestService) SendCreatedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
--SendCreatedResult method are sends newly created object as JSON. -That callack function call be called directly or passed -as a parameter to business logic components. -If object is not nil it returns 201 status code. -For nil results it returns 204 status code. -If error occur it sends ErrorDescription with approproate status code. -Parameters: -
-- req a HTTP request object. -- res a HTTP response object. -- result (optional) result object to send -- err error (optional) error objrct to send -
- - - - - - -func (*RestService) SendDeletedResult - ¶ - - -
-func (c *RestService) SendDeletedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
--SendDeletedResult method are sends deleted object as JSON. -That callack function call be called directly or passed -as a parameter to business logic components. -If object is not nil it returns 200 status code. -For nil results it returns 204 status code. -If error occur it sends ErrorDescription with approproate status code. -Parameters: -
-- req a HTTP request object. - - res a HTTP response object. - - result (optional) result object to send - - err error (optional) error objrct to send -
- - - - - - -func (*RestService) SendError - ¶ - - -
-func (c *RestService) SendError(res http.ResponseWriter, req *http.Request, err error)
--SendError method are sends error serialized as ErrorDescription object -and appropriate HTTP status code. -If status code is not defined, it uses 500 status code. -Parameters: -
-- req a HTTP request object. -- res a HTTP response object. -- error an error object to be sent. -
- - - - - - -func (*RestService) SendResult - ¶ - - -
-func (c *RestService) SendResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
--SendResult method method are sends result as JSON object. -That function call be called directly or passed -as a parameter to business logic components. -If object is not nil it returns 200 status code. -For nil results it returns 204 status code. -If error occur it sends ErrorDescription with approproate status code. -Parameters: -
-- req a HTTP request object. -- res a HTTP response object. -- result (optional) result object to send -- err error (optional) error objrct to send -
- - - - - - -func (*RestService) SetReferences - ¶ - - -
-func (c *RestService) SetReferences(references crefer.IReferences)
--SetReferences method are sets references to dependent components. -Parameters: -
-- references crefer.IReferences references to locate the component dependencies. -
- - - - - - -func (*RestService) UnsetReferences - ¶ - - -
-func (c *RestService) UnsetReferences()
--UnsetReferences method are unsets (clears) previously set references to dependent components. -
- - - - - - - - -type StatusOperations - ¶ - - -
--StatusOperations helper class for status service -
- -type StatusOperations struct { - RestOperations - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewStatusOperations - ¶ - - -
-func NewStatusOperations() *StatusOperations
--NewStatusOperations creates new instance of StatusOperations -
- - - - - - - -func (*StatusOperations) GetStatusOperation - ¶ - - -
-func (c *StatusOperations) GetStatusOperation() func(res http.ResponseWriter, req *http.Request)
--GetStatusOperation return function for get status -
- - - - - - -func (*StatusOperations) SetReferences - ¶ - - -
-func (c *StatusOperations) SetReferences(references crefer.IReferences)
--SetReferences sets references to dependent components. -
-- references crefer.IReferences references to locate the component dependencies. -
- - - - - - -func (*StatusOperations) Status - ¶ - - -
-func (c *StatusOperations) Status(res http.ResponseWriter, req *http.Request)
--Status method handles status requests -
-- req *http.Request an HTTP request -- res http.ResponseWriter an HTTP response -
- - - - - - - - -type StatusRestService - ¶ - - -
--StatusRestService is a service that returns microservice status information via HTTP/REST protocol. -
--The service responds on /status route (can be changed) with a JSON object: -
-{ - - "id": unique container id (usually hostname) - - "name": container name (from ContextInfo) - - "description": container description (from ContextInfo) - - "start_time": time when container was started - - "current_time": current time in UTC - - "uptime": duration since container start time in milliseconds - - "properties": additional container properties (from ContextInfo) - - "components": descriptors of components registered in the container -} ---Configuration parameters: -
-- baseroute: base route for remote URI -- route: status route (default: "status") -- dependencies: - - endpoint: override for HTTP Endpoint dependency - - controller: override for Controller dependency -- connection(s): - - discovery_key: (optional) a key to retrieve the connection from IDiscovery - - protocol: connection protocol: http or https - - host: host name or IP address - - port: port number - - uri: resource URI or connection string with all parameters in it -
--References: -
--- *:logger:*:*:1.0 (optional) ILogger components to pass log messages -- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements -- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection -- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference -
--See: RestService -See: RestClient -
--Example: -
-service = NewStatusService(); - service.Configure(cref.NewConfigParamsFromTuples( - "connection.protocol", "http", - "connection.host", "localhost", - "connection.port", 8080, - )); - - opnErr:= service.Open("123") - if opnErr == nil { - fmt.Println("The Status service is accessible at http://localhost:8080/status"); - } -- -type StatusRestService struct { - *RestService - // contains filtered or unexported fields -} -- - - - - - - - - - - -func NewStatusRestService - ¶ - - -
-func NewStatusRestService() *StatusRestService
--NewStatusRestService method are creates a new instance of this service. -
- - - - - - - -func (*StatusRestService) Configure - ¶ - - -
-func (c *StatusRestService) Configure(config *cconf.ConfigParams)
--Configure method are configures component by passing configuration parameters. -Parameters: -
-- config *cconf.ConfigParams configuration parameters to be set. -
- - - - - - -func (*StatusRestService) Register - ¶ - - -
-func (c *StatusRestService) Register()
--Register method are registers all service routes in HTTP endpoint. -
- - - - - - -func (*StatusRestService) SetReferences - ¶ - - -
-func (c *StatusRestService) SetReferences(references crefer.IReferences)
--SetReferences method are sets references to dependent components. -Parameters: -
-- references crefer.IReferences references to locate the component dependencies. -
- - - - - - - - -type THttpRequestDetector - ¶ - - -
- -type THttpRequestDetector struct { -} -- - - - - - - - - - - - - -func (*THttpRequestDetector) DetectAddress - ¶ - - -
-func (c *THttpRequestDetector) DetectAddress(req *http.Request) string
--DetectAddress method are detects the IP address from which the given HTTP request was received. -
-- req *http.Reques an HTTP request to process. -Returns the detected IP address (without a port). If no IP is detected - -
--nil will be returned. -
- - - - - - -func (*THttpRequestDetector) DetectBrowser - ¶ - - -
-func (c *THttpRequestDetector) DetectBrowser(req *http.Request) string
--Detects the browser (using "user-agent") from which the given HTTP request was made. -
-- req *http.Reques an HTTP request to process. -Returns the detected browser. Detectable browsers: "chrome", "msie", "firefox", -
--"safari". Otherwise - "unknown" will be returned. -
- - - - - - -func (*THttpRequestDetector) DetectPlatform - ¶ - - -
-func (c *THttpRequestDetector) DetectPlatform(req *http.Request) string
--DetectPlatform method are detects the platform (using "user-agent") from which the given HTTP request was made. -
-- req *http.Request an HTTP request to process. -Returns the detected platform and version. Detectable platforms: "mobile", "iphone", -"ipad", "macosx", "android", "webos", "mac", "windows". Otherwise - "unknown" will -
--be returned. -
- - - - - - -func (*THttpRequestDetector) DetectServerHost - ¶ - - -
-func (c *THttpRequestDetector) DetectServerHost(req *http.Request) string
--DetectServerHost method are detects the host name of the request"s destination server. -
-- req *http.Request an HTTP request to process. -Returns the destination server"s host name. -
- - - - - - -func (*THttpRequestDetector) DetectServerPort - ¶ - - -
-func (c *THttpRequestDetector) DetectServerPort(req *http.Request) string
--DetectServerPort method are detects the request"s destination port number. -
-- req *http.Request an HTTP request to process. -Returns the detected port number or <code>80</code> (if none are detected). -
- - - - - - - - -type THttpResponseSender - ¶ - - -
- -type THttpResponseSender struct { -} -- - - - - -var HttpResponseSender THttpResponseSender = THttpResponseSender{}
- - - - - - - - - - -func (*THttpResponseSender) SendCreatedResult - ¶ - - -
-func (c *THttpResponseSender) SendCreatedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
--SendCreatedResult are sends newly created object as JSON. -That function call be called directly or passed -as a parameter to business logic components. -If object is not nil it returns 201 status code. -For nil results it returns 204 status code. -If error occur it sends ErrorDescription with approproate status code. -Parameters: -
-- req *http.Request a HTTP request object. -- res http.ResponseWriter a HTTP response object. -
- - - - - - -func (*THttpResponseSender) SendDeletedResult - ¶ - - -
-func (c *THttpResponseSender) SendDeletedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
--SendDeletedResult are sends deleted object as JSON. -That function call be called directly or passed -as a parameter to business logic components. -If object is not nil it returns 200 status code. -For nil results it returns 204 status code. -If error occur it sends ErrorDescription with approproate status code. -Parameters: -
-- req *http.Request a HTTP request object. -- res http.ResponseWriter a HTTP response object. -
- - - - - - -func (*THttpResponseSender) SendEmptyResult - ¶ - - -
-func (c *THttpResponseSender) SendEmptyResult(res http.ResponseWriter, req *http.Request, err error)
--SendEmptyResult are sends an empty result with 204 status code. -If error occur it sends ErrorDescription with approproate status code. -
-- req *http.Request a HTTP request object. -- res http.ResponseWriter a HTTP response object. -
- - - - - - -func (*THttpResponseSender) SendError - ¶ - - -
-func (c *THttpResponseSender) SendError(res http.ResponseWriter, req *http.Request, err error)
--SendError sends error serialized as ErrorDescription object -and appropriate HTTP status code. -If status code is not defined, it uses 500 status code. -Parameters: -
-- req *http.Request a HTTP request object. -- res http.ResponseWriter a HTTP response object. -- err error an error object to be sent. -
- - - - - - -func (*THttpResponseSender) SendResult - ¶ - - -
-func (c *THttpResponseSender) SendResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
--SendResult sends result as JSON object. -That function call be called directly or passed -as a parameter to business logic components. -If object is not nil it returns 200 status code. -For nil results it returns 204 status code. -If error occur it sends ErrorDescription with approproate status code. -Parameters: -
-- req *http.Request a HTTP request object. -- res http.ResponseWriter a HTTP response object. -- result interface{} result object to be send -- err error an error object to be sent. -- - - - - - - - - - - - - - - - - - -services - Go Documentation Server + + + + + + + + + + + + + ++... ++ ++ + + +++ + diff --git a/go.mod b/go.mod index 983679c..c066f94 100644 --- a/go.mod +++ b/go.mod @@ -1,11 +1,11 @@ -module github.com/pip-services3-go/pip-services3-rpc-go - -go 1.16 - -require ( - github.com/gorilla/handlers v1.5.1 - github.com/gorilla/mux v1.8.0 - github.com/pip-services3-go/pip-services3-commons-go v1.1.6 - github.com/pip-services3-go/pip-services3-components-go v1.3.2 - github.com/stretchr/testify v1.8.1 -) +module github.com/pip-services3-go/pip-services3-rpc-go + +go 1.16 + +require ( + github.com/gorilla/handlers v1.5.1 + github.com/gorilla/mux v1.8.0 + github.com/pip-services3-go/pip-services3-commons-go v1.1.6 + github.com/pip-services3-go/pip-services3-components-go v1.3.2 + github.com/stretchr/testify v1.8.1 +) diff --git a/test/services/DummyRestService.go b/test/services/DummyRestService.go index 613b14d..bc9b658 100644 --- a/test/services/DummyRestService.go +++ b/test/services/DummyRestService.go @@ -1,230 +1,230 @@ -package test_services - -import ( - "encoding/json" - "io/ioutil" - "net/http" - - "github.com/gorilla/mux" - cconf "github.com/pip-services3-go/pip-services3-commons-go/config" - cconv "github.com/pip-services3-go/pip-services3-commons-go/convert" - cdata "github.com/pip-services3-go/pip-services3-commons-go/data" - cerr "github.com/pip-services3-go/pip-services3-commons-go/errors" - crefer "github.com/pip-services3-go/pip-services3-commons-go/refer" - cvalid "github.com/pip-services3-go/pip-services3-commons-go/validate" - "github.com/pip-services3-go/pip-services3-rpc-go/services" - tdata "github.com/pip-services3-go/pip-services3-rpc-go/test/data" - tlogic "github.com/pip-services3-go/pip-services3-rpc-go/test/logic" -) - -type DummyRestService struct { - *services.RestService - controller tlogic.IDummyController - numberOfCalls int - openApiContent string - openApiFile string -} - -func NewDummyRestService() *DummyRestService { - c := &DummyRestService{} - c.RestService = services.InheritRestService(c) - c.numberOfCalls = 0 - c.DependencyResolver.Put("controller", crefer.NewDescriptor("pip-services-dummies", "controller", "default", "*", "*")) - return c -} - -func (c *DummyRestService) Configure(config *cconf.ConfigParams) { - c.openApiContent = config.GetAsString("openapi_content") - c.openApiFile = config.GetAsString("openapi_file") - c.RestService.Configure(config) -} - -func (c *DummyRestService) SetReferences(references crefer.IReferences) { - c.RestService.SetReferences(references) - depRes, depErr := c.DependencyResolver.GetOneRequired("controller") - if depErr == nil && depRes != nil { - c.controller = depRes.(tlogic.IDummyController) - } -} - -func (c *DummyRestService) GetNumberOfCalls() int { - return c.numberOfCalls -} - -func (c *DummyRestService) incrementNumberOfCalls(res http.ResponseWriter, req *http.Request, next http.HandlerFunc) { - c.numberOfCalls++ - next.ServeHTTP(res, req) -} - -func (c *DummyRestService) getPageByFilter(res http.ResponseWriter, req *http.Request) { - params := req.URL.Query() - paginParams := make(map[string]string, 0) - - paginParams["skip"] = params.Get("skip") - paginParams["take"] = params.Get("take") - paginParams["total"] = params.Get("total") - - delete(params, "skip") - delete(params, "take") - delete(params, "total") - - result, err := c.controller.GetPageByFilter( - c.GetCorrelationId(req), - cdata.NewFilterParamsFromValue(params), // W! need test - cdata.NewPagingParamsFromTuples(paginParams), - ) - c.SendResult(res, req, result, err) -} - -func (c *DummyRestService) getOneById(res http.ResponseWriter, req *http.Request) { - params := req.URL.Query() - vars := mux.Vars(req) - - dummyId := params.Get("dummy_id") - if dummyId == "" { - dummyId = vars["dummy_id"] - } - result, err := c.controller.GetOneById( - c.GetCorrelationId(req), - dummyId) - c.SendResult(res, req, result, err) -} - -func (c *DummyRestService) create(res http.ResponseWriter, req *http.Request) { - correlationId := c.GetCorrelationId(req) - var dummy tdata.Dummy - - body, bodyErr := ioutil.ReadAll(req.Body) - if bodyErr != nil { - err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(bodyErr) - c.SendError(res, req, err) - return - } - defer req.Body.Close() - jsonErr := json.Unmarshal(body, &dummy) - - if jsonErr != nil { - err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(jsonErr) - c.SendError(res, req, err) - return - } - - result, err := c.controller.Create( - correlationId, - dummy, - ) - c.SendCreatedResult(res, req, result, err) -} - -func (c *DummyRestService) update(res http.ResponseWriter, req *http.Request) { - correlationId := c.GetCorrelationId(req) - - var dummy tdata.Dummy - - body, bodyErr := ioutil.ReadAll(req.Body) - if bodyErr != nil { - err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(bodyErr) - c.SendError(res, req, err) - return - } - defer req.Body.Close() - jsonErr := json.Unmarshal(body, &dummy) - - if jsonErr != nil { - err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(jsonErr) - c.SendError(res, req, err) - return - } - result, err := c.controller.Update( - correlationId, - dummy, - ) - c.SendResult(res, req, result, err) -} - -func (c *DummyRestService) deleteById(res http.ResponseWriter, req *http.Request) { - params := req.URL.Query() - vars := mux.Vars(req) - - dummyId := params.Get("dummy_id") - if dummyId == "" { - dummyId = vars["dummy_id"] - } - - result, err := c.controller.DeleteById( - c.GetCorrelationId(req), - dummyId, - ) - c.SendDeletedResult(res, req, result, err) -} - -func (c *DummyRestService) checkCorrelationId(res http.ResponseWriter, req *http.Request) { - result, err := c.controller.CheckCorrelationId(c.GetCorrelationId(req)) - c.SendResult(res, req, result, err) -} - -func (c *DummyRestService) checkErrorPropagation(res http.ResponseWriter, req *http.Request) { - err := c.controller.CheckErrorPropagation(c.GetCorrelationId(req)) - c.SendError(res, req, err) -} - -func (c *DummyRestService) Register() { - c.RegisterInterceptor("/dummies$", c.incrementNumberOfCalls) - - c.RegisterRoute( - "get", "/dummies", - &cvalid.NewObjectSchema().WithOptionalProperty("skip", cconv.String). - WithOptionalProperty("take", cconv.String). - WithOptionalProperty("total", cconv.String). - WithOptionalProperty("body", cvalid.NewFilterParamsSchema()).Schema, - c.getPageByFilter, - ) - - c.RegisterRoute( - "get", "/dummies/check/correlation_id", - &cvalid.NewObjectSchema().Schema, - c.checkCorrelationId, - ) - - c.RegisterRoute( - "get", "/dummies/check/error_propagation", - &cvalid.NewObjectSchema().Schema, - c.checkErrorPropagation, - ) - - c.RegisterRoute( - "get", "/dummies/{dummy_id}", - &cvalid.NewObjectSchema(). - WithRequiredProperty("dummy_id", cconv.String).Schema, - c.getOneById, - ) - - c.RegisterRoute( - "post", "/dummies", - &cvalid.NewObjectSchema(). - WithRequiredProperty("body", tdata.NewDummySchema()).Schema, - c.create, - ) - - c.RegisterRoute( - "put", "/dummies", - &cvalid.NewObjectSchema(). - WithRequiredProperty("body", tdata.NewDummySchema()).Schema, - c.update, - ) - - c.RegisterRoute( - "delete", "/dummies/{dummy_id}", - &cvalid.NewObjectSchema(). - WithRequiredProperty("dummy_id", cconv.String).Schema, - c.deleteById, - ) - - if c.openApiContent != "" { - c.RegisterOpenApiSpec(c.openApiContent) - } - - if c.openApiFile != "" { - c.RegisterOpenApiSpecFromFile(c.openApiFile) - } -} +package test_services + +import ( + "encoding/json" + "io/ioutil" + "net/http" + + "github.com/gorilla/mux" + cconf "github.com/pip-services3-go/pip-services3-commons-go/config" + cconv "github.com/pip-services3-go/pip-services3-commons-go/convert" + cdata "github.com/pip-services3-go/pip-services3-commons-go/data" + cerr "github.com/pip-services3-go/pip-services3-commons-go/errors" + crefer "github.com/pip-services3-go/pip-services3-commons-go/refer" + cvalid "github.com/pip-services3-go/pip-services3-commons-go/validate" + "github.com/pip-services3-go/pip-services3-rpc-go/services" + tdata "github.com/pip-services3-go/pip-services3-rpc-go/test/data" + tlogic "github.com/pip-services3-go/pip-services3-rpc-go/test/logic" +) + +type DummyRestService struct { + *services.RestService + controller tlogic.IDummyController + numberOfCalls int + openApiContent string + openApiFile string +} + +func NewDummyRestService() *DummyRestService { + c := &DummyRestService{} + c.RestService = services.InheritRestService(c) + c.numberOfCalls = 0 + c.DependencyResolver.Put("controller", crefer.NewDescriptor("pip-services-dummies", "controller", "default", "*", "*")) + return c +} + +func (c *DummyRestService) Configure(config *cconf.ConfigParams) { + c.openApiContent = config.GetAsString("openapi_content") + c.openApiFile = config.GetAsString("openapi_file") + c.RestService.Configure(config) +} + +func (c *DummyRestService) SetReferences(references crefer.IReferences) { + c.RestService.SetReferences(references) + depRes, depErr := c.DependencyResolver.GetOneRequired("controller") + if depErr == nil && depRes != nil { + c.controller = depRes.(tlogic.IDummyController) + } +} + +func (c *DummyRestService) GetNumberOfCalls() int { + return c.numberOfCalls +} + +func (c *DummyRestService) incrementNumberOfCalls(res http.ResponseWriter, req *http.Request, next http.HandlerFunc) { + c.numberOfCalls++ + next.ServeHTTP(res, req) +} + +func (c *DummyRestService) getPageByFilter(res http.ResponseWriter, req *http.Request) { + params := req.URL.Query() + paginParams := make(map[string]string, 0) + + paginParams["skip"] = params.Get("skip") + paginParams["take"] = params.Get("take") + paginParams["total"] = params.Get("total") + + delete(params, "skip") + delete(params, "take") + delete(params, "total") + + result, err := c.controller.GetPageByFilter( + c.GetCorrelationId(req), + cdata.NewFilterParamsFromValue(params), // W! need test + cdata.NewPagingParamsFromTuples(paginParams), + ) + c.SendResult(res, req, result, err) +} + +func (c *DummyRestService) getOneById(res http.ResponseWriter, req *http.Request) { + params := req.URL.Query() + vars := mux.Vars(req) + + dummyId := params.Get("dummy_id") + if dummyId == "" { + dummyId = vars["dummy_id"] + } + result, err := c.controller.GetOneById( + c.GetCorrelationId(req), + dummyId) + c.SendResult(res, req, result, err) +} + +func (c *DummyRestService) create(res http.ResponseWriter, req *http.Request) { + correlationId := c.GetCorrelationId(req) + var dummy tdata.Dummy + + body, bodyErr := ioutil.ReadAll(req.Body) + if bodyErr != nil { + err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(bodyErr) + c.SendError(res, req, err) + return + } + defer req.Body.Close() + jsonErr := json.Unmarshal(body, &dummy) + + if jsonErr != nil { + err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(jsonErr) + c.SendError(res, req, err) + return + } + + result, err := c.controller.Create( + correlationId, + dummy, + ) + c.SendCreatedResult(res, req, result, err) +} + +func (c *DummyRestService) update(res http.ResponseWriter, req *http.Request) { + correlationId := c.GetCorrelationId(req) + + var dummy tdata.Dummy + + body, bodyErr := ioutil.ReadAll(req.Body) + if bodyErr != nil { + err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(bodyErr) + c.SendError(res, req, err) + return + } + defer req.Body.Close() + jsonErr := json.Unmarshal(body, &dummy) + + if jsonErr != nil { + err := cerr.NewInternalError(correlationId, "JSON_CNV_ERR", "Cant convert from JSON to Dummy").WithCause(jsonErr) + c.SendError(res, req, err) + return + } + result, err := c.controller.Update( + correlationId, + dummy, + ) + c.SendResult(res, req, result, err) +} + +func (c *DummyRestService) deleteById(res http.ResponseWriter, req *http.Request) { + params := req.URL.Query() + vars := mux.Vars(req) + + dummyId := params.Get("dummy_id") + if dummyId == "" { + dummyId = vars["dummy_id"] + } + + result, err := c.controller.DeleteById( + c.GetCorrelationId(req), + dummyId, + ) + c.SendDeletedResult(res, req, result, err) +} + +func (c *DummyRestService) checkCorrelationId(res http.ResponseWriter, req *http.Request) { + result, err := c.controller.CheckCorrelationId(c.GetCorrelationId(req)) + c.SendResult(res, req, result, err) +} + +func (c *DummyRestService) checkErrorPropagation(res http.ResponseWriter, req *http.Request) { + err := c.controller.CheckErrorPropagation(c.GetCorrelationId(req)) + c.SendError(res, req, err) +} + +func (c *DummyRestService) Register() { + c.RegisterInterceptor("/dummies$", c.incrementNumberOfCalls) + + c.RegisterRoute( + "get", "/dummies", + &cvalid.NewObjectSchema().WithOptionalProperty("skip", cconv.String). + WithOptionalProperty("take", cconv.String). + WithOptionalProperty("total", cconv.String). + WithOptionalProperty("body", cvalid.NewFilterParamsSchema()).Schema, + c.getPageByFilter, + ) + + c.RegisterRoute( + "get", "/dummies/check/correlation_id", + &cvalid.NewObjectSchema().Schema, + c.checkCorrelationId, + ) + + c.RegisterRoute( + "get", "/dummies/check/error_propagation", + &cvalid.NewObjectSchema().Schema, + c.checkErrorPropagation, + ) + + c.RegisterRoute( + "get", "/dummies/{dummy_id}", + &cvalid.NewObjectSchema(). + WithRequiredProperty("dummy_id", cconv.String).Schema, + c.getOneById, + ) + + c.RegisterRoute( + "post", "/dummies", + &cvalid.NewObjectSchema(). + WithRequiredProperty("body", tdata.NewDummySchema()).Schema, + c.create, + ) + + c.RegisterRoute( + "put", "/dummies", + &cvalid.NewObjectSchema(). + WithRequiredProperty("body", tdata.NewDummySchema()).Schema, + c.update, + ) + + c.RegisterRoute( + "delete", "/dummies/{dummy_id}", + &cvalid.NewObjectSchema(). + WithRequiredProperty("dummy_id", cconv.String).Schema, + c.deleteById, + ) + + if c.openApiContent != "" { + c.RegisterOpenApiSpec(c.openApiContent) + } + + if c.openApiFile != "" { + c.RegisterOpenApiSpecFromFile(c.openApiFile) + } +}+ + +++ Package services + +
+ + + + + + + + + + + + + + + + + + + +++ +++ +Overview ▹
+++ + + + + +++ +Index ▹
+Variables
+ ++HttpRequestDetector рelper class that retrieves parameters from HTTP requests. +
+ +var HttpRequestDetector = THttpRequestDetector{}
+ + + + + + +type AboutOperations + ¶ + + +
+ +type AboutOperations struct { + RestOperations + // contains filtered or unexported fields +} ++ + + + + + + + + + + + + +func (*AboutOperations) About + ¶ + + +
+func (c *AboutOperations) About(res http.ResponseWriter, req *http.Request)
+ + + + + + +func (*AboutOperations) GetAboutOperation + ¶ + + +
+func (c *AboutOperations) GetAboutOperation() func(res http.ResponseWriter, req *http.Request)
+ + + + + + +func (*AboutOperations) GetNetworkAddresses + ¶ + + +
+func (c *AboutOperations) GetNetworkAddresses() []string
+ + + + + + +func (*AboutOperations) SetReferences + ¶ + + +
+func (c *AboutOperations) SetReferences(references crefer.IReferences)
+ + + + + + + + +type CommandableHttpService + ¶ + + +
++CommandableHttpService abstract service that receives remove calls via HTTP/REST protocol +to operations automatically generated for commands defined in ICommandable components. +Each command is exposed as POST operation that receives all parameters in body object. +
++Commandable services require only 3 lines of code to implement a robust external +HTTP-based remote interface. +
++Configuration parameters: +
+- base_route: base route for remote URI +- dependencies: + - endpoint: override for HTTP Endpoint dependency + - controller: override for Controller dependency +- connection(s): + - discovery_key: (optional) a key to retrieve the connection from IDiscovery + - protocol: connection protocol: http or https + - host: host name or IP address + - port: port number + - uri: resource URI or connection string with all parameters in it +
++References: +
++- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection +- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference +
++See CommandableHttpClient +See RestService +
++Example: +
+type MyCommandableHttpService struct { + *CommandableHttpService + } + + func NewMyCommandableHttpService() *MyCommandableHttpService { + c := MyCommandableHttpService{ + CommandableHttpService: services.NewCommandableHttpService("dummies"), + } + c.DependencyResolver.Put("controller", cref.NewDescriptor("pip-services-dummies", "controller", "default", "*", "*")) + return &c + + service := NewMyCommandableHttpService(); + service.Configure(cconf.NewConfigParamsFromTuples( + "connection.protocol", "http", + "connection.host", "localhost", + "connection.port", 8080, + )); + service.SetReferences(cref.NewReferencesFromTuples( + cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller + )); + + opnErr:=service.Open("123") + if opnErr == nil { + fmt.Println("The REST service is running on port 8080"); + } ++ +type CommandableHttpService struct { + *RestService + + SwaggerAuto bool + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func InheritCommandableHttpService + ¶ + + +
+func InheritCommandableHttpService(overrides IRestServiceOverrides, baseRoute string) *CommandableHttpService
++InheritCommandableHttpService creates a new instance of the service. +Parameters: +
+- overrides references to child class that overrides virtual methods +- baseRoute string a service base route. +
++Returns: *CommandableHttpService +pointer on new instance CommandableHttpService +
+ + + + + + + +func (*CommandableHttpService) Configure + ¶ + + +
+func (c *CommandableHttpService) Configure(config *cconf.ConfigParams)
++Configure method configures component by passing configuration parameters. +
+- config configuration parameters to be set. +
+ + + + + + +func (*CommandableHttpService) Register + ¶ + + +
+func (c *CommandableHttpService) Register()
++Register method are registers all service routes in HTTP endpoint. +
+ + + + + + + + +type CommandableSwaggerDocument + ¶ + + +
+ +type CommandableSwaggerDocument struct { + Commands []ccomands.ICommand + + Version string + BaseRoute string + + InfoTitle string + InfoDescription string + InfoVersion string + InfoTermsOfService string + + InfoContactName string + InfoContactUrl string + InfoContactEmail string + + InfoLicenseName string + InfoLicenseUrl string + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewCommandableSwaggerDocument + ¶ + + +
+func NewCommandableSwaggerDocument(baseRoute string, config *cconf.ConfigParams, commands []ccomands.ICommand) *CommandableSwaggerDocument
+ + + + + + + +func (*CommandableSwaggerDocument) GetSpaces + ¶ + + +
+func (c *CommandableSwaggerDocument) GetSpaces(length int) string
+ + + + + + +func (*CommandableSwaggerDocument) ToString + ¶ + + +
+func (c *CommandableSwaggerDocument) ToString() string
+ + + + + + +func (*CommandableSwaggerDocument) WriteData + ¶ + + +
+func (c *CommandableSwaggerDocument) WriteData(indent int, data map[string]interface{})
+ + + + + + +func (*CommandableSwaggerDocument) WriteName + ¶ + + +
+func (c *CommandableSwaggerDocument) WriteName(indent int, name string)
+ + + + + + + + +type HeartbeatOperations + ¶ + + +
+ +type HeartbeatOperations struct { + RestOperations +} ++ + + + + + + + + + + +func NewHeartbeatOperations + ¶ + + +
+func NewHeartbeatOperations() *HeartbeatOperations
++NewHeartbeatOperations creates new instance HeartbeatOperations +Returns: *HeartbeatOperations +
+ + + + + + + +func (*HeartbeatOperations) GetHeartbeatOperation + ¶ + + +
+func (c *HeartbeatOperations) GetHeartbeatOperation() func(res http.ResponseWriter, req *http.Request)
++Heartbeat method are insert timestamp into HTTP result +
+ + + + + + +func (*HeartbeatOperations) Heartbeat + ¶ + + +
+func (c *HeartbeatOperations) Heartbeat(res http.ResponseWriter, req *http.Request)
++Heartbeat method are insert timestamp into HTTP result +
+ + + + + + + + +type HeartbeatRestService + ¶ + + +
++HeartbeatRestService service returns heartbeat via HTTP/REST protocol. +
++The service responds on /heartbeat route (can be changed) +with a string with the current time in UTC. +
++This service route can be used to health checks by loadbalancers and +container orchestrators. +
++Configuration parameters: +
+- baseroute: base route for remote URI (default: "") +- route: route to heartbeat operation (default: "heartbeat") +- dependencies: + - endpoint: override for HTTP Endpoint dependency +- connection(s): + - discovery_key: (optional) a key to retrieve the connection from IDiscovery + - protocol: connection protocol: http or https + - host: host name or IP address + - port: port number + - uri: resource URI or connection string with all parameters in it +
++References: +
++- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection +- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference +
++See RestService +See RestClient +
++Example: +
+service := NewHeartbeatService(); +service.Configure(cconf.NewConfigParamsFromTuples( + "route", "ping", + "connection.protocol", "http", + "connection.host", "localhost", + "connection.port", 8080, +)); + +opnErr := service.Open("123") +if opnErr == nil { + fmt.Println("The Heartbeat service is accessible at http://+:8080/ping"); +} ++ +type HeartbeatRestService struct { + *RestService + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewHeartbeatRestService + ¶ + + +
+func NewHeartbeatRestService() *HeartbeatRestService
++* +
+Creates a new instance of c service. +
+ + + + + + + +func (*HeartbeatRestService) Configure + ¶ + + +
+func (c *HeartbeatRestService) Configure(config *cconf.ConfigParams)
++* +
+Configures component by passing configuration parameters. + +@param config configuration parameters to be set. +
+ + + + + + +func (*HeartbeatRestService) Register + ¶ + + +
+func (c *HeartbeatRestService) Register()
++* +
+Registers all service routes in HTTP endpoint. +
+ + + + + + + + +type HttpEndpoint + ¶ + + +
+HttpEndpoint used for creating HTTP endpoints. An endpoint is a URL, at which a given service can be accessed by a client. +
++Configuration parameters: +
++Parameters to pass to the configure method for component configuration: +
+- cors_headers - a comma-separated list of allowed CORS headers +- cors_origins - a comma-separated list of allowed CORS origins +- connection(s) - the connection resolver"s connections: + - "connection.discovery_key" - the key to use for connection resolving in a discovery service; + - "connection.protocol" - the connection"s protocol; + - "connection.host" - the target host; + - "connection.port" - the target port; + - "connection.uri" - the target URI. +- credential - the HTTPS credentials: + - "credential.ssl_key_file" - the SSL func (c *HttpEndpoint )key in PEM + - "credential.ssl_crt_file" - the SSL certificate in PEM + - "credential.ssl_ca_file" - the certificate authorities (root cerfiticates) in PEM +
++References: +
++A logger, counters, and a connection resolver can be referenced by passing the +following references to the object"s setReferences method: +
+- logger: "*:logger:*:*:1.0"; +- counters: "*:counters:*:*:1.0"; +- discovery: "*:discovery:*:*:1.0" (for the connection resolver). +
++Examples: +
+endpoint := NewHttpEndpoint(); + endpoint.Configure(config); + endpoint.SetReferences(references); + ... + endpoint.Open(correlationId) +
+ +type HttpEndpoint struct { + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewHttpEndpoint + ¶ + + +
+func NewHttpEndpoint() *HttpEndpoint
++NewHttpEndpoint creates new HttpEndpoint +
+ + + + + + + +func (*HttpEndpoint) AddCorsHeader + ¶ + + +
+func (c *HttpEndpoint) AddCorsHeader(header string, origin string)
++AddCORSHeader method adds allowed header, ignore if it already exist +must be call before to opening endpoint +
+ + + + + + +func (*HttpEndpoint) Close + ¶ + + +
+func (c *HttpEndpoint) Close(correlationId string) error
++Close method are closes this endpoint and the REST server (service) that was opened earlier. +Parameters: +
+- correlationId string (optional) transaction id to trace execution through call chain. +
++Returns: error +an error if one is raised. +
+ + + + + + +func (*HttpEndpoint) Configure + ¶ + + +
+func (c *HttpEndpoint) Configure(config *cconf.ConfigParams)
++Configure method are configures this HttpEndpoint using the given configuration parameters. +Configuration parameters: +
+- connection(s) - the connection resolver"s connections; + - "connection.discovery_key" - the key to use for connection resolving in a discovery service; + - "connection.protocol" - the connection"s protocol; + - "connection.host" - the target host; + - "connection.port" - the target port; + - "connection.uri" - the target URI. + - "credential.ssl_key_file" - SSL func (c *HttpEndpoint )key in PEM + - "credential.ssl_crt_file" - SSL certificate in PEM + - "credential.ssl_ca_file" - Certificate authority (root certificate) in PEM +- config configuration parameters, containing a "connection(s)" section. +
+ + + + + + +func (*HttpEndpoint) GetCorrelationId + ¶ + + +
+func (c *HttpEndpoint) GetCorrelationId(req *http.Request) string
++GetCorrelationId method returns CorrelationId from request +Parameters: +
+req *http.Request request +
++Returns: string +retrun correlation_id or empty string +
+ + + + + + +func (*HttpEndpoint) IsOpen + ¶ + + +
+func (c *HttpEndpoint) IsOpen() bool
++IsOpen method is whether or not this endpoint is open with an actively listening REST server. +
+ + + + + + +func (*HttpEndpoint) Open + ¶ + + +
+func (c *HttpEndpoint) Open(correlationId string) error
++Opens a connection using the parameters resolved by the referenced connection +resolver and creates a REST server (service) using the set options and parameters. +Parameters: +
+- correlationId string (optional) transaction id to trace execution through call chain. +
++Returns : error +an error if one is raised. +
+ + + + + + +func (*HttpEndpoint) Register + ¶ + + +
+func (c *HttpEndpoint) Register(registration IRegisterable)
++Registers a registerable object for dynamic endpoint discovery. +Parameters: +
+- registration IRegisterable implements of IRegisterable interface. +
++See IRegisterable +
+ + + + + + +func (*HttpEndpoint) RegisterInterceptor + ¶ + + +
+func (c *HttpEndpoint) RegisterInterceptor(route string, action func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc))
++RegisterInterceptor method are registers a middleware action for the given route. +
+- route the route to register in this object"s REST server (service). +- action the middleware action to perform at the given route. +
+ + + + + + +func (*HttpEndpoint) RegisterRoute + ¶ + + +
+func (c *HttpEndpoint) RegisterRoute(method string, route string, schema *cvalid.Schema, + action http.HandlerFunc)
++RegisterRoute method are registers an action in this objects REST server (service) by the given method and route. +
+- method string the HTTP method of the route. +- route string the route to register in this object"s REST server (service). +- schema *cvalid.Schema the schema to use for parameter validation. +- action http.HandlerFunc the action to perform at the given route. +
+ + + + + + +func (*HttpEndpoint) RegisterRouteWithAuth + ¶ + + +
+func (c *HttpEndpoint) RegisterRouteWithAuth(method string, route string, schema *cvalid.Schema, + authorize func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc), + action http.HandlerFunc)
++RegisterRouteWithAuth method are registers an action with authorization in this objects REST server (service) +by the given method and route. +Parameters: +
+- method string the HTTP method of the route. +- route string the route to register in this object"s REST server (service). +- schema *cvalid.Schema the schema to use for parameter validation. +- authorize the authorization interceptor +- action the action to perform at the given route. +
+ + + + + + +func (*HttpEndpoint) SetReferences + ¶ + + +
+func (c *HttpEndpoint) SetReferences(references crefer.IReferences)
++SetReferences method are sets references to this endpoint"s logger, counters, and connection resolver. +
+References: +- logger: "*:logger:*:*:1.0" +- counters: "*:counters:*:*:1.0" +- discovery: "*:discovery:*:*:1.0" (for the connection resolver) +
++Parameters: +
+- references an IReferences object, containing references to a logger, counters, + and a connection resolver. +
+ + + + + + +func (*HttpEndpoint) Unregister + ¶ + + +
+func (c *HttpEndpoint) Unregister(registration IRegisterable)
++Unregisters a registerable object, so that it is no longer used in dynamic +endpoint discovery. +Parameters: +
+- registration IRegisterable the registration to remove. +
++See IRegisterable +
+ + + + + + + + +type IRegisterable + ¶ + + +
++IRegisterable is interface to perform on-demand registrations. +
+ +type IRegisterable interface { + // Perform required registration steps. + Register() +}+ + + + + + + + + + + + + + + +type IRestServiceOverrides + ¶ + + +
+ +type IRestServiceOverrides interface { + Register() +}+ + + + + + + + + + + + + + + +type ISwaggerService + ¶ + + +
++ISwaggerService Interface to perform Swagger registrations. +
+ +type ISwaggerService interface { + + // Perform required Swagger registration steps. + RegisterOpenApiSpec(baseRoute string, swaggerRoute string) +}+ + + + + + + + + + + + + + + +type InstrumentTiming + ¶ + + +
+ +type InstrumentTiming struct { + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewInstrumentTiming + ¶ + + +
+func NewInstrumentTiming(correlationId string, name string, + verb string, logger clog.ILogger, counters ccount.ICounters, + counterTiming *ccount.CounterTiming, traceTiming *ctrace.TraceTiming) *InstrumentTiming
+ + + + + + + +func (*InstrumentTiming) EndFailure + ¶ + + +
+func (c *InstrumentTiming) EndFailure(err error)
+ + + + + + +func (*InstrumentTiming) EndSuccess + ¶ + + +
+func (c *InstrumentTiming) EndSuccess()
+ + + + + + +func (*InstrumentTiming) EndTiming + ¶ + + +
+func (c *InstrumentTiming) EndTiming(err error)
+ + + + + + + + +type RestOperations + ¶ + + +
++RestOperations helper class for REST operations +
+ +type RestOperations struct { + Logger *clog.CompositeLogger + Counters *ccount.CompositeCounters + DependencyResolver *crefer.DependencyResolver +} ++ + + + + + + + + + + +func NewRestOperations + ¶ + + +
+func NewRestOperations() *RestOperations
++NewRestOperations creates new instance of RestOperations +
+ + + + + + + +func (*RestOperations) Configure + ¶ + + +
+func (c *RestOperations) Configure(config *cconf.ConfigParams)
++Configure method are configures this RestOperations using the given configuration parameters. +Parameters: +
+- config *cconf.ConfigParams confif parameters +
+ + + + + + +func (*RestOperations) DecodeBody + ¶ + + +
+func (c *RestOperations) DecodeBody(req *http.Request, target interface{}) error
++DecodeBody methods helps decode body +
+- req - incoming request +- target - pointer on target variable for decode +
++Returns error +
+ + + + + + +func (*RestOperations) GetCorrelationId + ¶ + + +
+func (c *RestOperations) GetCorrelationId(req *http.Request) string
++GetCorrelationId method returns CorrelationId from request +Parameters: +
+req *http.Request request +
++Returns: string +retrun correlation_id or empty string +
+ + + + + + +func (*RestOperations) GetFilterParams + ¶ + + +
+func (c *RestOperations) GetFilterParams(req *http.Request) *cdata.FilterParams
++GetFilterParams method retruns filter params object from request +Parameters: +
+req *http.Request request +
++Returns: *cdata.FilterParams +filter params object +
+ + + + + + +func (*RestOperations) GetPagingParams + ¶ + + +
+func (c *RestOperations) GetPagingParams(req *http.Request) *cdata.PagingParams
++GetPagingParams method retruns paging params object from request +Parameters: +
+req *http.Request request +
++Returns: *cdata.PagingParams +pagings params object +
+ + + + + + +func (*RestOperations) GetParam + ¶ + + +
+func (c *RestOperations) GetParam(req *http.Request, name string) string
++GetParam methods helps get all params from query +
+- req - incoming request +- name - parameter name +
++Returns value or empty string if param not exists +
+ + + + + + +func (*RestOperations) SendBadRequest + ¶ + + +
+func (c *RestOperations) SendBadRequest(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SendConflict + ¶ + + +
+func (c *RestOperations) SendConflict(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SendCreatedResult + ¶ + + +
+func (c *RestOperations) SendCreatedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
+ + + + + + +func (*RestOperations) SendDeletedResult + ¶ + + +
+func (c *RestOperations) SendDeletedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
+ + + + + + +func (*RestOperations) SendEmptyResult + ¶ + + +
+func (c *RestOperations) SendEmptyResult(res http.ResponseWriter, req *http.Request, err error)
+ + + + + + +func (*RestOperations) SendError + ¶ + + +
+func (c *RestOperations) SendError(res http.ResponseWriter, req *http.Request, err error)
+ + + + + + +func (*RestOperations) SendInternalError + ¶ + + +
+func (c *RestOperations) SendInternalError(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SendNotFound + ¶ + + +
+func (c *RestOperations) SendNotFound(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SendResult + ¶ + + +
+func (c *RestOperations) SendResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
+ + + + + + +func (*RestOperations) SendServerUnavailable + ¶ + + +
+func (c *RestOperations) SendServerUnavailable(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SendSessionExpired + ¶ + + +
+func (c *RestOperations) SendSessionExpired(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SendUnauthorized + ¶ + + +
+func (c *RestOperations) SendUnauthorized(res http.ResponseWriter, req *http.Request, message string)
+ + + + + + +func (*RestOperations) SetReferences + ¶ + + +
+func (c *RestOperations) SetReferences(references crefer.IReferences)
++SetReferences method are sets references to this RestOperations logger, counters, and connection resolver. +Parameters: +
+- references an IReferences object, containing references to a logger, counters, +and a dependency resolver. +
+ + + + + + + + +type RestService + ¶ + + +
++RestService Abstract service that receives remove calls via HTTP/REST protocol. +
++Configuration parameters: +
+- base_route: base route for remote URI +- dependencies: + - endpoint: override for HTTP Endpoint dependency + - controller: override for Controller dependency +- connection(s): + - discovery_key: (optional) a key to retrieve the connection from IDiscovery + - protocol: connection protocol: http or https + - host: host name or IP address + - port: port number + - uri: resource URI or connection string with all parameters in it +- credential - the HTTPS credentials: + - ssl_key_file: the SSL private key in PEM + - ssl_crt_file: the SSL certificate in PEM + - ssl_ca_file: the certificate authorities (root cerfiticates) in PEM +
++References: +
++- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection +- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference +
+See RestClient
++Example: +
+type MyRestService struct { + *RestService + controller IMyController + } + + ... + func NewMyRestService() *MyRestService { + c := MyRestService{} + c.RestService = services.NewRestService() + c.RestService.IRegisterable = &c + c.numberOfCalls = 0 + c.DependencyResolver.Put("controller", crefer.NewDescriptor("mygroup", "controller", "*", "*", "1.0")) + return &c + } + + func (c * MyRestService) SetReferences(references IReferences) { + c.RestService.SetReferences(references); + resolv := c.DependencyResolver.GetRequired("controller"); + if resolv != nil { + c.controller, _ = resolv.(IMyController) + } + } + + func (c *MyRestService) getOneById(res http.ResponseWriter, req *http.Request) { + params := req.URL.Query() + vars := mux.Vars(req) + + mydataId := params.Get("mydata_id") + if mydataId == "" { + mydataId = vars["mydatay_id"] + } + result, err := c.controller.GetOneById( + params.Get("correlation_id"), + mydataId) + c.SendResult(res, req, result, err) + + } + func (c * MyRestService) Register() { + + c.RegisterRoute( + "get", "get_mydata/{mydata_id}", + &cvalid.NewObjectSchema(). + WithRequiredProperty("mydata_id", cconv.String).Schema, + c.getOneById) + ... + } + + service := NewMyRestService(); + service.Configure(cconf.NewConfigParamsFromTuples( + "connection.protocol", "http", + "connection.host", "localhost", + "connection.port", 8080, + )); + service.SetReferences(cref.NewReferencesFromTuples( + cref.NewDescriptor("mygroup","controller","default","default","1.0"), controller + )); + + opnRes := service.Open("123") + if opnErr == nil { + fmt.Println("The REST service is running on port 8080"); + } ++ +type RestService struct { + Overrides IRestServiceOverrides + + //The base route. + BaseRoute string + //The HTTP endpoint that exposes this service. + Endpoint *HttpEndpoint + //The dependency resolver. + DependencyResolver *crefer.DependencyResolver + //The logger. + Logger *clog.CompositeLogger + //The performance counters. + Counters *ccount.CompositeCounters + // The tracer. + Tracer *ctrace.CompositeTracer + + SwaggerService ISwaggerService + SwaggerEnabled bool + SwaggerRoute string + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func InheritRestService + ¶ + + +
+func InheritRestService(overrides IRestServiceOverrides) *RestService
++InheritRestService is create new instance of RestService +
+ + + + + + + +func (*RestService) Close + ¶ + + +
+func (c *RestService) Close(correlationId string) error
++Close method are closes component and frees used resources. +Parameters: +
+- correlationId (optional) transaction id to trace execution through call chain. +
++Returns: error +error or nil no errors occured. +
+ + + + + + +func (*RestService) Configure + ¶ + + +
+func (c *RestService) Configure(config *cconf.ConfigParams)
++Configure method are configures component by passing configuration parameters. +Parameters: +
+- config *cconf.ConfigParams configuration parameters to be set. +
+ + + + + + +func (*RestService) DecodeBody + ¶ + + +
+func (c *RestService) DecodeBody(req *http.Request, target interface{}) error
++DecodeBody methods helps decode body +
+- req - incoming request +- target - pointer on target variable for decode +
++Returns error +
+ + + + + + +func (*RestService) GetCorrelationId + ¶ + + +
+func (c *RestService) GetCorrelationId(req *http.Request) string
++GetCorrelationId method returns CorrelationId from request +Parameters: +
+req *http.Request request +
++Returns: string +retrun correlation_id or empty string +
+ + + + + + +func (*RestService) GetFilterParams + ¶ + + +
+func (c *RestService) GetFilterParams(req *http.Request) *cdata.FilterParams
++GetFilterParams methods helps decode filter params +
+- req - incoming request +
++Returns filter params +
+ + + + + + +func (*RestService) GetPagingParams + ¶ + + +
+func (c *RestService) GetPagingParams(req *http.Request) *cdata.PagingParams
++GetPagingParams methods helps decode paging params +
+- req - incoming request +
++Returns paging params +
+ + + + + + +func (*RestService) GetParam + ¶ + + +
+func (c *RestService) GetParam(req *http.Request, name string) string
++GetParam methods helps get all params from query +
+- req - incoming request +- name - parameter name +
++Returns value or empty string if param not exists +
+ + + + + + +func (*RestService) Instrument + ¶ + + +
+func (c *RestService) Instrument(correlationId string, name string) *InstrumentTiming
++Instrument method are adds instrumentation to log calls and measure call time. +It returns a Timing object that is used to end the time measurement. +Parameters: +
+- correlationId (optional) transaction id to trace execution through call chain. +- name a method name. +
++Returns Timing object to end the time measurement. +
+ + + + + + +func (*RestService) InstrumentError + ¶ + + +
+func (c *RestService) InstrumentError(correlationId string, name string, errIn error, + resIn interface{}) (result interface{}, err error)
++InstrumentError method are adds instrumentation to error handling. +Parameters: +
+- correlationId string (optional) transaction id to trace execution through call chain. +- name string a method name. +- err error an occured error +- result interface{} (optional) an execution result +++Returns: result interface{}, err error +
+(optional) an execution callback +
+ + + + + + +func (*RestService) IsOpen + ¶ + + +
+func (c *RestService) IsOpen() bool
++IsOpen method checks if the component is opened. +Returrns true if the component has been opened and false otherwise. +
+ + + + + + +func (*RestService) Open + ¶ + + +
+func (c *RestService) Open(correlationId string) error
++Open method are opens the component. +Parameters: +
+- correlationId string: (optional) transaction id to trace execution through call chain. + Returns: error +
++error or nil no errors occured. +
+ + + + + + +func (*RestService) Register + ¶ + + +
+func (c *RestService) Register()
++Register method are registers all service routes in HTTP endpoint. +
+ + + + + + +func (*RestService) RegisterInterceptor + ¶ + + +
+func (c *RestService) RegisterInterceptor(route string, + action func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc))
++RegisterInterceptor method are registers a middleware for a given route in HTTP endpoint. +Parameters: +
+- route a command route. Base route will be added to this route +- action an action function that is called when middleware is invoked. +
+ + + + + + +func (*RestService) RegisterOpenApiSpec + ¶ + + +
+func (c *RestService) RegisterOpenApiSpec(content string)
+ + + + + + +func (*RestService) RegisterOpenApiSpecFromFile + ¶ + + +
+func (c *RestService) RegisterOpenApiSpecFromFile(path string)
+ + + + + + +func (*RestService) RegisterRoute + ¶ + + +
+func (c *RestService) RegisterRoute(method string, route string, schema *cvalid.Schema, + action func(res http.ResponseWriter, req *http.Request))
++RegisterRoute method are registers a route in HTTP endpoint. +Parameters: +
+- method HTTP method: "get", "head", "post", "put", "delete" +- route a command route. Base route will be added to this route +- schema a validation schema to validate received parameters. +- action an action function that is called when operation is invoked. +
+ + + + + + +func (*RestService) RegisterRouteWithAuth + ¶ + + +
+func (c *RestService) RegisterRouteWithAuth(method string, route string, schema *cvalid.Schema, + authorize func(res http.ResponseWriter, req *http.Request, next http.HandlerFunc), + action func(res http.ResponseWriter, req *http.Request))
++RegisterRouteWithAuth method are registers a route with authorization in HTTP endpoint. +Parameters: +
+- method HTTP method: "get", "head", "post", "put", "delete" +- route a command route. Base route will be added to this route +- schema a validation schema to validate received parameters. +- authorize an authorization interceptor +- action an action function that is called when operation is invoked. +
+ + + + + + +func (*RestService) SendCreatedResult + ¶ + + +
+func (c *RestService) SendCreatedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
++SendCreatedResult method are sends newly created object as JSON. +That callack function call be called directly or passed +as a parameter to business logic components. +If object is not nil it returns 201 status code. +For nil results it returns 204 status code. +If error occur it sends ErrorDescription with approproate status code. +Parameters: +
+- req a HTTP request object. +- res a HTTP response object. +- result (optional) result object to send +- err error (optional) error objrct to send +
+ + + + + + +func (*RestService) SendDeletedResult + ¶ + + +
+func (c *RestService) SendDeletedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
++SendDeletedResult method are sends deleted object as JSON. +That callack function call be called directly or passed +as a parameter to business logic components. +If object is not nil it returns 200 status code. +For nil results it returns 204 status code. +If error occur it sends ErrorDescription with approproate status code. +Parameters: +
+- req a HTTP request object. + - res a HTTP response object. + - result (optional) result object to send + - err error (optional) error objrct to send +
+ + + + + + +func (*RestService) SendError + ¶ + + +
+func (c *RestService) SendError(res http.ResponseWriter, req *http.Request, err error)
++SendError method are sends error serialized as ErrorDescription object +and appropriate HTTP status code. +If status code is not defined, it uses 500 status code. +Parameters: +
+- req a HTTP request object. +- res a HTTP response object. +- error an error object to be sent. +
+ + + + + + +func (*RestService) SendResult + ¶ + + +
+func (c *RestService) SendResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
++SendResult method method are sends result as JSON object. +That function call be called directly or passed +as a parameter to business logic components. +If object is not nil it returns 200 status code. +For nil results it returns 204 status code. +If error occur it sends ErrorDescription with approproate status code. +Parameters: +
+- req a HTTP request object. +- res a HTTP response object. +- result (optional) result object to send +- err error (optional) error objrct to send +
+ + + + + + +func (*RestService) SetReferences + ¶ + + +
+func (c *RestService) SetReferences(references crefer.IReferences)
++SetReferences method are sets references to dependent components. +Parameters: +
+- references crefer.IReferences references to locate the component dependencies. +
+ + + + + + +func (*RestService) UnsetReferences + ¶ + + +
+func (c *RestService) UnsetReferences()
++UnsetReferences method are unsets (clears) previously set references to dependent components. +
+ + + + + + + + +type StatusOperations + ¶ + + +
++StatusOperations helper class for status service +
+ +type StatusOperations struct { + RestOperations + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewStatusOperations + ¶ + + +
+func NewStatusOperations() *StatusOperations
++NewStatusOperations creates new instance of StatusOperations +
+ + + + + + + +func (*StatusOperations) GetStatusOperation + ¶ + + +
+func (c *StatusOperations) GetStatusOperation() func(res http.ResponseWriter, req *http.Request)
++GetStatusOperation return function for get status +
+ + + + + + +func (*StatusOperations) SetReferences + ¶ + + +
+func (c *StatusOperations) SetReferences(references crefer.IReferences)
++SetReferences sets references to dependent components. +
+- references crefer.IReferences references to locate the component dependencies. +
+ + + + + + +func (*StatusOperations) Status + ¶ + + +
+func (c *StatusOperations) Status(res http.ResponseWriter, req *http.Request)
++Status method handles status requests +
+- req *http.Request an HTTP request +- res http.ResponseWriter an HTTP response +
+ + + + + + + + +type StatusRestService + ¶ + + +
++StatusRestService is a service that returns microservice status information via HTTP/REST protocol. +
++The service responds on /status route (can be changed) with a JSON object: +
+{ + - "id": unique container id (usually hostname) + - "name": container name (from ContextInfo) + - "description": container description (from ContextInfo) + - "start_time": time when container was started + - "current_time": current time in UTC + - "uptime": duration since container start time in milliseconds + - "properties": additional container properties (from ContextInfo) + - "components": descriptors of components registered in the container +} +++Configuration parameters: +
+- baseroute: base route for remote URI +- route: status route (default: "status") +- dependencies: + - endpoint: override for HTTP Endpoint dependency + - controller: override for Controller dependency +- connection(s): + - discovery_key: (optional) a key to retrieve the connection from IDiscovery + - protocol: connection protocol: http or https + - host: host name or IP address + - port: port number + - uri: resource URI or connection string with all parameters in it +
++References: +
++- *:logger:*:*:1.0 (optional) ILogger components to pass log messages +- *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements +- *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection +- *:endpoint:http:*:1.0 (optional) HttpEndpoint reference +
++See: RestService +See: RestClient +
++Example: +
+service = NewStatusService(); + service.Configure(cref.NewConfigParamsFromTuples( + "connection.protocol", "http", + "connection.host", "localhost", + "connection.port", 8080, + )); + + opnErr:= service.Open("123") + if opnErr == nil { + fmt.Println("The Status service is accessible at http://localhost:8080/status"); + } ++ +type StatusRestService struct { + *RestService + // contains filtered or unexported fields +} ++ + + + + + + + + + + +func NewStatusRestService + ¶ + + +
+func NewStatusRestService() *StatusRestService
++NewStatusRestService method are creates a new instance of this service. +
+ + + + + + + +func (*StatusRestService) Configure + ¶ + + +
+func (c *StatusRestService) Configure(config *cconf.ConfigParams)
++Configure method are configures component by passing configuration parameters. +Parameters: +
+- config *cconf.ConfigParams configuration parameters to be set. +
+ + + + + + +func (*StatusRestService) Register + ¶ + + +
+func (c *StatusRestService) Register()
++Register method are registers all service routes in HTTP endpoint. +
+ + + + + + +func (*StatusRestService) SetReferences + ¶ + + +
+func (c *StatusRestService) SetReferences(references crefer.IReferences)
++SetReferences method are sets references to dependent components. +Parameters: +
+- references crefer.IReferences references to locate the component dependencies. +
+ + + + + + + + +type THttpRequestDetector + ¶ + + +
+ +type THttpRequestDetector struct { +} ++ + + + + + + + + + + + + +func (*THttpRequestDetector) DetectAddress + ¶ + + +
+func (c *THttpRequestDetector) DetectAddress(req *http.Request) string
++DetectAddress method are detects the IP address from which the given HTTP request was received. +
+- req *http.Reques an HTTP request to process. +Returns the detected IP address (without a port). If no IP is detected - +
++nil will be returned. +
+ + + + + + +func (*THttpRequestDetector) DetectBrowser + ¶ + + +
+func (c *THttpRequestDetector) DetectBrowser(req *http.Request) string
++Detects the browser (using "user-agent") from which the given HTTP request was made. +
+- req *http.Reques an HTTP request to process. +Returns the detected browser. Detectable browsers: "chrome", "msie", "firefox", +
++"safari". Otherwise - "unknown" will be returned. +
+ + + + + + +func (*THttpRequestDetector) DetectPlatform + ¶ + + +
+func (c *THttpRequestDetector) DetectPlatform(req *http.Request) string
++DetectPlatform method are detects the platform (using "user-agent") from which the given HTTP request was made. +
+- req *http.Request an HTTP request to process. +Returns the detected platform and version. Detectable platforms: "mobile", "iphone", +"ipad", "macosx", "android", "webos", "mac", "windows". Otherwise - "unknown" will +
++be returned. +
+ + + + + + +func (*THttpRequestDetector) DetectServerHost + ¶ + + +
+func (c *THttpRequestDetector) DetectServerHost(req *http.Request) string
++DetectServerHost method are detects the host name of the request"s destination server. +
+- req *http.Request an HTTP request to process. +Returns the destination server"s host name. +
+ + + + + + +func (*THttpRequestDetector) DetectServerPort + ¶ + + +
+func (c *THttpRequestDetector) DetectServerPort(req *http.Request) string
++DetectServerPort method are detects the request"s destination port number. +
+- req *http.Request an HTTP request to process. +Returns the detected port number or <code>80</code> (if none are detected). +
+ + + + + + + + +type THttpResponseSender + ¶ + + +
+ +type THttpResponseSender struct { +} ++ + + + + +var HttpResponseSender THttpResponseSender = THttpResponseSender{}
+ + + + + + + + + + +func (*THttpResponseSender) SendCreatedResult + ¶ + + +
+func (c *THttpResponseSender) SendCreatedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
++SendCreatedResult are sends newly created object as JSON. +That function call be called directly or passed +as a parameter to business logic components. +If object is not nil it returns 201 status code. +For nil results it returns 204 status code. +If error occur it sends ErrorDescription with approproate status code. +Parameters: +
+- req *http.Request a HTTP request object. +- res http.ResponseWriter a HTTP response object. +
+ + + + + + +func (*THttpResponseSender) SendDeletedResult + ¶ + + +
+func (c *THttpResponseSender) SendDeletedResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
++SendDeletedResult are sends deleted object as JSON. +That function call be called directly or passed +as a parameter to business logic components. +If object is not nil it returns 200 status code. +For nil results it returns 204 status code. +If error occur it sends ErrorDescription with approproate status code. +Parameters: +
+- req *http.Request a HTTP request object. +- res http.ResponseWriter a HTTP response object. +
+ + + + + + +func (*THttpResponseSender) SendEmptyResult + ¶ + + +
+func (c *THttpResponseSender) SendEmptyResult(res http.ResponseWriter, req *http.Request, err error)
++SendEmptyResult are sends an empty result with 204 status code. +If error occur it sends ErrorDescription with approproate status code. +
+- req *http.Request a HTTP request object. +- res http.ResponseWriter a HTTP response object. +
+ + + + + + +func (*THttpResponseSender) SendError + ¶ + + +
+func (c *THttpResponseSender) SendError(res http.ResponseWriter, req *http.Request, err error)
++SendError sends error serialized as ErrorDescription object +and appropriate HTTP status code. +If status code is not defined, it uses 500 status code. +Parameters: +
+- req *http.Request a HTTP request object. +- res http.ResponseWriter a HTTP response object. +- err error an error object to be sent. +
+ + + + + + +func (*THttpResponseSender) SendResult + ¶ + + +
+func (c *THttpResponseSender) SendResult(res http.ResponseWriter, req *http.Request, result interface{}, err error)
++SendResult sends result as JSON object. +That function call be called directly or passed +as a parameter to business logic components. +If object is not nil it returns 200 status code. +For nil results it returns 204 status code. +If error occur it sends ErrorDescription with approproate status code. +Parameters: +
+- req *http.Request a HTTP request object. +- res http.ResponseWriter a HTTP response object. +- result interface{} result object to be send +- err error an error object to be sent. ++ + + + + + + + + + + + + + + + + + +
- element.
- function cgAddChild(tree, ul, cgn) {
- var li = document.createElement('li');
- ul.appendChild(li);
- li.className = 'closed';
-
- var code = document.createElement('code');
-
- if (cgn.Callees != null) {
- $(li).addClass('expandable');
-
- // Event handlers and innerHTML updates don't play nicely together,
- // hence all this explicit DOM manipulation.
- var hitarea = document.createElement('div');
- hitarea.className = 'hitarea expandable-hitarea';
- li.appendChild(hitarea);
-
- li.appendChild(code);
-
- var childUL = document.createElement('ul');
- li.appendChild(childUL);
- childUL.setAttribute('style', 'display: none;');
-
- var onClick = function() {
- document.cgAddChildren(tree, childUL, cgn.Callees);
- hitarea.removeEventListener('click', onClick);
- };
- hitarea.addEventListener('click', onClick);
- } else {
- li.appendChild(code);
- }
- code.innerHTML += ' ' + makeAnchor(cgn.Func);
- return li;
- }
-})();
+// Copyright 2012 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/* A little code to ease navigation of these documents.
+ *
+ * On window load we:
+ * + Generate a table of contents (generateTOC)
+ * + Bind foldable sections (bindToggles)
+ * + Bind links to foldable sections (bindToggleLinks)
+ */
+
+(function() {
+ 'use strict';
+
+ // Mobile-friendly topbar menu
+ $(function() {
+ var menu = $('#menu');
+ var menuButton = $('#menu-button');
+ var menuButtonArrow = $('#menu-button-arrow');
+ menuButton.click(function(event) {
+ menu.toggleClass('menu-visible');
+ menuButtonArrow.toggleClass('vertical-flip');
+ event.preventDefault();
+ return false;
+ });
+ });
+
+ /* Generates a table of contents: looks for h2 and h3 elements and generates
+ * links. "Decorates" the element with id=="nav" with this table of contents.
+ */
+ function generateTOC() {
+ if ($('#manual-nav').length > 0) {
+ return;
+ }
+
+ // For search, we send the toc precomputed from server-side.
+ // TODO: Ideally, this should always be precomputed for all pages, but then
+ // we need to do HTML parsing on the server-side.
+ if (location.pathname === '/search') {
+ return;
+ }
+
+ var nav = $('#nav');
+ if (nav.length === 0) {
+ return;
+ }
+
+ var toc_items = [];
+ $(nav)
+ .nextAll('h2, h3')
+ .each(function() {
+ var node = this;
+ if (node.id == '') node.id = 'tmp_' + toc_items.length;
+ var link = $('')
+ .attr('href', '#' + node.id)
+ .text($(node).text());
+ var item;
+ if ($(node).is('h2')) {
+ item = $('');
+ } else {
+ // h3
+ item = $('');
+ }
+ item.append(link);
+ toc_items.push(item);
+ });
+ if (toc_items.length <= 1) {
+ return;
+ }
+ var dl1 = $('
' + + 'Your download should begin shortly. ' + + 'If it does not, click this link.
' + ); + message.find('a').attr('href', download); + message.insertAfter('#nav'); + + window.location = download; + } + + function updateVersionTags() { + var v = window.goVersion; + if (/^go[0-9.]+$/.test(v)) { + $('.versionTag') + .empty() + .text(v); + $('.whereTag').hide(); + } + } + + function addPermalinks() { + function addPermalink(source, parent) { + var id = source.attr('id'); + if (id == '' || id.indexOf('tmp_') === 0) { + // Auto-generated permalink. + return; + } + if (parent.find('> .permalink').length) { + // Already attached. + return; + } + parent + .append(' ') + .append($("¶").attr('href', '#' + id)); + } + + $('#page .container') + .find('h2[id], h3[id]') + .each(function() { + var el = $(this); + addPermalink(el, el); + }); + + $('#page .container') + .find('dl[id]') + .each(function() { + var el = $(this); + // Add the anchor to the "dt" element. + addPermalink(el, el.find('> dt').first()); + }); + } + + $('.js-expandAll').click(function() { + if ($(this).hasClass('collapsed')) { + toggleExamples('toggle'); + $(this).text('(Collapse All)'); + } else { + toggleExamples('toggleVisible'); + $(this).text('(Expand All)'); + } + $(this).toggleClass('collapsed'); + }); + + function toggleExamples(className) { + // We need to explicitly iterate through divs starting with "example_" + // to avoid toggling Overview and Index collapsibles. + $("[id^='example_']").each(function() { + // Check for state and click it only if required. + if ($(this).hasClass(className)) { + $(this) + .find('.toggleButton') + .first() + .click(); + } + }); + } + + $(document).ready(function() { + generateTOC(); + addPermalinks(); + bindToggles('.toggle'); + bindToggles('.toggleVisible'); + bindToggleLinks('.exampleLink', 'example_'); + bindToggleLinks('.overviewLink', ''); + bindToggleLinks('.examplesLink', ''); + bindToggleLinks('.indexLink', ''); + setupDropdownPlayground(); + setupInlinePlayground(); + fixFocus(); + setupTypeInfo(); + setupCallgraphs(); + toggleHash(); + personalizeInstallInstructions(); + updateVersionTags(); + + // godoc.html defines window.initFuncs in the tag, and root.html and + // codewalk.js push their on-page-ready functions to the list. + // We execute those functions here, to avoid loading jQuery until the page + // content is loaded. + for (var i = 0; i < window.initFuncs.length; i++) window.initFuncs[i](); + }); + + // -- analysis --------------------------------------------------------- + + // escapeHTML returns HTML for s, with metacharacters quoted. + // It is safe for use in both elements and attributes + // (unlike the "set innerText, read innerHTML" trick). + function escapeHTML(s) { + return s + .replace(/&/g, '&') + .replace(/\"/g, '"') + .replace(/\'/g, ''') + .replace(//g, '>'); + } + + // makeAnchor returns HTML for an element, given an anchorJSON object. + function makeAnchor(json) { + var html = escapeHTML(json.Text); + if (json.Href != '') { + html = "" + html + ''; + } + return html; + } + + function showLowFrame(html) { + var lowframe = document.getElementById('lowframe'); + lowframe.style.height = '200px'; + lowframe.innerHTML = + "" + + html + + '
\n' + + "✘
";
+ }
+
+ document.hideLowFrame = function() {
+ var lowframe = document.getElementById('lowframe');
+ lowframe.style.height = '0px';
+ };
+
+ // onClickCallers is the onclick action for the 'func' tokens of a
+ // function declaration.
+ document.onClickCallers = function(index) {
+ var data = document.ANALYSIS_DATA[index];
+ if (data.Callers.length == 1 && data.Callers[0].Sites.length == 1) {
+ document.location = data.Callers[0].Sites[0].Href; // jump to sole caller
+ return;
+ }
+
+ var html =
+ 'Callers of ' + escapeHTML(data.Callee) + ':\n'; + for (var i = 0; i < data.Callers.length; i++) { + var caller = data.Callers[i]; + html += '
' + escapeHTML(caller.Func) + '';
+ var sites = caller.Sites;
+ if (sites != null && sites.length > 0) {
+ html += ' at line ';
+ for (var j = 0; j < sites.length; j++) {
+ if (j > 0) {
+ html += ', ';
+ }
+ html += '' + makeAnchor(sites[j]) + '';
+ }
+ }
+ html += '\n'; + } + showLowFrame(html); + }; + + // onClickCallees is the onclick action for the '(' token of a function call. + document.onClickCallees = function(index) { + var data = document.ANALYSIS_DATA[index]; + if (data.Callees.length == 1) { + document.location = data.Callees[0].Href; // jump to sole callee + return; + } + + var html = 'Callees of this ' + escapeHTML(data.Descr) + ':
\n'; + for (var i = 0; i < data.Callees.length; i++) { + html += '
' + makeAnchor(data.Callees[i]) + '\n'; + } + showLowFrame(html); + }; + + // onClickTypeInfo is the onclick action for identifiers declaring a named type. + document.onClickTypeInfo = function(index) { + var data = document.ANALYSIS_DATA[index]; + var html = + 'Type
' +
+ data.Name +
+ ': ' +
+ ' (size=' +
+ data.Size +
+ ', align=' +
+ data.Align +
+ ')\n'; + html += implementsHTML(data); + html += methodsetHTML(data); + showLowFrame(html); + }; + + // implementsHTML returns HTML for the implements relation of the + // specified TypeInfoJSON value. + function implementsHTML(info) { + var html = ''; + if (info.ImplGroups != null) { + for (var i = 0; i < info.ImplGroups.length; i++) { + var group = info.ImplGroups[i]; + var x = '
' + escapeHTML(group.Descr) + ' ';
+ for (var j = 0; j < group.Facts.length; j++) {
+ var fact = group.Facts[j];
+ var y = '' + makeAnchor(fact.Other) + '';
+ if (fact.ByKind != null) {
+ html += escapeHTML(fact.ByKind) + ' type ' + y + ' implements ' + x;
+ } else {
+ html += x + ' implements ' + y;
+ }
+ html += '\n'; + } + } + } + return html; + } + + // methodsetHTML returns HTML for the methodset of the specified + // TypeInfoJSON value. + function methodsetHTML(info) { + var html = ''; + if (info.Methods != null) { + for (var i = 0; i < info.Methods.length; i++) { + html += '
' + makeAnchor(info.Methods[i]) + '\n'; + } + } + return html; + } + + // onClickComm is the onclick action for channel "make" and "<-" + // send/receive tokens. + document.onClickComm = function(index) { + var ops = document.ANALYSIS_DATA[index].Ops; + if (ops.length == 1) { + document.location = ops[0].Op.Href; // jump to sole element + return; + } + + var html = 'Operations on this channel:
\n'; + for (var i = 0; i < ops.length; i++) { + html += + makeAnchor(ops[i].Op) + + ' by
' +
+ escapeHTML(ops[i].Fn) +
+ '\n'; + } + if (ops.length == 0) { + html += '(none)
\n'; + } + showLowFrame(html); + }; + + $(window).load(function() { + // Scroll window so that first selection is visible. + // (This means we don't need to emit id='L%d' spans for each line.) + // TODO(adonovan): ideally, scroll it so that it's under the pointer, + // but I don't know how to get the pointer y coordinate. + var elts = document.getElementsByClassName('selection'); + if (elts.length > 0) { + elts[0].scrollIntoView(); + } + }); + + // setupTypeInfo populates the "Implements" and "Method set" toggle for + // each type in the package doc. + function setupTypeInfo() { + for (var i in document.ANALYSIS_DATA) { + var data = document.ANALYSIS_DATA[i]; + + var el = document.getElementById('implements-' + i); + if (el != null) { + // el != null => data is TypeInfoJSON. + if (data.ImplGroups != null) { + el.innerHTML = implementsHTML(data); + el.parentNode.parentNode.style.display = 'block'; + } + } + + var el = document.getElementById('methodset-' + i); + if (el != null) { + // el != null => data is TypeInfoJSON. + if (data.Methods != null) { + el.innerHTML = methodsetHTML(data); + el.parentNode.parentNode.style.display = 'block'; + } + } + } + } + + function setupCallgraphs() { + if (document.CALLGRAPH == null) { + return; + } + document.getElementById('pkg-callgraph').style.display = 'block'; + + var treeviews = document.getElementsByClassName('treeview'); + for (var i = 0; i < treeviews.length; i++) { + var tree = treeviews[i]; + if (tree.id == null || tree.id.indexOf('callgraph-') != 0) { + continue; + } + var id = tree.id.substring('callgraph-'.length); + $(tree).treeview({ collapsed: true, animated: 'fast' }); + document.cgAddChildren(tree, tree, [id]); + tree.parentNode.parentNode.style.display = 'block'; + } + } + + document.cgAddChildren = function(tree, ul, indices) { + if (indices != null) { + for (var i = 0; i < indices.length; i++) { + var li = cgAddChild(tree, ul, document.CALLGRAPH[indices[i]]); + if (i == indices.length - 1) { + $(li).addClass('last'); + } + } + } + $(tree).treeview({ animated: 'fast', add: ul }); + }; + + // cgAddChild adds an