SHOW Signed

net.rim.device.api.crypto
Interface BlockUnformatterEngine

All Known Implementing Classes:
OAEPUnformatterEngine, PKCS1UnformatterEngine, PKCS5UnformatterEngine

public interface BlockUnformatterEngine

The BlockUnFormatterEngine interface removes any formatting from data.

The BlockFormatterEngine interface applies formatting to data in the form of extra padding.

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.

Since:
JDE 3.6.0

Method Summary
 Category: Signed  int decryptAndUnformat(byte[] input, int inputOffset, byte[] output, int outputOffset)
          Decrypts the input and then "unformats" it into the original plaintext assuming this block is not the last block in the stream.
 Category: Signed  int decryptAndUnformat(byte[] input, int inputOffset, byte[] output, int outputOffset, boolean lastBlock)
          Decrypts the input and then "unformats" it into the original plaintext.
 Category: Signed  String getAlgorithm()
          Returns the name of the signing algorithm used, eg "PKCS5".
 Category: Signed  int getInputBlockLength()
          Returns the length of an input block in bytes.
 Category: Signed  int getOutputBlockLength()
          Returns the length of an output block in bytes.
 

Method Detail

decryptAndUnformat

public int decryptAndUnformat(byte[] input,
                              int inputOffset,
                              byte[] output,
                              int outputOffset)
                       throws DecodeException,
                              BadPaddingException,
                              CryptoTokenException
Decrypts the input and then "unformats" it into the original plaintext assuming this block is not the last block in the stream.

Parameters:
input - A byte array containing the encoded ciphertext.
inputOffset - The offset, or initial bit position, of the data within the byte array.
output - The byte array that will contain the plaintext.
outputOffset - The offset, or initial bit position, of the data within the byte array.
Returns:
An integer representing the value of the operation.
Throws:
DecodeException - Thrown if the input cannot be decoded properly.
BadPaddingException - Thrown if the input has improper padding.
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
Since:
JDE 3.6.0
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.

decryptAndUnformat

public int decryptAndUnformat(byte[] input,
                              int inputOffset,
                              byte[] output,
                              int outputOffset,
                              boolean lastBlock)
                       throws DecodeException,
                              BadPaddingException,
                              CryptoTokenException
Decrypts the input and then "unformats" it into the original plaintext.

Parameters:
input - A byte array containing the encoded ciphertext.
inputOffset - The offset, or initial bit position, of the data within the byte array.
output - The byte array that will contain the plaintext.
outputOffset - The offset, or initial bit position, of the data within the byte array.
lastBlock - A boolean flag indicating whether this is the last block in the stream to be decrypted.
Returns:
An integer representing the value of the operation.
Throws:
DecodeException - Thrown if the input cannot be decoded properly.
BadPaddingException - Thrown if the input has improper padding.
CryptoTokenException - Thrown when a problem occurs with a crypto token or the crypto token is invalid.
Since:
JDE 3.6.0
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.

getAlgorithm

public String getAlgorithm()
Returns the name of the signing algorithm used, eg "PKCS5".

Returns:
A String representing the name of the algorithm used.
Since:
JDE 3.6.0
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 length of an input block in bytes.

Returns:
An integer representing the length, in bytes, of an input block.
Since:
JDE 3.6.0
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 length of an output block in bytes.

Returns:
An integer that represents the length, in bytes, of an output block.
Since:
JDE 3.6.0
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.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.