Bug 794466 (JBEPP-1506)

Summary: LOGIN_URL contains a line break in CAS integration document
Product: [JBoss] JBoss Enterprise Portal Platform 5 Reporter: Toshiya Kobayashi <tkobayas>
Component: DocumentationAssignee: mmurray
Status: VERIFIED --- QA Contact:
Severity: high Docs Contact:
Priority: high    
Version: 5.2.0.GACC: epp-bugs, mposolda
Target Milestone: ---   
Target Release: TBD_EPP_5   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/JBEPP-1506
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
A problem was identified with an important file path in the "Redirect to CAS" procedure of the Reference Guide. A break in the LOGIN_URL parameter value caused issues when the code sample was copied, causing the code sample to be invalid when used verbatim in actual configuration. The LOGIN_URL value has been reformatted to a single line, which removes the space and corrects the originally reported issue.
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Toshiya Kobayashi 2012-02-08 06:37:30 UTC
Help Desk Ticket Reference: https://c.na7.visual.force.com/apex/Case_View?id=500A00000090PpC&sfdc.override=1
project_key: JBEPP

In CAS integration documentation, 

http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.2/html-single/Reference_Guide/index.html#sect-Reference_Guide-SSO_Single_Sign_On_-Central_Authentication_Service

"Procedure 17.10. Redirect to CAS"
{code:xml}
<filter>
    <filter-name>LoginRedirectFilter</filter-name>
        <filter-class>org.gatein.sso.agent.filter.LoginRedirectFilter</filter-class>
        <init-param>                                 
        <!-- This should point to your SSO authentication server -->
          <param-name>LOGIN_URL</param-name>   
          <!-- If casRenewTicket param value of InitiateLoginServlet is:  not specified or false -->
          <param-value>http://localhost:8888/cas/login?service=
          http://localhost:8080/portal/initiatessologin</param-value>
{code}

The value of LOGIN_URL contains a line break. It will cause redirection failure when you use single-sign-on.
Just writing it in one line is fine.
{code:xml}
          <param-value>http://localhost:8888/cas/login?service=http://localhost:8080/portal/initiatessologin</param-value>
{code}

Community doc doesn't have the problem.

http://docs.jboss.org/gatein/portal/3.2.0-CR01/reference-guide/en-US/html_single/#sect-Reference_Guide-Single_Sign_On-CAS_Central_Authentication_Service

Comment 1 Jared MORGAN 2012-03-19 00:40:16 UTC
I've removed the spacing, however note that the spacing was there to display the code sample nicely. 

Display issues will likely result from removing the spacing.

Comment 4 Jared MORGAN 2012-03-23 01:10:15 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
A problem was identified with an important file path in the "Redirect to CAS" procedure of the Reference Guide. A break in the LOGIN_URL parameter value caused issues when the code sample was copied, causing the code sample to be invalid when used verbatim in actual configuration. The LOGIN_URL value has been reformatted to a single line, which removes the space and corrects the originally reported issue.