FileEventGenChannelConfiguration Class

com.bea.wli.management.configuration
FileEventGenChannelConfiguration Class

public class FileEventGenChannelConfiguration

    extends Object
    implements Serializable

Represents a channel rule for a File Event Generator.

Rule Fields:

  • directory - directory to scan
  • scanSubdirs - scan subdirs or not
  • filePattern - pattern of file to match

    Other fields:

    Related Topics

    FileEventGenConfigurationMBean


    Hierarchy
    Object
      FileEventGenChannelConfiguration
    All Implemented Interfaces

    Serializable

    Field Summary

    public static final String
    _CHANNELTYPE_STRING
    String
    public static final String
    _CHANNELTYPE_XML
    String
    public static final String
    _DEFAULT_CHANNELTYPE
    String
    public static final String
    _DEFAULT_FILE_MASK
    String
    public static final int
    _DEFAULT_POLLING_INTERVAL
    int
    public static final String
    _POSTREAD_ARCHIVE
    String
    public static final String
    _POSTREAD_DELETE
    String
     

    Constructor Summary

    FileEventGenChannelConfiguration()

     

    Method Summary

    public String
    getArchiveDirectory()
    Get the archive-directory attribute
    public String
    getChannel()
    Get the name of the channel
    public String
    getChannelType()
    Get the is-xml attribute
    public String
    getComment()
    Get the comment attribute
    public String
    getEncoding()
    Get the encoding attribute
    public String
    getErrorDirectory()
    Get the error-directory attribute
    public String
    getFileDirectory()
    Get the fileDirectory Attribute
    public String
    getFilePattern()
    Get the file-pattern attribute
    public String
    getFtpHostName()
    Get the ftp-host-name attribute
    public String
    getFtpLocalDirectory()
    Get the ftp-local-directory attribute
    public String
    getFtpPassword()
    Get the ftp-user-password attribute
    public String
    getFtpPasswordAlias()
    Get the ftp-user-password-alias attribute
    public String
    getFtpUserName()
    Get the ftp-user-name attribute
    public boolean
    getPassByFileName()
    Get the pass-by-filename attribute
    public int
    getPollingInterval()
    Get the polling-interval attribute
    public String
    getPostRead()
    Get the post-read attribute
    public String
    getPublishAsUser()
    Get the publishAsUser attribute
    public int
    getReadLimit()
    Get the read-limit attribute
    public boolean
    getScanSubdirs()
    Get the scan-subdirectories attribute
    public boolean
    getSortByArrival()
    Get the sort-by-arrival attribute
    public void
    setArchiveDirectory(String archiveDirectory)
    Set the archiveDirectory attribute
    public void
    setChannel(String channel)
    Set the channel attribute
    public void
    setChannelType(String channelType)
    Set the isXML attribute
    public void
    setComment(String comment)
    Set the comment attribute
    public void
    setEncoding(String encoding)
    Set the encoding attribute
    public void
    setErrorDirectory(String errorDirectory)
    Set the errorDirectory attribute
    public void
    setFileDirectory(String fileDirectory)
    Set the fileDirectory attribute
    public void
    setFilePattern(String filePattern)
    Set the filePattern attribute
    public void
    setFtpHostName(String ftpHostName)
    Set the ftp-host-name attribute
    public void
    setFtpLocalDirectory(String ftpLocalDirectory)
    Set the ftp-local-directory attribute
    public void
    setFtpPassword(String ftpPassword)
    public void
    setFtpPasswordAlias(String ftpPasswordAlias)
    public void
    setFtpUserName(String ftpUserName)
    Set the ftp-user-name attribute
    public void
    setPassByFileName(boolean passByFileName)
    Set the passByFileName attribute
    public void
    setPollingInterval(int pollingInterval)
    Set the pollingInterval attribute
    public void
    setPostRead(String postRead)
    Set the postRead attribute
    public void
    setPublishAsUser(String publishAsUser)
    Set the publishAsUser attribute
    public void
    setReadLimit(int readLimit)
    Set the readLimit attribute
    public void
    setScanSubdirs(boolean scanSubdirs)
    Set the setScanSubdirs attribute
    public void
    setSortByArrival(boolean sortByArrival)
    Set the sortByArrival attribute
    public String
    toString()
    Returns a string representation of this channel
     
    Methods from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
       

    Field Detail

    _CHANNELTYPE_STRING

    public static final String _CHANNELTYPE_STRING
    


    _CHANNELTYPE_XML

    public static final String _CHANNELTYPE_XML
    


    _DEFAULT_CHANNELTYPE

    public static final String _DEFAULT_CHANNELTYPE
    


    _DEFAULT_FILE_MASK

    public static final String _DEFAULT_FILE_MASK
    


    _DEFAULT_POLLING_INTERVAL

    public static final int _DEFAULT_POLLING_INTERVAL
    


    _POSTREAD_ARCHIVE

    public static final String _POSTREAD_ARCHIVE
    


    _POSTREAD_DELETE

    public static final String _POSTREAD_DELETE
    

     

    Constructor Detail

    FileEventGenChannelConfiguration

    public FileEventGenChannelConfiguration()
    
     

    Method Detail

    getArchiveDirectory() Method

    public String getArchiveDirectory()
    
    Get the archive-directory attribute

    Returns

    archive-directory attribute

    getChannel() Method

    public String getChannel()
    
    Get the name of the channel

    Returns

    name of channel

    getChannelType() Method

    public String getChannelType()
    
    Get the is-xml attribute

    Returns

    is-xml attribute

    getComment() Method

    public String getComment()
    
    Get the comment attribute

    Returns

    comment attribute

    getEncoding() Method

    public String getEncoding()
    
    Get the encoding attribute

    Returns

    endcoding attribute

    getErrorDirectory() Method

    public String getErrorDirectory()
    
    Get the error-directory attribute

    Returns

    error-directory attribute

    getFileDirectory() Method

    public String getFileDirectory()
    
    Get the fileDirectory Attribute

    Returns

    fileDirectory attribute

    getFilePattern() Method

    public String getFilePattern()
    
    Get the file-pattern attribute

    Returns

    file-pattern attribute

    getFtpHostName() Method

    public String getFtpHostName()
    
    Get the ftp-host-name attribute

    Returns

    ftp-host-name attribute

    getFtpLocalDirectory() Method

    public String getFtpLocalDirectory()
    
    Get the ftp-local-directory attribute

    Returns

    ftp-local-directory attribute

    getFtpPassword() Method

    public String getFtpPassword()
    
    Get the ftp-user-password attribute

    Returns

    ftp-user-password attribute

    getFtpPasswordAlias() Method

    public String getFtpPasswordAlias()
    
    Get the ftp-user-password-alias attribute

    Returns

    ftp-user-password-alias attribute

    getFtpUserName() Method

    public String getFtpUserName()
    
    Get the ftp-user-name attribute

    Returns

    ftp-user-name attribute

    getPassByFileName() Method

    public boolean getPassByFileName()
    
    Get the pass-by-filename attribute

    Returns

    pass-by-filename attribute

    getPollingInterval() Method

    public int getPollingInterval()
    
    Get the polling-interval attribute

    Returns

    polling-interval attribute

    getPostRead() Method

    public String getPostRead()
    
    Get the post-read attribute

    Returns

    post-read attribute

    getPublishAsUser() Method

    public String getPublishAsUser()
    
    Get the publishAsUser attribute

    Returns

    publishAsUser attribute

    getReadLimit() Method

    public int getReadLimit()
    
    Get the read-limit attribute

    Returns

    read-limit attribute

    getScanSubdirs() Method

    public boolean getScanSubdirs()
    
    Get the scan-subdirectories attribute

    Returns

    scan-subdirectories attribute

    getSortByArrival() Method

    public boolean getSortByArrival()
    
    Get the sort-by-arrival attribute

    Returns

    sort-by-arrival attribute

    setArchiveDirectory(String) Method

    public void setArchiveDirectory(String archiveDirectory)
    
    Set the archiveDirectory attribute

    Parameters

    archiveDirectory
    specified the directory to be used for archiving files.

    setChannel(String) Method

    public void setChannel(String channel)
    
    Set the channel attribute

    Parameters

    channel
    the channel for the event generator

    setChannelType(String) Method

    public void setChannelType(String channelType)
    
    Set the isXML attribute

    Parameters

    channelType
    indicates whether the file type is XML or not.

    setComment(String) Method

    public void setComment(String comment)
    
    Set the comment attribute

    Parameters

    comment
    is a user comment.

    setEncoding(String) Method

    public void setEncoding(String encoding)
    
    Set the encoding attribute

    Parameters

    encoding
    character set encoding needed for String types.

    setErrorDirectory(String) Method

    public void setErrorDirectory(String errorDirectory)
    
    Set the errorDirectory attribute

    Parameters

    errorDirectory
    specified the directory to be used for files in error.

    setFileDirectory(String) Method

    public void setFileDirectory(String fileDirectory)
    
    Set the fileDirectory attribute

    Parameters

    fileDirectory
    the directory to be processed by the event generator

    setFilePattern(String) Method

    public void setFilePattern(String filePattern)
    
    Set the filePattern attribute

    Parameters

    filePattern
    the file pattern to be used to select files.

    setFtpHostName(String) Method

    public void setFtpHostName(String ftpHostName)
    
    Set the ftp-host-name attribute

    Parameters

    ftpHostName
    name of the ftp host

    setFtpLocalDirectory(String) Method

    public void setFtpLocalDirectory(String ftpLocalDirectory)
    
    Set the ftp-local-directory attribute

    Parameters

    ftpLocalDirectory
    local directory name to be used for ftp use.

    setFtpPassword(String) Method

    public void setFtpPassword(String ftpPassword)
    

    setFtpPasswordAlias(String) Method

    public void setFtpPasswordAlias(String ftpPasswordAlias)
    

    setFtpUserName(String) Method

    public void setFtpUserName(String ftpUserName)
    
    Set the ftp-user-name attribute

    Parameters

    ftpUserName
    name of the ftp user

    setPassByFileName(boolean) Method

    public void setPassByFileName(boolean passByFileName)
    
    Set the passByFileName attribute

    Parameters

    passByFileName
    indicates whether to publish the file name as opposed to the file content.

    setPollingInterval(int) Method

    public void setPollingInterval(int pollingInterval)
    
    Set the pollingInterval attribute

    Parameters

    pollingInterval
    indicates how often the directory to be scanned (in seconds).

    setPostRead(String) Method

    public void setPostRead(String postRead)
    
    Set the postRead attribute

    Parameters

    postRead
    specifies whether to delete or archive files after they are processed.

    setPublishAsUser(String) Method

    public void setPublishAsUser(String publishAsUser)
    
    Set the publishAsUser attribute

    Parameters

    publishAsUser
    property to set

    setReadLimit(int) Method

    public void setReadLimit(int readLimit)
    
    Set the readLimit attribute

    Parameters

    readLimit
    indicates the number of files to be processed per scan.

    setScanSubdirs(boolean) Method

    public void setScanSubdirs(boolean scanSubdirs)
    
    Set the setScanSubdirs attribute

    Parameters

    scanSubdirs
    indicates whether to scan subdirectories or not.

    setSortByArrival(boolean) Method

    public void setSortByArrival(boolean sortByArrival)
    
    Set the sortByArrival attribute

    Parameters

    sortByArrival
    indicates whether to process files in the arrival time order.

    toString() Method

    public String toString()
    
    Returns a string representation of this channel

    Overrides
    Object.toString()