XOBWLIB ;ALB/MJK - HWSC :: Utilities Library ; 09/13/10 4:00pm
Source file <XOBWLIB.m>
| Name | Comments | DBIA/ICR reference |
|---|---|---|
| GETFAC(XOBWSN) | ; -- get web service proxy factory
; Input: ; XOBWSN - web service name |
|
| GETPROXY(XOBWSN,XOBSRVR) | ; -- get web service proxy
; Input: ; XOBWSN - web service name ; XOBSRVR - web server name |
|
| GENPORT(XOBY) | ; -- generate http port class from WSDL during install
|
|
| REGSOAP(XOBWSN,XOBCXT,XOBCLASS,XOBWSDL,XOBCAURL) | ; -- register SOAP service
; Input: ; XOBWSN - SOAP web service name ; XOBCXT - web service context root ; XOBCLASS - full class name, including package ; XOBWSDL - file path containing WSDL document [optional] ; XOBCAURL - 'check availability' url portion to follow context root [optional] |
|
| ATTACHDR(XOBPROXY) | ; -- add VistaInfoHeader to proxy object
; Input: ; XOBPROXY - web service proxy object |
|
| UNREG(XOBWSN) | ; unregister/delete REST *or* SOAP web service
; Input: ; XOBWSN - web service name |
|
| GETRESTF(XOBWSN) | ; -- get REST service request factory
; Input: ; XOBWSN - web service name |
|
| GETREST(XOBWSN,XOBSRVR) | ; -- get REST service request
; Input: ; XOBWSN - web service name ; XOBSRVR - web server name |
|
| REGREST(XOBWSN,XOBCXT,XOBCAURL) | ; -- register REST service
; Input: ; XOBWSN - REST web service name ; XOBCXT - web service context root ; XOBCAURL - 'check availability' url portion to follow context root [optional] |
|
| GET(XOBREST,XOBRSCE,XOBERR,XOBFERR) | ; -- do HTTP GET method and force M/Cache error if problem encountered
; Executes STATCHK and HTTPCHK calls. ; input: ; XOBREST = instance of xobw.RestRequest class ; XOBRSCE = resource for HTTP GET method ; XOBERR = where to store HWSC error object if problem encountered ; XOBFERR = if error object created, force M/Cache error [1], otherwise return to caller [0] ; [optional ; default = 1] |
|
| POST(XOBREST,XOBRSCE,XOBERR,XOBFERR) | ; -- do HTTP POST method and force M/Cache error if problem encountered
; Executes STATCHK and HTTPCHK calls. ; input: ; XOBREST = instance of xobw.RestRequest class ; XOBRSCE = resource for HTTP GET method ; XOBERR = where to store HWSC error object if problem encountered ; XOBFERR = if error object created, force M/Cache error [1], otherwise return to caller [0] ; [optional ; default = 1] |
|
| HTTPCHK(XOBREST,XOBERR,XOBFERR) | ; -- check HTTP response status code
; input: ; XOBREST = instance of xobw.RestRequest class ; XOBERR = where to store HWSC error object if problem encountered ; XOBFERR = if error object created, force M/Cache error [1], otherwise return to caller [0] ; [optional ; default = 1] |
|
| HTTPOK(XOBSCODE) | ; -- is HTTP response status code an 'OK' code
; -- Future: Should we add more 200 series codes to the check? |
|
| EOFAC(XOBPROXY) | ; -- Error Object FACtory
; > finds and parses errors in partition ; > builds and returns error object for easier processing |
|
| EOSTAT(XOBSO) | ; -- create object error from status error object
|
|
| EOHTTP(XOBHRO) | ; -- create object error from %Net.HttpResponse object
|
|
| ERRDISP(XOBEO) | ; -- do simple error display
|
|
| ERR2ARR(XOBEO,XOBERR) | ; -- decompose error for traditional M processing
|
|
| ZTER(XOBEO) | ; -- build error object array and call error trap
|
|
| STATCHK(XOBSO,XOBERR,XOBFERR) | ; -- check Cache Status Object
; input: ; XOBSO = Cache status object ; XOBERR = where to store HWSC error object if problem encountered ; XOBFERR = if error object created, force M/Cache error [1], otherwise return to caller [0] ; [optional ; default = 1] |
|
| SKEYADD(XOBWKEY,XOBWDESC,XOBERR) | ; add or edit a server key name/desc (no prompting)
; input parameters: ; XOBWKEY: name for key ; XOBWDESC: (optional) brief description ; XOBERR: (optional) textual error description as array node(s) starting ; at XOBERR(1) / passed by reference ; returns: ; >0: success (value = IEN of new or existing entry) ; 0: failure (did not add/edit key) |
|
| SNAME4KY(XOBWKEY,XOBWSNM,XOBERR) | ; get server name based on key
; input parameters: ; XOBWKEY: name of key to lookup ; XOBWSNM: where web server name is returned / passed by reference ; XOBERR: (optional) where any error is returned / passed by reference ; format: <error #>^<error text> ; errors possible: ; 186008^description (key does not exist) ; 186009^description (server association missing) ; returns: ; 1 - successful lookup ; 0 - unsuccessful lookup ; |
|
| SELSRV() | ; -- interactive display and selection of an server
; Input: None ; Output: ; Function Value - server name ; -- display servers |
|
| GETSRV() | ; -- PUBLIC API: return interactive-user-selected server name
; User selects a server entry in the WEB SERVER file (#18.12) ; Input: ; None ; Output: ; Function Value - server name (#.01 field of file 18.12) ; |
|
| DISPSRVS | ; -- display servers
; Input: ; None ; Output: ; Screen formatted display of app servers and associated fields from file 18.12 |
| Name | Line Occurrences |
|---|---|
| $$EOHTTP | HTTPCHK+10 |
| $$EOSTAT | STATCHK+10 |
| $$GETSRV | SELSRV+7 |
| $$HTTPCHK | GET+10, POST+10 |
| $$HTTPOK | HTTPCHK+7 |
| $$STATCHK | GET+9, POST+9 |
| DISPSRVS | SELSRV+5 |
| ERR2ARR | ZTER+3 |
| >> | Not killed explicitly |
| * | Changed |
| ! | Killed |
| ~ | Newed |
| Name | Field # of Occurrence |
|---|---|
| XOBCAURL | REGSOAP~, REGSOAP+7, REGREST~, REGREST+5 |
| XOBCLASS | REGSOAP~, REGSOAP+7 |
| XOBCXT | REGSOAP~, REGSOAP+7, REGREST~, REGREST+5 |
| XOBEO | ERRDISP~, ERRDISP+1, ERR2ARR~, ERR2ARR+1, ZTER~, ZTER+3 |
| XOBEOARR | ZTER+1~, ZTER+3 |
| XOBERR | GET~, GET+9, GET+10, POST~, POST+9, POST+10, HTTPCHK~, HTTPCHK+10*, ERR2ARR~, ERR2ARR+2 , STATCHK~, STATCHK+10*, SKEYADD~, SKEYADD+9, SNAME4KY~, SNAME4KY+13 |
| XOBFERR | GET~, GET+9, GET+10, POST~, POST+9, POST+10, HTTPCHK~, HTTPCHK+12, STATCHK~, STATCHK+12 |
| XOBHRO | EOHTTP~, EOHTTP+3 |
| XOBOK | GET+8~, GET+9*, GET+10*, GET+11, POST+8~, POST+9*, POST+10*, POST+11, HTTPCHK+6~, HTTPCHK+7* , HTTPCHK+8, HTTPCHK+13, STATCHK+6~, STATCHK+7*, STATCHK+8, STATCHK+13 |
| XOBPROXY | ATTACHDR~, ATTACHDR+3, EOFAC~, EOFAC+7 |
| XOBREST | GET~, GET+10, POST~, POST+10, HTTPCHK~ |
| XOBRSCE | GET~, GET+9, POST~, POST+9 |
| XOBSCODE | HTTPOK~, HTTPOK+2 |
| XOBSO | EOSTAT~, EOSTAT+3, STATCHK~, STATCHK+7, STATCHK+10 |
| XOBSRVR | GETPROXY~, GETPROXY+4, GETREST~, GETREST+4 |
| XOBWDESC | SKEYADD~, SKEYADD+9 |
| XOBWKEY | SKEYADD~, SKEYADD+9, SNAME4KY~, SNAME4KY+13 |
| XOBWSDL | REGSOAP~, REGSOAP+7 |
| XOBWSN | GETFAC~, GETFAC+3, GETPROXY~, GETPROXY+4, REGSOAP~, REGSOAP+7, UNREG~, UNREG+3, GETRESTF~, GETRESTF+3 , GETREST~, GETREST+4, REGREST~, REGREST+5 |
| XOBWSNM | SNAME4KY~, SNAME4KY+13 |
| XOBY | GENPORT~, GENPORT+1 |
