Java Doc for Cipher.java in  » 6.0-JDK-Modules » j2me » com » sun » midp » crypto » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » com.sun.midp.crypto 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.midp.crypto.Cipher

All known Subclasses:   com.sun.midp.crypto.RSA,  com.sun.midp.crypto.DES,  com.sun.midp.crypto.BlockCipherBase,  com.sun.midp.crypto.AES,  com.sun.midp.crypto.ARC4,
Cipher
abstract public class Cipher (Code)
Implements an abstract class that generalizes all ciphers. It is modelled after javax.crypto.Cipher.


Field Summary
final public static  intDECRYPT_MODE
     Used in init to indicate decryption mode.
final public static  intENCRYPT_MODE
     Used in init to indicate encryption mode.
final protected static  intMODE_UNINITIALIZED
     Flag to indicate the current cipher algorithm is unknown.

Constructor Summary
protected  Cipher()
     Protected constructor.

Method Summary
abstract public  intdoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
     Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation.
public  byte[]getIV()
     Returns the initialization vector (IV) in a new buffer.
final public static  CiphergetInstance(String transformation)
     Generates a Cipher object that implements the specified transformation.
Parameters:
  transformation - the name of the transformation, e.g.,DES/CBC/PKCS5Padding.See Appendix A in theJava Cryptography Extension Reference Guidefor information about standard transformation names.
public  voidinit(int opmode, Key key)
     Initializes this cipher with a key.

The cipher is initialized for one of the following operations: encryption, decryption, depending on the value of opmode.

If this cipher requires any algorithm parameters that cannot be derived from the given key, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption, and raise an InvalidKeyException if it is being initialized for decryption.

Note that when a Cipher object is initialized, it loses all previously-acquired state.

abstract public  voidinit(int opmode, Key key, CryptoParameter params)
     Initializes this cipher with a key and a set of algorithm parameters.

The cipher is initialized for one of the following operations: encryption or decryption depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption.

Note that when a Cipher object is initialized, it loses all previously-acquired state.

abstract protected  voidsetChainingModeAndPadding(String mode, String padding)
     Called by the factory method to set the mode and padding parameters.
abstract public  intupdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
     Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown.


Field Detail
DECRYPT_MODE
final public static int DECRYPT_MODE(Code)
Used in init to indicate decryption mode.



ENCRYPT_MODE
final public static int ENCRYPT_MODE(Code)
Used in init to indicate encryption mode.



MODE_UNINITIALIZED
final protected static int MODE_UNINITIALIZED(Code)
Flag to indicate the current cipher algorithm is unknown.




Constructor Detail
Cipher
protected Cipher()(Code)
Protected constructor.




Method Detail
doFinal
abstract public int doFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws IllegalStateException, ShortBufferException, IllegalBlockSizeException, BadPaddingException(Code)
Encrypts or decrypts data in a single-part operation, or finishes a multiple-part operation. The data is encrypted or decrypted, depending on how this cipher was initialized.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, and any input bytes that may have been buffered during a previous update operation, are processed, with padding (if requested) being applied. The result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer.

Upon finishing, this method resets this cipher object to the state it was in when previously initialized via a call to init. That is, the object is reset and available to encrypt or decrypt (depending on the operation mode that was specified in the call to init) more data.

Note: if any exception is thrown, this cipher object may need to be reset before it can be used again.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.
Parameters:
  input - the input buffer
Parameters:
  inputOffset - the offset in input where the inputstarts
Parameters:
  inputLen - the input length
Parameters:
  output - the buffer for the result
Parameters:
  outputOffset - the offset in output where the resultis stored the number of bytes stored in output
exception:
  IllegalStateException - if this cipher is in a wrong state(e.g., has not been initialized)
exception:
  IllegalBlockSizeException - if this cipher is a block cipher,no padding has been requested (only in encryption mode), and the totalinput length of the data processed by this cipher is not a multiple ofblock size
exception:
  ShortBufferException - if the given output buffer is too smallto hold the result
exception:
  BadPaddingException - if this cipher is in decryption mode,and (un)padding has been requested, but the decrypted data is notbounded by the appropriate padding bytes




getIV
public byte[] getIV()(Code)
Returns the initialization vector (IV) in a new buffer. This is useful in the case where a random IV was created. the initialization vector in a new buffer,or null if the underlying algorithm doesnot use an IV, or if the IV has not yet been set.



