SHOW Signed

net.rim.device.api.crypto
Class BlockEncryptor

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--net.rim.device.api.crypto.CryptoOutputStream
              |
              +--net.rim.device.api.crypto.EncryptorOutputStream
                    |
                    +--net.rim.device.api.crypto.BlockEncryptor

public class BlockEncryptor

extends EncryptorOutputStream

The superclass of all classes that implement block ciphers. The block ciphers sit on the Encryptor output stream and any data that is written to the output stream is acted on by the Block cipher. The class BlockEncryptor itself simply overrides many of the methods defined for the Encryptor class with methods that are specific to block ciphers.

It is important to note that the default mode for all block ciphers is Electronic Code Book mode (ECB) where each block is encrypted/decrypted separately and independently from all other blocks.

Note: For the block cipher algorithm classes, each block is encrypted one block at a time.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Fields inherited from class net.rim.device.api.crypto.CryptoOutputStream

_out

Constructor Summary

	BlockEncryptor(BlockEncryptorEngine encryptorEngine, OutputStream out) Creates a BlockEncryptor object using the specified block encryptor engine and output stream.
	BlockEncryptor(BlockFormatterEngine formatterEngine, OutputStream out) Creates a BlockEncryptor object using the specified block encoder and output stream.

Method Summary

	void	close() Closes the output stream.
	void	flush() Flushes out the remainder of the data in the output stream.
	String	getAlgorithm() Returns the name of the algorithm or both the algorithm and formatter engine used, depending what BlockEncryptor constructor was used.
	int	getInputBlockLength() Returns the input block length of the cipher in bytes.
	int	getOutputBlockLength() Returns the output block length of the cipher in bytes.
	protected void	pad() Pads the output properly.
	void	write(byte[] data, int offset, int length) Writes a specified length of bytes from the given byte array to this output stream.

Methods inherited from class net.rim.device.api.crypto.CryptoOutputStream

getOutputStream, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockEncryptor

public BlockEncryptor(BlockFormatterEngine formatterEngine,
                      OutputStream out)

Creates a BlockEncryptor object using the specified block encoder and output stream.

Parameters:

formatterEngine - The formatter engine that will be used to encode the data.

out - The output stream that the data will be written to.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

BlockEncryptor

public BlockEncryptor(BlockEncryptorEngine encryptorEngine,
                      OutputStream out)

Creates a BlockEncryptor object using the specified block encryptor engine and output stream.

Parameters:

encryptorEngine - The encryptor engine that will be used to encrypt the data.

out - The output stream that the data will be written to.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of the algorithm or both the algorithm and formatter engine used, depending what BlockEncryptor constructor was used.

Overrides:

getAlgorithm in class CryptoOutputStream

Returns:

A string representing the name of the algorithm and block formatter engine used (if one is used) to encrypt the data.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getInputBlockLength

public int getInputBlockLength()

Returns the input block length of the cipher in bytes.

Returns:

An integer representing the input block length.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getOutputBlockLength

public int getOutputBlockLength()

Returns the output block length of the cipher in bytes.

Returns:

An integer representing the output block length.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

write

public void write(byte[] data,
                  int offset,
                  int length)
           throws IOException

Description copied from class: CryptoOutputStream

Writes a specified length of bytes from the given byte array to this output stream.

Overrides:

write in class CryptoOutputStream

Since:

JDE 3.6

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

flush

public void flush()
           throws IOException

Description copied from class: CryptoOutputStream

Flushes out the remainder of the data in the output stream.

Overrides:

flush in class CryptoOutputStream

Following copied from class: net.rim.device.api.crypto.CryptoOutputStream

Throws:

IOException - Thrown if an I/O error occurs.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

pad

protected void pad()
            throws IOException

Pads the output properly.

Throws:

IOException - Thrown if an I/O error occurs.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

close

public void close()
           throws IOException

Description copied from class: CryptoOutputStream

Closes the output stream.

Before closing the stream, it flushes out all of the data that is in the output stream.

See the flush() method for more information.

Overrides:

close in class CryptoOutputStream

Following copied from class: net.rim.device.api.crypto.CryptoOutputStream

Throws:

IOException - Thrown if an I/O error occurs.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.