Bug 739915

Summary: Typo and clarification for 12.6.8 NotifyFTPList
Product: [JBoss] JBoss Enterprise SOA Platform 5 Reporter: Oliver Hörmann <oliver.hoermann>
Component: doc-ESB_Programmers_GuideAssignee: soa-docs <soa-docs>
Status: ASSIGNED --- QA Contact:
Severity: low Docs Contact:
Priority: unspecified    
Version: 5.2Keywords: Documentation
Target Milestone: ---   
Target Release: FUTURE   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
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:
Embargoed:

Description Oliver Hörmann 2011-09-20 12:30:35 UTC
Description of problem:
In chapter 12.6.8 the notifier NotifyFTPList is being described. The table column "child attributes" contains an typographic error.

- Attribute "deletelistFile" should be named "deleteListFile"
See source code NotifyFTPList.java:
            public NotifyFTPList(ConfigTree config)
                    throws NotificationException {
                super (config);
                ConfigTree ftpConfig = getFtpConfig();
                listFiles = ftpConfig.getBooleanAttribute("listFiles", false);
                deleteListFile = ftpConfig.getBooleanAttribute(
                        "deleteListFile", false);
            }


- Attribute "filename" is not used. The actual filenames contained in the lists are being used for the destination file names.
See source code NotifyFTPList.java:
            @Override
            protected File getFileToSend(Message message) {
                return (File) message.getBody().get(FILE_LOCATION);
            }

            @Override
            protected String getFileName(Message message)
                    throws NotificationException {
                File file = (File) message.getBody().get(FILE_LOCATION);
                if (file == null) {
                    throw new NotificationException(
                            "Could not find a file in the file location");
                }
                return file.getName();
            }

Version-Release number of selected component (if applicable):


How reproducible:
Every time.

Steps to Reproduce:
1.
Use the NotifyFTPList. Set attribute deletelistFile="true". Check that the listfile isn't deleted.
2.
Use the NotifyFTPList. Set attribute deleteListFile="true". Check that the listfile is deleted.

  
Actual results:


Expected results:


Additional info:
This documentation bug is also present in JBoss ESB 4.x.

Comment 1 Suz 2012-03-09 04:31:07 UTC
Have corrected this spelling error and removed the filename attribute.