{"id":1687,"date":"2014-09-30T17:30:03","date_gmt":"2014-09-30T15:30:03","guid":{"rendered":"http:\/\/hasselba.ch\/blog\/?p=1687"},"modified":"2014-09-30T17:55:17","modified_gmt":"2014-09-30T15:55:17","slug":"xpages-execute-events-with-http-get","status":"publish","type":"post","link":"https:\/\/hasselba.ch\/blog\/?p=1687","title":{"rendered":"XPages: Execute Events with HTTP Get"},"content":{"rendered":"

To execute an event on the server, you normally have to send a POST request, because actions will be executed in the Invoke Application<\/em> phase of the JSF lifecycle. A GET request will only process the Restore View<\/em> and the Render Response<\/em> phase, that why you can not execute an event with a GET request.<\/p>\n

But with the help of a PhaseListener<\/em>, the execution can be done earlier in the Restore View<\/em> phase:<\/p>\n

package ch.hasselba.xpages.util;\r\n\r\nimport javax.faces.event.PhaseEvent;\r\nimport javax.faces.event.PhaseId;\r\nimport javax.faces.event.PhaseListener;\r\nimport com.ibm.xsp.component.xp.XspEventHandler;\r\nimport javax.faces.context.ExternalContext;\r\nimport javax.faces.context.FacesContext;\r\nimport com.ibm.xsp.util.FacesUtil;\r\n\r\npublic class ExecuteOnServerPhaseListener implements PhaseListener {\r\n\r\n\u00a0\u00a0 \u00a0private static final long serialVersionUID = 1L;\r\n\r\n\u00a0\u00a0 \u00a0public void beforePhase(PhaseEvent event) {}\r\n\r\n\u00a0\u00a0\u00a0 public PhaseId getPhaseId() {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return PhaseId.RESTORE_VIEW;\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\u00a0\u00a0\u00a0 public void afterPhase(PhaseEvent event) {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0FacesContextExImpl = FacesContextExImpl.getCurrentInstance();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0ExternalContext ec = fc.getExternalContext();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String url = ec.getRequestPathInfo();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String[] pathes = url.split( \"\/\" );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0try{\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0if( pathes.length > 2 ){\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0if( \"executeOnServer\".equals( pathes[pathes.length -2 ] ) ){\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String[] fullId = pathes[ pathes.length - 1 ].split(\":\");\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0String actionId = fullId[ fullId.length - 1 ];\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0XspEventHandler eventHandler = (XspEventHandler)\r\n                        FacesUtil.findComponentWithFullId( fc.getViewRoot(), actionId );\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0if( eventHandler != null ){\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0eventHandler.getAction().invoke( fc, null );\r\n                        fc.responseComplete();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0            }\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}catch(Exception e){\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0e.printStackTrace();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0 }\r\n\r\n}<\/code><\/pre>\n
To activate the PhaseListener<\/em>, it has to be enabled in the faces-config.xml:<\/em><\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<faces-config>\r\n   <lifecycle>\r\n      <phase-listener>ch.hasselba.xpages.util.ExecuteOnServerPhaseListener<\/phase-listener>\r\n   <\/lifecycle>\r\n<\/faces-config><\/code><\/pre>\n
The following Javascript snippet extends the XSP object and adds the new function executeOnServerGet<\/em> to it. The parameter is the if of the event to invoke.<\/p>\n
XSP.executeOnServerGet = function( eventId ){\r\n    var viewId = dojo.query('[name=\"$$viewid\"]')[0].value;\r\n\u00a0\u00a0 \u00a0var url = document.forms[0].action;\r\n\u00a0\u00a0 \u00a0url += \"\/executeOnServer\/\" + eventId;\r\n\u00a0\u00a0 \u00a0url += \"?$$viewid=\" + viewId;\r\n\u00a0\u00a0 \u00a0url += \"&$$ajaxid=@none\";\r\n\u00a0\u00a0 \u00a0dojo.xhrGet({url: url});\r\n}\r\n<\/code><\/pre>\n
When calling the function, it sends a GET request and adds the current view id to the request. With the parameter $$ajaxId<\/em> set to @none<\/em>, the XPages Engine is forced to send no HTML code back to the client.<\/p>\n
And here is an example XPage:<\/p>\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<xp:view xmlns:xp=\"http:\/\/www.ibm.com\/xsp\/core\">\r\n\r\n\u00a0\u00a0 \u00a0<xp:eventHandler id=\"helloworld\" event=\"helloworld\" submit=\"false\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:this.action>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<![CDATA[#{javascript:\r\n               print(\"hello world \" + java.lang.System.currentTimeMillis() );\r\n            }]]>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:this.action>\r\n\u00a0\u00a0 \u00a0<\/xp:eventHandler>\r\n\r\n\r\n\u00a0\u00a0 \u00a0<xp:scriptBlock id=\"scriptBlock1\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:this.value><![CDATA[\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0dojo.addOnLoad( function(){\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0XSP.executeOnServerGet = function( eventId ){\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0var viewId = dojo.query('[name=\"$$viewid\"]')[0].value;\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0var url = document.forms[0].action;\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0url += \"\/executeOnServer\/\" + eventId;\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0url += \"?$$viewid=\" + viewId;\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0url += \"&$$ajaxid=@none\";\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0dojo.xhrGet({url: url});\r\n\u00a0\u00a0 \u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0}\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0});\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0]]><\/xp:this.value>\r\n\u00a0\u00a0 \u00a0<\/xp:scriptBlock>\r\n\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0 \u00a0<xp:button value=\"Execute\" id=\"button1\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:eventHandler event=\"onclick\" submit=\"false\">\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<xp:this.script>\r\n                <![CDATA[XSP.executeOnServerGet( \"#{id:helloworld}\" );]]>\r\n            <\/xp:this.script>\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0<\/xp:eventHandler>\r\n\u00a0\u00a0 \u00a0<\/xp:button>\r\n<\/xp:view><\/code><\/pre>\n
When clicking the button, the following URL is opened in the background:<\/p>\n
http:\/\/example.com\/db.nsf\/EventGet.xsp\/executeOnServer\/view:_id1:helloworld?$$viewid=!dwjldz64w0!&$$ajaxid=@none<\/code><\/pre>\n
A GET request was sent to the server:\"\"If you look on the server console, you will see that the Action was invoked:<\/p>\n
\"\"<\/p>\n","protected":false},"excerpt":{"rendered":"
To execute an event on the server, you normally have to send a POST request, because actions will be executed in the Invoke Application phase of the JSF lifecycle. A GET request will only process the Restore View and the … Weiterlesen →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[75,89,9,26,27,74,24],"tags":[33,47,8,7,11,31,4,86,87,3,85],"class_list":["post-1687","post","type-post","status-publish","format-standard","hentry","category-dojo","category-java","category-javascript","category-jsf","category-performance","category-xpages","category-xsp","tag-8-5-3","tag-9-0","tag-dojo","tag-domino","tag-http","tag-java","tag-js","tag-jsf","tag-performance","tag-xpages","tag-xsp"],"_links":{"self":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1687","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1687"}],"version-history":[{"count":12,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1687\/revisions"}],"predecessor-version":[{"id":1699,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1687\/revisions\/1699"}],"wp:attachment":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1687"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1687"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1687"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}