ipworks
Class Netcode

java.lang.Object
  |
  +--ipworks.Netcode

public class Netcode

extends java.lang.Object

The NetCode bean can be used to encode or decode files or strings. UUEncode , MIME's Base64 Quoted-Printable , URL encoding formats, as well as secure hash functions such as MD5 and SHA1, are currently supported.

The encoding format is specified by the Format property. The binary data, or the name of the file containing binary data, is specified by the DecodedData property and the encoded data or filename is specified by the EncodedData property. The FileName property may be used to override the default file names or to specify a directory during uuencoding. After uudecoding, the FileName property contains the fully specified file name of the decoded file.

Understanding Encoding/Decoding

Most of mail systems use only 7 bits to transmit messages. A binary file such as an archive or a non-plain text formatted file produced from a text processor should be first encoded in 7 bit code before email transfer.

Decoding is the inverse process: creation of the original file from the encoded data. Encoded data is often split over several files because of the size limit placed on the email message. Each message is preceded by information about this splitting, as well as the mail header. NetCode supports this case in both directions:

- During encoding setting theMaxFileSizeconfig setting to the maximum size of a message body instructs NetCode to split the encoded data over several files. Multiple filenames can be specified by using question marks "?" (See the EncodedData property for more information).

- During decoding , the body messages can be saved in separate files named namexxx.ext where xxx is a numeral starting at 000 and ext is ".uue", ".b16", or ".q_p" according to Format . These multiple filenames should be given to EncodedData . While uudecoding, if theIntelliCodeconfiguration is set to True, NetCode tries to filter the data that doesn't belong to the pure uuencoded data (This may include mail headers).

Field Summary

static int	fmtBase64
static int	fmtHex
static int	fmtHMAC
static int	fmtHTML
static int	fmtJIS
static int	fmtMD5Hash
static int	fmtQP
static int	fmtSHA1Hash
static int	fmtURL
static int	fmtUUEncode
static int	fmtYEncode

Constructor Summary

Netcode()

Method Summary

void	addNetcodeEventListener(ipworks.NetcodeEventListener l)
java.lang.String	config(java.lang.String configurationString) Sets or retrieves a beanconfiguration setting.
void	decode() Decode string.
void	encode() Encode the data.
byte[]	getDecodedData() The decoded data.
java.lang.String	getDecodedFile() The filename of the decoded data.
byte[]	getEncodedData() The encoded data.
java.lang.String	getEncodedFile() Filename of the encoded data.
int	getFileCnt() Shows the number of encoded files the bean has read from or written into.
java.lang.String	getFileName() The destination filename for the encoded data.
int	getFormat() The type of encoding to be used.
java.lang.String	getMode() The UNIX-style filemode when uuencoding / uudecoding.
int	getProgressStep() Controls the granularity at which the Progress event is fired.
boolean	isOverwrite() Controls whether created file(s) should overwrite already existing file(s).
void	removeNetcodeEventListener(ipworks.NetcodeEventListener l)
void	resetData() Resets the values of all data and stream properties.
void	setDecodedData(byte[] decodedData) The decoded data.
void	setDecodedFile(java.lang.String decodedFile) The filename of the decoded data.
void	setEncodedData(byte[] encodedData) The encoded data.
void	setEncodedFile(java.lang.String encodedFile) Filename of the encoded data.
void	setFileName(java.lang.String fileName) The destination filename for the encoded data.
void	setFormat(int format) The type of encoding to be used.
void	setInputStream(java.io.InputStream inputStream) The input stream of data.
void	setMode(java.lang.String mode) The UNIX-style filemode when uuencoding / uudecoding.
void	setOutputStream(java.io.OutputStream outputStream) Encode to string.
void	setOverwrite(boolean overwrite) Controls whether created file(s) should overwrite already existing file(s).
void	setProgressStep(int progressStep) Controls the granularity at which the Progress event is fired.

Methods inherited from class java.lang.Object

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

Field Detail

fmtUUEncode

public static final int fmtUUEncode

See Also:

Constant Field Values

fmtBase64

public static final int fmtBase64

See Also:

Constant Field Values

fmtQP

public static final int fmtQP

See Also:

Constant Field Values

fmtURL

public static final int fmtURL

See Also:

Constant Field Values

fmtJIS

public static final int fmtJIS

See Also:

Constant Field Values

fmtYEncode

public static final int fmtYEncode

See Also:

Constant Field Values

fmtMD5Hash

public static final int fmtMD5Hash

See Also:

Constant Field Values

fmtSHA1Hash

public static final int fmtSHA1Hash

See Also:

Constant Field Values

fmtHex

