\nThe application definition is used to describe a new\napplication into the Nuxeo platform.\nIt is more a new type of\nnavigation than a new application, but we consider that each\ncontribution will expose a new ergonomy and new usage - so new\n"application". Typical usage can\nwhen you create a dedicate webengine\napplication for mobile. We may want to keep the user into\nthis\nwebengine application and redirect to this application even the user\nclick on a JSF link.\n
\nThe service provide also a possibility to\ncontribute a JSP page to select a type of navigation\nfrom all\ndeclared or just a selection.\n
\nFor instance if you have a mobile\napplication and - before user connected to the application -\nyou want\nto let him choose to use the default UI (JSF) or the dedicated\nmobile UI.\n
", "extensionPoints": [ { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.application.definition.service", "descriptors": [ "org.nuxeo.ecm.mobile.ApplicationDefinitionDescriptor" ], "documentation": "\n In this extension you will contribute a new application entry that\n will be caracterized by a name, a baseURL of the application, a relative\n path to a dedicate login page and logout page, a request handler to select the type\n of request that must be redirect to this application and a order.\n\n Let see that:\n\n\n \n site/app1 \n /auth/login \n /auth/logout \n MyRequestHandler \n \n\n\n\n Here we define a new application named \"app1\". We define the base\n url of the application.\n So the full URL to reach it will be:\n \n server/${NuxeoContextPath}/site/app1.\n \n\n This seems to be, here, a webengine application. And logout page\n will be reachable here:\n \n server/${NuxeoContextPath}/site/app1/auth/login\n \n\n We have the same things with the logout page. The last but not\n least, the RequestHandler will be the object called to check\n if the request is a candidate to be redirected to the application.\n This handler must implements the org.nuxeo.ecm.mobile.handler.RequestHandler\n interface.\n\n You just have to implement, in fact this following method:\n \n /**\n * return true if the request is a candidate for the Application\n described into\n * the {@code ApplicationDescriptor}.\n */\n public boolean isRequestRedirectedToApplication(\n HttpServletRequest request);\n \n\n\n If this method return true for a given request, the browser will be redirected to\n the baseURL of the application with the initial uri into the\n ApplicationConstant#TARGET_URL_PARAMETER parameter into the redirected URL.\n\n You can for instance return true each time you detect that browser user\n agent is a mobile browser (you have the MobileRequestHandler implementing that),\n Like that all mobile browser will be redirected to app1.\n\n For instance if you call\n http://server/nuxeo/nxdoc/default/1239134098234023@view_documents\n is\n called and the handler return true, you be redirected to:\n\n \n http://server/nuxeo/site/app1?targetURL=%2Fnuxeo%2Fnxdoc%2Fdefault%2F1239134098234023%40view_documents\n \n\n\n For the login and logout page, becareful to unprotect resources\n you are using to generate the page.\n The login page must post to the \"${baseURL}/nxstartup.faces\"\", \n login module will do the authentication stuff and will redirect \n to the initial url request for you. baseURL is by default /nuxeo, \n in the webengine context you can use a relative path (becareful of reverse proxy)\n I mean if you use jquery library from here:\n \n http://server/nuxeo/scripts/jquery.js\n \n\n As you will be redirected to app1 this will not work. So if you do\n that think to contribute to the\n PluggableAuthenticationService to declare your open URL for your external resources, this service\n will also skip the redirect.\n\n Order of the application will let you organize the call order of handlers by the service.\n\n Last thing, becareful to have an efficient handler, as this code can be\n called many times. If you have handler that called a webservice, that is long, etc. This\n is a bad idea.\n\n About the login page you just have to create into the target url\n describe into your contribution a form that post user_name and user_password value to the same page.\n Authenticator of the service will do the authentication and will after redirect to the target URL.\n\n You can optionally aslo describe the base URL of resources of your application like that:\n \n \n site/app1 \n /auth/login \n /auth/logout \n myHandler \n \n /site/skin/app1 \n /nuxeo/resources \n \n \n\n\n Like that request to resources of your application will not be redirected to the base url.\n If your resources are under the base url of your application, this parameter is not needed.\n\n\n You have already different RequestHandler implemented (Mobile and Anonymous handler)\n\n \n",
"documentationHtml": "\nIn this extension you will contribute a new application entry that\nwill be caracterized by a name, a baseURL of the application, a relative\npath to a dedicate login page and logout page, a request handler to select the type\nof request that must be redirect to this application and a order.\n
\nLet see that:\n
\n
<application disable="false" name="app1" order="10">\n <applicationRelativePath>site/app1</applicationRelativePath>\n <loginPage>/auth/login</loginPage>\n <logoutPage>/auth/logout</logoutPage>\n <requestHandlerName>MyRequestHandler</requestHandlerName>\n </application>\n\nHere we define a new application named "app1". We define the base\nurl of the application.\nSo the full URL to reach it will be:\n
server/${NuxeoContextPath}/site/app1.\n\nThis seems to be, here, a webengine application. And logout page\nwill be reachable here:\n
server/${NuxeoContextPath}/site/app1/auth/login\n\nWe have the same things with the logout page. The last but not\nleast, the RequestHandler will be the object called to check\nif the request is a candidate to be redirected to the application.\nThis handler must implements the org.nuxeo.ecm.mobile.handler.RequestHandler\ninterface.\n
\nYou just have to implement, in fact this following method:\n
/**\n * return true if the request is a candidate for the Application\n described into\n * the {@code ApplicationDescriptor}.\n */\n public boolean isRequestRedirectedToApplication(\n HttpServletRequest request);\n\nIf this method return true for a given request, the browser will be redirected to\nthe baseURL of the application with the initial uri into the\nApplicationConstant#TARGET_URL_PARAMETER parameter into the redirected URL.\n
\nYou can for instance return true each time you detect that browser user\nagent is a mobile browser (you have the MobileRequestHandler implementing that),\nLike that all mobile browser will be redirected to app1.\n
\nFor instance if you call\nhttp://server/nuxeo/nxdoc/default/1239134098234023@view_documents\nis\ncalled and the handler return true, you be redirected to:\n
\n
http://server/nuxeo/site/app1?targetURL=%2Fnuxeo%2Fnxdoc%2Fdefault%2F1239134098234023%40view_documents\n\nFor the login and logout page, becareful to unprotect resources\nyou are using to generate the page.\nThe login page must post to the "${baseURL}/nxstartup.faces"",\nlogin module will do the authentication stuff and will redirect\nto the initial url request for you. baseURL is by default /nuxeo,\nin the webengine context you can use a relative path (becareful of reverse proxy)\nI mean if you use jquery library from here:\n
http://server/nuxeo/scripts/jquery.js\n\nAs you will be redirected to app1 this will not work. So if you do\nthat think to contribute to the\nPluggableAuthenticationService to declare your open URL for your external resources, this service\nwill also skip the redirect.\n
\nOrder of the application will let you organize the call order of handlers by the service.\n
\nLast thing, becareful to have an efficient handler, as this code can be\ncalled many times. If you have handler that called a webservice, that is long, etc. This\nis a bad idea.\n
\nAbout the login page you just have to create into the target url\ndescribe into your contribution a form that post user_name and user_password value to the same page.\nAuthenticator of the service will do the authentication and will after redirect to the target URL.\n
\nYou can optionally aslo describe the base URL of resources of your application like that:\n
<application disable="false" name="app1" order="10">\n <applicationRelativePath>site/app1</applicationRelativePath>\n <loginPage>/auth/login</loginPage>\n <logoutPage>/auth/logout</logoutPage>\n <requestHandlerName>myHandler</requestHandlerName>\n <resources>\n <resourcesBaseURL>/site/skin/app1</resourcesBaseURL>\n <resourcesBaseURL>/nuxeo/resources</resourcesBaseURL>\n </resources>\n </application>\n\nLike that request to resources of your application will not be redirected to the base url.\nIf your resources are under the base url of your application, this parameter is not needed.\n
\nYou have already different RequestHandler implemented (Mobile and Anonymous handler)\n
", "hierarchyPath": "/grp:org.nuxeo.ecm.mobile/nuxeo-application-definition/org.nuxeo.ecm.application.definition.service/ExtensionPoints/org.nuxeo.ecm.application.definition.service--applicationDefinition", "id": "org.nuxeo.ecm.application.definition.service--applicationDefinition", "label": "applicationDefinition (org.nuxeo.ecm.application.definition.service)", "name": "applicationDefinition", "version": "7.10" }, { "@type": "NXExtensionPoint", "componentId": "org.nuxeo.ecm.application.definition.service", "descriptors": [ "org.nuxeo.ecm.mobile.RequestHandlerDescriptor" ], "documentation": "\n In this extension point you will contribute the definition of your handler that implements\n the logic of redirection to your application. Interface to implement for this requestHandler\n is just for a given request do Nuxeo will redirect the user to the given application.\n\n\n \n org.nuxeo.ecm.mobile.handler.MobileWithCookieRequestHandler \n \n (.*)/nxfile/(.*)|(.*)/nxbigfile/(.*) \n \n \n\n\n And so you will have to implement the interface given by org.nuxeo.ecm.mobile.handler.RequestHandler.\n Means just to implement this following methods:\n \n public RequestHandler init(Map<String, String> properties);\n\n public boolean isRequestRedirectedToApplication(HttpServletRequest request);\n\n public boolean isRequestRedirectedToApplicationLoginForm(HttpServletRequest request);\n \n",
"documentationHtml": "\nIn this extension point you will contribute the definition of your handler that implements\nthe logic of redirection to your application. Interface to implement for this requestHandler\nis just for a given request do Nuxeo will redirect the user to the given application.\n
\n
<requestHandler disable="false" name="MobileWithCookieRequestHandler">\n <implementation>org.nuxeo.ecm.mobile.handler.MobileWithCookieRequestHandler</implementation>\n <properties>\n <property name="skippedURLPattern">(.*)/nxfile/(.*)|(.*)/nxbigfile/(.*)</property>\n </properties>\n </requestHandler>\n\nAnd so you will have to implement the interface given by org.nuxeo.ecm.mobile.handler.RequestHandler.\nMeans just to implement this following methods:\n
public RequestHandler init(Map<String, String> properties);\n\n public boolean isRequestRedirectedToApplication(HttpServletRequest request);\n\n public boolean isRequestRedirectedToApplicationLoginForm(HttpServletRequest request);\n\n \n site/app1 \n /auth/login \n /auth/logout \n MyRequestHandler \n \n \n\n Here we define a new application named \"app1\". We define the base\n url of the application.\n So the full URL to reach it will be:\n \n server/${NuxeoContextPath}/site/app1.\n \n This seems to be, here, a webengine application. And logout page\n will be reachable here:\n \n server/${NuxeoContextPath}/site/app1/auth/login\n \n We have the same things with the logout page. The last but not\n least, the RequestHandler will be the object called to check\n if the request is a candidate to be redirected to the application.\n This handler must implements the org.nuxeo.ecm.mobile.handler.RequestHandler\n interface.\n\n You just have to implement, in fact this following method:\n \n /**\n * return true if the request is a candidate for the Application\n described into\n * the {@code ApplicationDescriptor}.\n */\n public boolean isRequestRedirectedToApplication(\n HttpServletRequest request);\n \n\n If this method return true for a given request, the browser will be redirected to\n the baseURL of the application with the initial uri into the\n ApplicationConstant#TARGET_URL_PARAMETER parameter into the redirected URL.\n\n You can for instance return true each time you detect that browser user\n agent is a mobile browser (you have the MobileRequestHandler implementing that),\n Like that all mobile browser will be redirected to app1.\n\n For instance if you call\n http://server/nuxeo/nxdoc/default/1239134098234023@view_documents\n is\n called and the handler return true, you be redirected to:\n\n \n http://server/nuxeo/site/app1?targetURL=%2Fnuxeo%2Fnxdoc%2Fdefault%2F1239134098234023%40view_documents\n \n\n For the login and logout page, becareful to unprotect resources\n you are using to generate the page.\n The login page must post to the \"${baseURL}/nxstartup.faces\"\", \n login module will do the authentication stuff and will redirect \n to the initial url request for you. baseURL is by default /nuxeo, \n in the webengine context you can use a relative path (becareful of reverse proxy)\n I mean if you use jquery library from here:\n \n http://server/nuxeo/scripts/jquery.js\n \n As you will be redirected to app1 this will not work. So if you do\n that think to contribute to the\n PluggableAuthenticationService to declare your open URL for your external resources, this service\n will also skip the redirect.\n\n Order of the application will let you organize the call order of handlers by the service.\n\n Last thing, becareful to have an efficient handler, as this code can be\n called many times. If you have handler that called a webservice, that is long, etc. This\n is a bad idea.\n\n About the login page you just have to create into the target url\n describe into your contribution a form that post user_name and user_password value to the same page.\n Authenticator of the service will do the authentication and will after redirect to the target URL.\n\n You can optionally aslo describe the base URL of resources of your application like that:\n \n \n site/app1 \n /auth/login \n /auth/logout \n myHandler \n \n /site/skin/app1 \n /nuxeo/resources \n \n \n \n Like that request to resources of your application will not be redirected to the base url.\n If your resources are under the base url of your application, this parameter is not needed.\n\n\n You have already different RequestHandler implemented (Mobile and Anonymous handler)\n\n \n \n org.nuxeo.ecm.mobile.handler.MobileWithCookieRequestHandler \n \n (.*)/nxfile/(.*)|(.*)/nxbigfile/(.*) \n \n \n \n And so you will have to implement the interface given by org.nuxeo.ecm.mobile.handler.RequestHandler.\n Means just to implement this following methods:\n \n public RequestHandler init(Map<String, String> properties);\n\n public boolean isRequestRedirectedToApplication(HttpServletRequest request);\n\n public boolean isRequestRedirectedToApplicationLoginForm(HttpServletRequest request);\n \n