Bug 778420 (SOA-903)

Summary: quickstart: security_basic - error in readme.txt
Product: [JBoss] JBoss Enterprise SOA Platform 4 Reporter: Burr Sutter <burr.sutter>
Component: Documentation, ExamplesAssignee: Jeff Yu <cyu>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: medium Docs Contact:
Priority: medium    
Version: 4.3 CR1CC: kconner
Target Milestone: ---   
Target Release: 4.3 GA   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-903
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-10-28 08:15:01 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Bug Depends On:    
Bug Blocks: 778505    
Attachments:
Description Flags
Screenshot-ServicesGuide.png none

Description Burr Sutter 2008-10-01 13:15:54 UTC
Date of First Response: 2008-10-06 05:18:57
project_key: SOA

The security_basic quickstart has a  very poor readme.txt. It does not explain the interesting areas of the quickstart and how it works overall.  

Also the HttpClient.java should be in the "test" sub-package.  It is presently in the same directory as the actions.

Comment 1 Jeff Yu 2008-10-06 04:38:08 UTC
Link: Added: This issue is a dependency of JBESB-2091


Comment 2 Jeff Yu 2008-10-06 09:18:57 UTC
It has been fixed by Revision: 23318 in JBoss ESB CP Branch. which was done by Dan. 

Comment 3 Len DiMaggio 2008-10-23 14:07:16 UTC
The HttpClient class is in the correct tree

[ldimaggi@ldimaggi security_basic]$ tree
.
|-- build.xml
|-- deployment.xml
|-- jbm-queue-service.xml
|-- jbmq-queue-service.xml
|-- jboss-esb.xml
|-- jbossesb-properties.xml
|-- jndi.properties
|-- juddi.properties
|-- lib
|-- listener.log
|-- log4j.xml
|-- publicKeyStore
|-- readme.txt
`-- src
    `-- org
        `-- jboss
            `-- soa
                `-- esb
                    `-- samples
                        `-- quickstart
                            `-- securitybasic
                                |-- MyListenerAction.java
                                `-- test
                                    |-- HttpClient.java
                                    `-- SendEsbMessage.java

10 directories, 15 files

And the readme file now contains:
What to look for in this quickstart
===================================
  # Security configuration
         <service category="Security" name="SimpleListenerSecured" description="Hello World">
            <security moduleName="messaging" rolesAllowed="esbrole"/>
        The security element declares that this service requires authentication to be executed and that the 
        authenticated users be a member in the role 'esbrole'. The role is determined by the JAAS login
        module being used, in this case by the 'messaging' module specified in login-config.xml.

  # src/org/jboss/soa/esb/samples/quickstart/securitybasic/test/HttpClient.java
        This is a JBossRemoting client that uses http to invoke the JBossRemoting gateway.

  # src/org/jboss/soa/esb/samples/quickstart/securitybasic/test/SendEsbMessage.java 
        This class uses the ServiceInvoker to invoke the ESB service directly, by-passing the gateway.
        You can see how an AuthenticationRequest is created then encrypted, and passed to the ESB
        by attaching the authentication request to the ESB Message object.

  # src/org/jboss/soa/esb/samples/quickstart/securitybasic/MyListenerAction.java 
        This ESB Action show how the currently autenticated JAAS Subject can be accessed:
        System.out.println("Subject in MyListenerAction : " + Subject.getSubject(AccessController.getContext()));

  # Please refer to the "Security" section of the ServiceGuide.pdf for more details on the security features of JBossESB.




Comment 4 Len DiMaggio 2008-10-23 14:11:02 UTC
But...

This line should be removed from the readme:

  # Please refer to the "Security" section of the ServiceGuide.pdf for more details on the security features of JBossESB.

As there is no "Security" section in the Service_Guide.pdf (or the admin guide or programmers' guide)



Comment 5 Kevin Conner 2008-10-23 16:03:29 UTC
The platform docs would appear to be out of sync with the project ones in that case.

Comment 6 Kevin Conner 2008-10-23 16:03:29 UTC
Attachment: Added: Screenshot-ServicesGuide.png


Comment 7 Len DiMaggio 2008-10-23 17:38:18 UTC
Link: Added: This issue is a dependency of SOA-978


Comment 8 Dana Mison 2008-10-27 01:38:52 UTC
Service Guide updated with missing content, included the Security Chapter.

Comment 9 Jeff Yu 2008-10-27 02:47:37 UTC
has been fixed by Darrin.

Comment 10 Lukáš Petrovický 2008-10-28 08:15:01 UTC
This is fixed indeed.