public static final int fmtHex

See Also:

Constant Field Values

fmtHTML

public static final int fmtHTML

See Also:

Constant Field Values

fmtHMAC

public static final int fmtHMAC

See Also:

Constant Field Values

Constructor Detail

Netcode

public Netcode()

Method Detail

getDecodedData

public byte[] getDecodedData()

The decoded data.

When uuencoding, the value of FileName is the filename that will be written in EncodedData . If FileName is empty, an error will be thrown.

setDecodedData

public void setDecodedData(byte[] decodedData)
                    throws IPWorksException

The decoded data.

When uuencoding, the value of FileName is the filename that will be written in EncodedData . If FileName is empty, an error will be thrown.

IPWorksException

getDecodedFile

public java.lang.String getDecodedFile()

The filename of the decoded data.

When uuencoding, the value of FileName is the filename that will be written in EncodedData . If FileName is empty, the value of the DecodedFile property is taken, if a valid file has been specified. It is recommended that EncodedData contains the full path and FileName contains only the file name so that no problems occur while uudecoding in a foreign system.

When decoding, the bean tries to generate the name for the created file in the following order: DecodedFile , FileName , or when the format is UUEncode, the specified filename in the uuencoded data itself. If DecodedFile or FileName end with a backslash "\\" they are interpreted as directories and the bean tries to create the given filename in this directory. If this is the case, FileName shows the name of the created file.

setDecodedFile

public void setDecodedFile(java.lang.String decodedFile)
                    throws IPWorksException

The filename of the decoded data.

When uuencoding, the value of FileName is the filename that will be written in EncodedData . If FileName is empty, the value of the DecodedFile property is taken, if a valid file has been specified. It is recommended that EncodedData contains the full path and FileName contains only the file name so that no problems occur while uudecoding in a foreign system.

When decoding, the bean tries to generate the name for the created file in the following order: DecodedFile , FileName , or when the format is UUEncode, the specified filename in the uuencoded data itself. If DecodedFile or FileName end with a backslash "\\" they are interpreted as directories and the bean tries to create the given filename in this directory. If this is the case, FileName shows the name of the created file.

IPWorksException

getEncodedData

public byte[] getEncodedData()

The encoded data.

The data that has either been encoded or is set to be decoded.

setEncodedData

public void setEncodedData(byte[] encodedData)
                    throws IPWorksException

The encoded data.

The data that has either been encoded or is set to be decoded.

IPWorksException

getEncodedFile

public java.lang.String getEncodedFile()

Filename of the encoded data.

If the encoded data is spread over several files, the filenames are passed to EncodedFile in the form name? . Question marks "?" are expanded to numerals starting with 0. The filenames should exist as path\\file000.ext and passed to EncodedFile in the form name??? . Question marks "?" are expanded to numerals starting with 000 (the number of zeros "0" equals that of question marks "?").

The bean appends the extension ".uue", ".b16", or ".q_p" depending on Format immediately after the generated numbers. FileCnt contains the number of encoded files.

See also the Format property,IntelliCodeconfig setting, and theMaxFileSizeconfig setting when working with multiple files.

setEncodedFile

public void setEncodedFile(java.lang.String encodedFile)
                    throws IPWorksException

Filename of the encoded data.

If the encoded data is spread over several files, the filenames are passed to EncodedFile in the form name? . Question marks "?" are expanded to numerals starting with 0. The filenames should exist as path\\file000.ext and passed to EncodedFile in the form name??? . Question marks "?" are expanded to numerals starting with 000 (the number of zeros "0" equals that of question marks "?").

The bean appends the extension ".uue", ".b16", or ".q_p" depending on Format immediately after the generated numbers. FileCnt contains the number of encoded files.

See also the Format property,IntelliCodeconfig setting, and theMaxFileSizeconfig setting when working with multiple files.

IPWorksException

getFileCnt

public int getFileCnt()

Shows the number of encoded files the bean has read from or written into.

If the user specifies one or more questions marks "?" in EncodedFile they will be expanded from 000 to FileCnt - 1 (the number of question marks "?" specifies the number of figures).

Please refer to EncodedFile for filename conventions.

getFileName

public java.lang.String getFileName()

The destination filename for the encoded data.

When uuencoding, the FileName property contains the filename that is specified in the uuencoded data.

When decoding, if the value of the property is not empty, it shows the bean where to write the decoded data. It can be either the filename or the directory where the file should be written. If a directory, it should end with a backslash "\\".

After a decode operation, the FileName property contains the filename for the created file. If the file couldn't be created because of an illegal filename, examining FileName might give a hint about the reason of the failure.

