{"id":24583,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/ucreauthorizeuser-1\/"},"modified":"2024-02-15T14:53:34","modified_gmt":"2024-02-15T22:53:34","slug":"ucreauthorizeuser-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/","title":{"rendered":"ucReauthorizeUser"},"content":{"rendered":"<h3>\n\tPurpose<\/h3>\n<p>ucReauthorizeUser used to redirect user to a reauthentication server, if this is directed by the workflow of processing an issue.<\/p>\n<h3>\n\tApplies To<\/h3>\n<p>User Authentication Methods<\/p>\n<h3>\n\tSignature<\/h3>\n<pre class=\"code\">\r\n<code>public boolean ucReauthorizeUser ( \r\n      HttpServletRequest request, \r\n      HttpServletResponse response,\r\n      ProblemFormParam pfp, \r\n      SesameSession session,\r\n      int sshState )<\/code>\r\n<\/pre>\n<h3>\n\tNotes<\/h3>\n<p>It is currently used when the user\u2019s permissions in an SSO environment are not sufficient to perform an action. This routine can be used to reauthenticate the user with a different permission set.<\/p>\n<h3>\n\tExample<\/h3>\n<pre class=\"code\">\r\n<code> public boolean ucReauthorizeUser(\r\n                HttpServletRequest request, \r\n                HttpServletResponse response,\r\n                ProblemFormParam pfp, \r\n                SesameSession session,\r\n                int sshState) throws Exception {\r\n\r\n        \/\/ set up a signature handler object\r\n        StatusSignatureHandler ssh;\r\n\r\n        \/\/ first, is there a CHANGE: state var with one of the key fields?\r\n        String sv = pfp.getString(\"stateVar\");\r\n\r\n        \/\/ Log the state var\r\n        Z.log.writeToLog(Z.log.DEBUG, \"STATEVAR IN doReauth(): \" + sv);\r\n\r\n        \/\/ if you change this you also must change the list of esignature fields below.\r\n        String fieldPat = \"^CHANGE:\" +\r\n            \"(P_RISK_SIG_REQUIRED)|\" +\r\n            \"(P_GOVT_DCSNTREE_SIG_REQUIRED)|\" +\r\n            \"(P_GOVT_DSCNTREE_RVW_SIG_REQ)|\" +\r\n            \"(P_GOVT_MDR_DEC_SIG_REQ)|\" +\r\n            \"(P_GOVT_REVIEW_SIG_REQ)|\" +\r\n            \"(P_GOVT_OTH_DEC_SIG_REQ)|\" +\r\n            \"(P_GOVT_AUS_DEC_SIG_REQ)|\" +\r\n            \"(P_GOVT_CAN_DEC_SIG_REQ)|\" +\r\n            \"(P_GOVT_VSR_DEC_SIG_REQ)|\" +\r\n            \"(P_GOVT_VIGIL_REV_SIG_REQUIRED)|\" +\r\n            \"(P_GOVT_MHLW_DEC_SIG_REQUIRED)|\" +\r\n            \"(P_GOVT_MHLW_DEC_REV_SIG_REQ)\" +\r\n            \"_\\\\d+$\";\r\n\r\n        Regex fieldParser = new Regex(fieldPat);\r\n        boolean reauthFieldExists = fieldParser.search(sv.toUpperCase());\r\n\r\n        \/\/ Is this refresh fired by a reauth field?\r\n        Z.log.writeToLog(Z.log.DEBUG,\r\n               \"REFRESH FIRED BY A REAUTH FIELD: \" + reauthFieldExists);\r\n\r\n        \/\/ if no reauthFieldExists, there is no reason to do anything else, we\r\n        \/\/ can return \"false\" immediately.\r\n        if (!reauthFieldExists) {\r\n            return false;\r\n        }\r\n\r\n        \/\/ next, is there a p_cached_req parameter?\r\n        String cr = pfp.getString(\"CACHED_REQ\");\r\n        boolean crFieldExists = TextManager.isStringVisible(cr);\r\n\r\n        \/\/ did we get the cached request parameter?\r\n        Z.log.writeToLog(Z.log.DEBUG, \r\n               \"CACHED REQUEST PARAMETER EXISTS: \" + crFieldExists);\r\n        Z.log.writeToLog(Z.log.DEBUG, \r\n               \"CACEHD REQUEST PARAMETER: \" + cr);\r\n\r\n        \/\/ if reauthFieldExists and no crFieldExists, we have not yet been\r\n        \/\/ through reauthentication. we must create the ssh object, redirect to\r\n        \/\/ the SSO server, and return a true (we are doing reauth). Otherwise,\r\n        \/\/ reauthField and crField both exist, get cached ssh, then check the\r\n        \/\/ SSO authorization status.\r\n        if (reauthFieldExists &amp;&amp; !crFieldExists) {\r\n\r\n            \/\/ log that we are making a new StatusSignatureHandler\r\n            Z.log.writeToLog(Z.log.DEBUG, \"MAKING NEW StatusSignatureHandler.\");\r\n\r\n            ssh = new StatusSignatureHandler(request, session, sshState);\r\n            if (TextManager.isStringVisible(sv)) {\r\n                ssh.setStateVar(sv);\r\n            }\r\n\r\n            \/\/ ssh reauth status before cache\r\n            Z.log.writeToLog(Z.log.DEBUG, \r\n                \"SSH REAUTH STATUS BEFORE CACHE: \" + ssh.isReauthorizedCheck(session));\r\n\r\n            \/\/ cache ssh in session\r\n            ssh.cache();\r\n\r\n            \/\/ ssh reauth status after cache\r\n            Z.log.writeToLog(Z.log.DEBUG, \r\n                \"SSH REAUTH STATUS AFTER CACHE: \" + ssh.isReauthorizedCheck(session));\r\n        } else {\r\n\r\n            \/\/ we are retrieving a cached ssh\r\n            Z.log.writeToLog(Z.log.DEBUG, \r\n                  \"GETTING CACHED StatusSignatureHandler.\");\r\n\r\n            ssh = StatusSignatureHandler.getCached(cr, session);\r\n\r\n            \/\/ check the cached ssh for reauthorization\r\n            \/\/ if we are not using SSO, just reauthorize\r\n            \/\/ them. otherwise, check the SSO reauth.\r\n            boolean sso = \"YES\".equalsIgnoreCase(\r\n                       Z.appDefaults.getAttribute(\"SSO_STATE\"));\r\n\r\n            \/\/ log sso state\r\n            Z.log.writeToLog(Z.log.DEBUG, \"SSO_STATE IS ON: \" + sso);\r\n\r\n            if (!sso) {\r\n                \/\/ log what we do with respect to SSO\r\n                Z.log.writeToLog(Z.log.DEBUG, \"SSO NOT ON, REAUTHORIZING.\");\r\n\r\n                ssh.reauthorize();\r\n            } else if (com.extraview.presentation.security.LoginDisplay.\r\n                           doSSOReAuthorization(request)) {\r\n                \/\/ log what we do with respect to SSO\r\n                Z.log.writeToLog(Z.log.DEBUG, \"SSO ON, \r\n                      doSSOReAuthorization PASSED, REATHORIZING.\");\r\n\r\n                ssh.reauthorize();\r\n            } else {\r\n                \/\/ log what we do with respect to SSO\r\n                Z.log.writeToLog(Z.log.DEBUG, \r\n                      \"SSO ON, doSSOReAuthorization FAILED, NOT REATHORIZING.\");\r\n            }\r\n        }\r\n\r\n        \/\/ Log wheter or not we are reauthorized\r\n        Z.log.writeToLog(Z.log.DEBUG,\r\n               \"SSH SAYS WE ARE REAUTHORIZED: \" + ssh.isReauthorizedCheck(session));\r\n\r\n        \/\/ if we are reauthorized, do NOT redirect and return a status of false,\r\n        \/\/ otherwise redirect and return a status of true (for redirected).\r\n        if (ssh.isReauthorized(session)) {\r\n            return false;\r\n        } else {\r\n\r\n            String reloginUrl = ssh.reloginUrl();\r\n\r\n            \/\/ log reloginUrl\r\n            Z.log.writeToLog(Z.log.DEBUG, \r\n                  \"REAUTH URL WITH TARGET IMMEDIATELY BEFORE REDIRECTING: \" \r\n                 + reloginUrl);\r\n\r\n            response.sendRedirect(reloginUrl);\r\n            return true;\r\n        }\r\n    }<\/code>\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Purpose ucReauthorizeUser used to redirect user to a reauthentication server, if this is directed by the workflow of processing an issue. Applies To User Authentication Methods Signature public boolean ucReauthorizeUser ( HttpServletRequest request, HttpServletResponse response, ProblemFormParam pfp, SesameSession session, int sshState ) Notes It is currently used when the user\u2019s permissions in an SSO environment&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24510,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24583","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>ucReauthorizeUser - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"ucReauthorizeUser - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Purpose ucReauthorizeUser used to redirect user to a reauthentication server, if this is directed by the workflow of processing an issue. Applies To User Authentication Methods Signature public boolean ucReauthorizeUser ( HttpServletRequest request, HttpServletResponse response, ProblemFormParam pfp, SesameSession session, int sshState ) Notes It is currently used when the user\u2019s permissions in an SSO environment...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/\",\"name\":\"ucReauthorizeUser - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"User Custom Guide\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Java Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"User Custom Methods\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"ucReauthorizeUser\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"ucReauthorizeUser - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/","og_locale":"en_US","og_type":"article","og_title":"ucReauthorizeUser - Product Documentation","og_description":"Purpose ucReauthorizeUser used to redirect user to a reauthentication server, if this is directed by the workflow of processing an issue. Applies To User Authentication Methods Signature public boolean ucReauthorizeUser ( HttpServletRequest request, HttpServletResponse response, ProblemFormParam pfp, SesameSession session, int sshState ) Notes It is currently used when the user\u2019s permissions in an SSO environment...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/","name":"ucReauthorizeUser - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucreauthorizeuser-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"User Custom Guide","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/"},{"@type":"ListItem","position":4,"name":"Java Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/"},{"@type":"ListItem","position":5,"name":"User Custom Methods","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/"},{"@type":"ListItem","position":6,"name":"ucReauthorizeUser"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24583","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24583"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24583\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24510"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24583"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}