org.ikasan.connector.basefiletransfer.net
Class BaseFileTransferUtils

java.lang.Object
  org.ikasan.connector.basefiletransfer.net.BaseFileTransferUtils

public class BaseFileTransferUtils
extends java.lang.Object

A utility class for File Transfers

Author:

Ikasan Development Team

Field Summary

static java.lang.String

UTF8 UTF-8 encoding

Constructor Summary

BaseFileTransferUtils()

Method Summary

static BaseFileTransferMappedRecord	createBaseFileTransferMappedRecord(java.net.URI uri, java.io.ByteArrayOutputStream output) Creates an BaseFileTransferMappedRecord from a ByteArrayOutputStream Checksum is calculated automatically by the DefaultPayload class
boolean	fileFilter(java.lang.String patternString, java.lang.String filename) Return true if the filename matches the filter
java.util.ArrayList<ClientListEntry>	filterFiles(java.util.ArrayList<ClientListEntry> files, java.util.ArrayList<ClientFilter> filters) Return a filtered List of ClientListEntries
static java.util.List<ClientListEntry>	filterList(java.util.List<ClientListEntry> list, java.util.List<ClientPolarisedFilter> filters) This method accepts a list of ClientListEntry objects, a list of ClientFilter and applies the filters the entries
static void	findParents(java.io.File file, java.util.List<java.io.File> parents) Find the parents of this file
java.util.ArrayList<ClientListEntry>	matchFiles(java.lang.String patternString, java.util.ArrayList<ClientListEntry> fileList) By default case sensitive and based on US ASCII characters
static java.lang.String	stringDecoder(java.lang.String string, java.nio.charset.Charset charset) Decodes the bytes in a String of a given Charset, into Unicode (i.e.
static java.lang.String	stringEncoder(java.lang.String string) As stringEncoder(String string, Charset charset) but defaults to UTF-8
static java.lang.String	stringEncoder(java.lang.String string, java.nio.charset.Charset charset) Encodes the bytes of a Unicode String to a given Charset characters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UTF8

public static final java.lang.String UTF8

UTF-8 encoding

See Also:

Constant Field Values

Constructor Detail

BaseFileTransferUtils

public BaseFileTransferUtils()

Method Detail

fileFilter

public boolean fileFilter(java.lang.String patternString,
                          java.lang.String filename)

Return true if the filename matches the filter

Parameters:

patternString -

filename -

Returns:

true if the file matches the filter else false

filterFiles

public java.util.ArrayList<ClientListEntry> filterFiles(java.util.ArrayList<ClientListEntry> files,
                                                        java.util.ArrayList<ClientFilter> filters)

Return a filtered List of ClientListEntries

Parameters:

files -

filters -

Returns:

List of ClientListEntries

matchFiles

public java.util.ArrayList<ClientListEntry> matchFiles(java.lang.String patternString,
                                                       java.util.ArrayList<ClientListEntry> fileList)

By default case sensitive and based on US ASCII characters

Parameters:

patternString -

fileList -

Returns:

List of ClientListEntries

stringEncoder

public static java.lang.String stringEncoder(java.lang.String string,
                                             java.nio.charset.Charset charset)

Encodes the bytes of a Unicode String to a given Charset characters. Expected Charset values can be:

• US-ASCII
• ISO-8859-1
• UTF-8
• UTF-16BE
• UTF-16LE
• UTF-16

Parameters:

string - The Unicode (UTF-8) String to encode.

charset - The Charset in which to encode the input String.

Returns:

A representation of the input String in the Charset provided.

stringEncoder

public static java.lang.String stringEncoder(java.lang.String string)

As stringEncoder(String string, Charset charset) but defaults to UTF-8

Parameters:

string -

Returns:

encoded string

stringDecoder

public static java.lang.String stringDecoder(java.lang.String string,
                                             java.nio.charset.Charset charset)

Decodes the bytes in a String of a given Charset, into Unicode (i.e. UTF-8) characters. Expected Charset values can be:

• US-ASCII
• ISO-8859-1
• UTF-8
• UTF-16BE
• UTF-16LE
• UTF-16

Parameters:

string - The String to decode to Unicode.

charset - The Charset of the String to decode.

Returns:

A Unicode representation of the input String.

filterList

public static java.util.List<ClientListEntry> filterList(java.util.List<ClientListEntry> list,
                                                         java.util.List<ClientPolarisedFilter> filters)

This method accepts a list of ClientListEntry objects, a list of ClientFilter and applies the filters the entries

Parameters:

list - The ClientListEntry list to filter

filters - The ClientFilters to apply on the list

Returns:

The filtered list of ClientListEntries

findParents

public static void findParents(java.io.File file,
                               java.util.List<java.io.File> parents)

Find the parents of this file

Parameters:

file -

parents -

createBaseFileTransferMappedRecord

public static BaseFileTransferMappedRecord createBaseFileTransferMappedRecord(java.net.URI uri,
                                                                              java.io.ByteArrayOutputStream output)

Creates an BaseFileTransferMappedRecord from a ByteArrayOutputStream Checksum is calculated automatically by the DefaultPayload class

Parameters:

uri -

output -

Returns:

BaseFileTransferMappedRecord