FileName must be set to "" (empty string) after each decode operation since it contains the full specification of the file.

An error occurs if a uuencoding operation is initiated with an empty FileName .

If you want to first check the uuencoded filename before creating it on disk, you may assign an illegal directory name to FileName (always use a closing backslash "\\" to denote it as directory), then trap the error and check the filename appended to FileName .

setFileName

public void setFileName(java.lang.String fileName)
                 throws IPWorksException

The destination filename for the encoded data.

When uuencoding, the FileName property contains the filename that is specified in the uuencoded data.

When decoding, if the value of the property is not empty, it shows the bean where to write the decoded data. It can be either the filename or the directory where the file should be written. If a directory, it should end with a backslash "\\".

After a decode operation, the FileName property contains the filename for the created file. If the file couldn't be created because of an illegal filename, examining FileName might give a hint about the reason of the failure.

FileName must be set to "" (empty string) after each decode operation since it contains the full specification of the file.

An error occurs if a uuencoding operation is initiated with an empty FileName .

If you want to first check the uuencoded filename before creating it on disk, you may assign an illegal directory name to FileName (always use a closing backslash "\\" to denote it as directory), then trap the error and check the filename appended to FileName .

IPWorksException

getFormat

public int getFormat()

The type of encoding to be used.

The following are the possible values for the Format property, and the corresponding descriptions:

fmtUUEncode (0)

The most popular standard. 3 Bytes are encoded into 4 readable characters. If multiple filenames are specified, then the extension ".uue" is used/expected.

fmtBase64 (1)

Encoding format of MIME. Much like UUEncode but another subset of printable characters is used. If multiple filenames are specified, then the extension ".b64" is used/expected.

fmtQP (2)

Another MIME format coding only special characters. Mostly used if the text contains special accented characters. If multiple filenames are specified, then the extension ".q_p" is used/expected.

fmtURL (3)

Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738. (No multiple filenames can be specified with this encoding.)

fmtJIS (4)

Japanese Industrial Standards encoding of Japanese character sets.

fmtYEncode (5)

Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email.

fmtMD5Hash (6)

The Message Digest 5 hashing algorithm produces a 128-bit hash output.

fmtSHA1Hash (7)

The Secure Hash Algorithm produces a 128-bit hash output.

fmtHex (8)

Creates a hexidecimal string representation of the decoded data.

fmtHTML (9)

Creates an HTML-encoded string.

fmtHMAC (10)

Creates a Hash-based Message Authentication Code for the given data. To set the key, useHMACKey. To set the hash algorithm to use to create the MAC, useHMACAlgorithm.

setFormat

public void setFormat(int format)
               throws IPWorksException

The type of encoding to be used.

The following are the possible values for the Format property, and the corresponding descriptions:

fmtUUEncode (0)

The most popular standard. 3 Bytes are encoded into 4 readable characters. If multiple filenames are specified, then the extension ".uue" is used/expected.

fmtBase64 (1)

Encoding format of MIME. Much like UUEncode but another subset of printable characters is used. If multiple filenames are specified, then the extension ".b64" is used/expected.

fmtQP (2)

Another MIME format coding only special characters. Mostly used if the text contains special accented characters. If multiple filenames are specified, then the extension ".q_p" is used/expected.

fmtURL (3)

Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738. (No multiple filenames can be specified with this encoding.)

fmtJIS (4)

Japanese Industrial Standards encoding of Japanese character sets.

fmtYEncode (5)

Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email.

fmtMD5Hash (6)

The Message Digest 5 hashing algorithm produces a 128-bit hash output.

fmtSHA1Hash (7)

The Secure Hash Algorithm produces a 128-bit hash output.

fmtHex (8)

Creates a hexidecimal string representation of the decoded data.

fmtHTML (9)

Creates an HTML-encoded string.

fmtHMAC (10)

Creates a Hash-based Message Authentication Code for the given data. To set the key, useHMACKey. To set the hash algorithm to use to create the MAC, useHMACAlgorithm.

IPWorksException

getMode

public java.lang.String getMode()

The UNIX-style filemode when uuencoding / uudecoding.

The filemode is usually an octal number such as 755 or 600 which gives the protections of that file. If the file to uudecode is correctly read then Mode contains the protection string given in the uuencoded data.

Given for compatibility with other systems. Used only when Format is fmtUUE.

setMode

public void setMode(java.lang.String mode)
             throws IPWorksException

The UNIX-style filemode when uuencoding / uudecoding.

The filemode is usually an octal number such as 755 or 600 which gives the protections of that file. If the file to uudecode is correctly read then Mode contains the protection string given in the uuencoded data.