getInstance
final public static Cipher getInstance(String transformation) throws NoSuchAlgorithmException, NoSuchPaddingException(Code)
Generates a Cipher object that implements the specified transformation.
Parameters:
  transformation - the name of the transformation, e.g.,DES/CBC/PKCS5Padding.See Appendix A in theJava Cryptography Extension Reference Guidefor information about standard transformation names. a cipher that implements the requested transformation
exception:
  NoSuchAlgorithmException - if the specified transformation isnot available
exception:
  NoSuchPaddingException - if transformationcontains a padding scheme that is not available.



init
public void init(int opmode, Key key) throws InvalidKeyException(Code)
Initializes this cipher with a key.

The cipher is initialized for one of the following operations: encryption, decryption, depending on the value of opmode.

If this cipher requires any algorithm parameters that cannot be derived from the given key, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption, and raise an InvalidKeyException if it is being initialized for decryption.

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.
Parameters:
  opmode - the operation mode of this cipher (this is one ofthe following:ENCRYPT_MODE or DECRYPT_MODE)
Parameters:
  key - the key
exception:
  InvalidKeyException - if the given key is inappropriate forinitializing this cipher, or if this cipher is being initialized fordecryption and requires algorithm parameters that cannot bedetermined from the given key, or if the given key has a keysize thatexceeds the maximum allowable keysize.




init
abstract public void init(int opmode, Key key, CryptoParameter params) throws InvalidKeyException, InvalidAlgorithmParameterException(Code)
Initializes this cipher with a key and a set of algorithm parameters.

The cipher is initialized for one of the following operations: encryption or decryption depending on the value of opmode.

If this cipher requires any algorithm parameters and params is null, the underlying cipher implementation is supposed to generate the required parameters itself (using provider-specific default or random values) if it is being initialized for encryption, and raise an InvalidAlgorithmParameterException if it is being initialized for decryption.

Note that when a Cipher object is initialized, it loses all previously-acquired state. In other words, initializing a Cipher is equivalent to creating a new instance of that Cipher and initializing it.
Parameters:
  opmode - the operation mode of this cipher (this is one of thefollowing:ENCRYPT_MODE or DECRYPT_MODE)
Parameters:
  key - the encryption key
Parameters:
  params - the algorithm parameters
exception:
  InvalidKeyException - if the given key is inappropriate forinitializing this cipher, or its keysize exceeds the maximum allowablekeysize.
exception:
  InvalidAlgorithmParameterException - if the given algorithmparameters are inappropriate for this cipher,or this cipher is being initialized for decryption and requiresalgorithm parameters and params is null, or the givenalgorithm parameters imply a cryptographic strength that would exceedthe legal limits.




setChainingModeAndPadding
abstract protected void setChainingModeAndPadding(String mode, String padding) throws NoSuchPaddingException(Code)
Called by the factory method to set the mode and padding parameters. Need because Class.newInstance does not take args.
Parameters:
  mode - the chaining mode parsed from the transformation parameterof getInstance and upper cased
Parameters:
  padding - the paddinge parsed from the transformation parameter ofgetInstance and upper cased
exception:
  NoSuchPaddingException - if transformationcontains a padding scheme that is not available.



update
abstract public int update(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset) throws IllegalStateException, ShortBufferException(Code)
Continues a multiple-part encryption or decryption operation (depending on how this cipher was initialized), processing another data part.

The first inputLen bytes in the input buffer, starting at inputOffset inclusive, are processed, and the result is stored in the output buffer, starting at outputOffset inclusive.

If the output buffer is too small to hold the result, a ShortBufferException is thrown. In this case, repeat this call with a larger output buffer.

If inputLen is zero, this method returns a length of zero.

Note: this method should be copy-safe, which means the input and output buffers can reference the same byte array and no unprocessed input data is overwritten when the result is copied into the output buffer.
Parameters:
  input - the input buffer
Parameters:
  inputOffset - the offset in input where the inputstarts
Parameters:
  inputLen - the input length
Parameters:
  output - the buffer for the result
Parameters:
  outputOffset - the offset in output where the resultis stored the number of bytes stored in output
exception:
  IllegalStateException - if this cipher is in a wrong state(e.g., has not been initialized)
exception:
  ShortBufferException - if the given output buffer is too smallto hold the result




Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.