Given for compatibility with other systems. Used only when Format is fmtUUE.

IPWorksException

isOverwrite

public boolean isOverwrite()

Controls whether created file(s) should overwrite already existing file(s).

Note that more than one file may be created during uuencoding.

setOverwrite

public void setOverwrite(boolean overwrite)
                  throws IPWorksException

Controls whether created file(s) should overwrite already existing file(s).

Note that more than one file may be created during uuencoding.

IPWorksException

getProgressStep

public int getProgressStep()

Controls the granularity at which the Progress event is fired. Values 0-100.

If ProgressStep is not 0, the Progress event will be fired when 0%, n* ProgressStep and 100% of input data is read.

If ProgressStep is 0, the Progress event is disabled.

setProgressStep

public void setProgressStep(int progressStep)
                     throws IPWorksException

Controls the granularity at which the Progress event is fired. Values 0-100.

If ProgressStep is not 0, the Progress event will be fired when 0%, n* ProgressStep and 100% of input data is read.

If ProgressStep is 0, the Progress event is disabled.

IPWorksException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException

Sets or retrieves a beanconfiguration setting.

Config is a generic method available in every bean. It is used to set and retrieveconfiguration settingsfor the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.

IPWorksException

decode

public void decode()
            throws IPWorksException

Decode string.

Decode according to the Format type. The bean will decode the data in the input stream if SetInputStream has been set to a valid stream. If this stream is null, the bean will then try to read the data from the file set by the EncodedFile property. If no valid file has been specified, the bean will use the EncodedData property.

The resulting decoded data is written to the output stream if one has been set. If not, the component will attempt to write the decoded data to the DecodedFile . If no file was specified, the decoded data may be retrieved through the DecodedData property.

When UUDecoding the created filename will by default be the one specified in the uuencoded data. The FileName property will contain this value. DecodedFile or, if DecodedFile is empty, FileName can be used to override this value.

When YDecoding, the source path and filename is specified in EncodedFile and the destination path and filename in DecodedFile . If the encoded data indicates the name of the original file before decoding, this value will be stored in the FileName property. To decode a multi-part message, all parts must be concatanated in order in the source file.

IPWorksException

encode

public void encode()
            throws IPWorksException

Encode the data.

Encode according to the Format type. The bean will encode the data in the input stream if SetInputStream has been set to a valid stream. If this stream is null, the bean will then try to read the data from the file set by the DecodedFile property. If no valid file has been specified, the bean will use the DecodedData property.

The resulting encoded data is written to the output stream if one has been set. If not, the component will attempt to write the encoded data to the EncodedFile . If no file was specified, the encoded data may be retrieved through the EncodedData property.

The data is considered binary while uuencoding and Base64 Format s, and Text during QuotedPrintable ones.

When uuencoding or yencoding the filename encoded into the data is taken from the FileName property.

The current version of NetCode creates no message headers. If a MIME standard encoding is used such as Base64 Encoding or Quoted Printable Encoding the user should fill the header values appropriately.

If EncodedFile andMaxFileSizeis set and the encoded data takes more space thanMaxFileSize, the data is split over several files. In this case, the user can specify more than one filename by passing them to EncodedFile in the form name? . The filenames should exist as path\\file0.ext , path\\file1.ext ... Question marks "?" are expanded to numerals starting with 0. NetCode appends the extension ".uue", ".b16", or ".q_p" (depending on the value of Format ) to the filename.

IPWorksException

resetData

public void resetData()
               throws IPWorksException

Resets the values of all data and stream properties.

Resets the values of all data and stream properties. It is an easy way to reset the bean's properties before another call to Encode or Decode . The input and output streams and the data and file properties will all be reset.

IPWorksException

setInputStream

public void setInputStream(java.io.InputStream inputStream)
                    throws IPWorksException

The input stream of data.

Use this method to set the input stream for the component to read from. If Encode or Decode is called, and this is not null, the data will be read from this stream when the specified action occurs. You may reset this by calling ResetData .

IPWorksException

setOutputStream

public void setOutputStream(java.io.OutputStream outputStream)
                     throws IPWorksException

Encode to string.

Encode according to Format : DecodedData is encoded into EncodedData . (the data is considered binary while uuencoding and Base64 Format s, and Text during QuotedPrintable ones.) When uuencoding or yencoding the filename encoded into the data is taken from the FileName property.

IPWorksException

addNetcodeEventListener

public void addNetcodeEventListener(ipworks.NetcodeEventListener l)
                             throws java.util.TooManyListenersException

java.util.TooManyListenersException

removeNetcodeEventListener

public void removeNetcodeEventListener(ipworks.NetcodeEventListener l)