Java Doc for Base64.java in  » Net » openfire » org » jivesoftware » util » 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 » Net » openfire » org.jivesoftware.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jivesoftware.util.Base64

Base64
public class Base64 (Code)

Encodes and decodes to and from Base64 notation.

Homepage: http://iharder.net/base64.

Change Log:

  • v2.2.1 - Fixed bug using URL_SAFE and ORDERED encodings. Fixed bug when using very small files (~< 40 bytes).
  • v2.2 - Added some helper methods for encoding/decoding directly from one file to the next. Also added a main() method to support command line encoding/decoding from one file to the next. Also added these Base64 dialects:
    1. The default is RFC3548 format.
    2. Calling Base64.setFormat(Base64.BASE64_FORMAT.URLSAFE_FORMAT) generates URL and file name friendly format as described in Section 4 of RFC3548. http://www.faqs.org/rfcs/rfc3548.html
    3. Calling Base64.setFormat(Base64.BASE64_FORMAT.ORDERED_FORMAT) generates URL and file name friendly format that preserves lexical ordering as described in http://www.faqs.org/qa/rfcc-1940.html
    Special thanks to Jim Kellerman at http://www.powerset.com/ for contributing the new Base64 dialects.
  • v2.1 - Cleaned up javadoc comments and unused variables and methods. Added some convenience methods for reading and writing to and from files.
  • v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems with other encodings (like EBCDIC).
  • v2.0.1 - Fixed an error when decoding a single byte, that is, when the encoded data was a single byte.
  • v2.0 - I got rid of methods that used booleans to set options. Now everything is more consolidated and cleaner. The code now detects when data that's being decoded is gzip-compressed and will decompress it automatically. Generally things are cleaner. You'll probably have to change some method calls that you were making to support the new options format (ints that you "OR" together).
  • v1.5.1 - Fixed bug when decompressing and decoding to a byte[] using decode( String s, boolean gzipCompressed ). Added the ability to "suspend" encoding in the Output Stream so you can turn on and off the encoding if you need to embed base64 data in an otherwise "normal" stream (like an XML file).
  • v1.5 - Output stream pases on flush() command but doesn't do anything itself. This helps when using GZIP streams. Added the ability to GZip-compress objects before encoding them.
  • v1.4 - Added helper methods to read/write files.
  • v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
  • v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream where last buffer being read, if not completely full, was not returned.
  • v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
  • v1.3.3 - Fixed I/O streams which were totally messed up.

I am placing this code in the Public Domain. Do with it as you will. This software comes with no guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/base64 periodically to check for updates or to contribute improvements.


author:
   Robert Harder
author:
   rob@iharder.net
version:
   2.2.1

Inner Class :public static class InputStream extends java.io.FilterInputStream
Inner Class :public static class OutputStream extends java.io.FilterOutputStream

Field Summary
final public static  intDECODE
     Specify decoding.
final public static  intDONT_BREAK_LINES
    
final public static  intENCODE
     Specify encoding.
final public static  intGZIP
     Specify that data should be gzip-compressed.
final public static  intNO_OPTIONS
     No options specified.
final public static  intORDERED
     Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
final public static  intURL_SAFE
     Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.


Method Summary
public static  byte[]decode(byte[] source, int off, int len, int options)
     Very low-level access to decoding ASCII characters in the form of a byte array.
public static  byte[]decode(String s)
     Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
public static  byte[]decode(String s, int options)
     Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
public static  voiddecodeFileToFile(String infile, String outfile)
     Reads infile and decodes it to outfile.
public static  byte[]decodeFromFile(String filename)
     Convenience method for reading a base64-encoded file and decoding it.
public static  booleandecodeToFile(String dataToDecode, String filename)
     Convenience method for decoding data to a file.
public static  ObjectdecodeToObject(String encodedObject)
     Attempts to decode Base64 data and deserialize a Java Object within.
public static  StringencodeBytes(byte[] source)
     Encodes a byte array into Base64 notation.
public static  StringencodeBytes(byte[] source, int options)
     Encodes a byte array into Base64 notation.
public static  StringencodeBytes(byte[] source, int off, int len)
     Encodes a byte array into Base64 notation.
public static  StringencodeBytes(byte[] source, int off, int len, int options)
     Encodes a byte array into Base64 notation.
public static  voidencodeFileToFile(String infile, String outfile)
     Reads infile and encodes it to outfile.
public static  StringencodeFromFile(String filename)
     Convenience method for reading a binary file and base64-encoding it.
public static  StringencodeObject(java.io.Serializable serializableObject)
     Serializes an object and returns the Base64-encoded version of that serialized object.
public static  StringencodeObject(java.io.Serializable serializableObject, int options)
     Serializes an object and returns the Base64-encoded version of that serialized object.
public static  booleanencodeToFile(byte[] dataToEncode, String filename)
     Convenience method for encoding data to a file.
final public static  voidmain(String[] args)
    

Field Detail
DECODE
final public static int DECODE(Code)
Specify decoding.



DONT_BREAK_LINES
final public static int DONT_BREAK_LINES(Code)
Don't break lines when encoding (violates strict Base64 specification)



ENCODE
final public static int ENCODE(Code)
Specify encoding.



GZIP
final public static int GZIP(Code)
Specify that data should be gzip-compressed.



NO_OPTIONS
final public static int NO_OPTIONS(Code)
No options specified. Value is zero.



ORDERED
final public static int ORDERED(Code)
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.



URL_SAFE
final public static int URL_SAFE(Code)
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html. It is important to note that data encoded this way is not officially valid Base64, or at the very least should not be called Base64 without also specifying that is was encoded using the URL- and Filename-safe dialect.





Method Detail
decode
public static byte[] decode(byte[] source, int off, int len, int options)(Code)
Very low-level access to decoding ASCII characters in the form of a byte array. Does not support automatically gunzipping or any other "fancy" features.
Parameters:
  source - The Base64 encoded data
Parameters:
  off - The offset of where to begin decoding
Parameters:
  len - The length of characters to decode decoded data
since:
   1.3



decode
public static byte[] decode(String s)(Code)
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
Parameters:
  s - the string to decode the decoded data
since:
   1.4



decode
public static byte[] decode(String s, int options)(Code)
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
Parameters:
  s - the string to decode
Parameters:
  options - encode options such as URL_SAFE the decoded data
since:
   1.4



decodeFileToFile
public static void decodeFileToFile(String infile, String outfile)(Code)
Reads infile and decodes it to outfile.
Parameters:
  infile - Input file
Parameters:
  outfile - Output file
since:
   2.2



decodeFromFile
public static byte[] decodeFromFile(String filename)(Code)
Convenience method for reading a base64-encoded file and decoding it.
Parameters:
  filename - Filename for reading encoded data decoded byte array or null if unsuccessful
since:
   2.1



decodeToFile
public static boolean decodeToFile(String dataToDecode, String filename)(Code)
Convenience method for decoding data to a file.
Parameters:
  dataToDecode - Base64-encoded data as a string
Parameters:
  filename - Filename for saving decoded data true if successful, false otherwise
since:
   2.1



decodeToObject
public static Object decodeToObject(String encodedObject)(Code)
Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error.
Parameters:
  encodedObject - The Base64 data to decode The decoded and deserialized object
since:
   1.5



encodeBytes
public static String encodeBytes(byte[] source)(Code)
Encodes a byte array into Base64 notation. Does not GZip-compress data.
Parameters:
  source - The data to convert
since:
   1.4



encodeBytes
public static String encodeBytes(byte[] source, int options)(Code)
Encodes a byte array into Base64 notation.

Valid options:

 GZIP: gzip-compresses object before encoding it.
 DONT_BREAK_LINES: don't break lines at 76 characters
 Note: Technically, this makes your encoding non-compliant.
 

Example: encodeBytes( myData, Base64.GZIP ) or

Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
Parameters:
  source - The data to convert
Parameters:
  options - Specified options
See Also:   Base64.GZIP
See Also:   Base64.DONT_BREAK_LINES
since:
   2.0




encodeBytes
public static String encodeBytes(byte[] source, int off, int len)(Code)
Encodes a byte array into Base64 notation. Does not GZip-compress data.
Parameters:
  source - The data to convert
Parameters:
  off - Offset in array where conversion should begin
Parameters:
  len - Length of data to convert
since:
   1.4



encodeBytes
public static String encodeBytes(byte[] source, int off, int len, int options)(Code)
Encodes a byte array into Base64 notation.

Valid options:

 GZIP: gzip-compresses object before encoding it.
 DONT_BREAK_LINES: don't break lines at 76 characters
 Note: Technically, this makes your encoding non-compliant.
 

Example: encodeBytes( myData, Base64.GZIP ) or

Example: encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
Parameters:
  source - The data to convert
Parameters:
  off - Offset in array where conversion should begin
Parameters:
  len - Length of data to convert
Parameters:
  options - Specified options; alphabet type is pulled from this (standard, url-safe, ordered)
See Also:   Base64.GZIP
See Also:   Base64.DONT_BREAK_LINES
since:
   2.0




encodeFileToFile
public static void encodeFileToFile(String infile, String outfile)(Code)
Reads infile and encodes it to outfile.
Parameters:
  infile - Input file
Parameters:
  outfile - Output file
since:
   2.2



encodeFromFile
public static String encodeFromFile(String filename)(Code)
Convenience method for reading a binary file and base64-encoding it.
Parameters:
  filename - Filename for reading binary data base64-encoded string or null if unsuccessful
since:
   2.1



encodeObject
public static String encodeObject(java.io.Serializable serializableObject)(Code)
Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null. The object is not GZip-compressed before being encoded.
Parameters:
  serializableObject - The object to encode The Base64-encoded object
since:
   1.4



encodeObject
public static String encodeObject(java.io.Serializable serializableObject, int options)(Code)
Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null.

Valid options:

 GZIP: gzip-compresses object before encoding it.
 DONT_BREAK_LINES: don't break lines at 76 characters
 Note: Technically, this makes your encoding non-compliant.
 

Example: encodeObject( myObj, Base64.GZIP ) or

Example: encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
Parameters:
  serializableObject - The object to encode
Parameters:
  options - Specified options The Base64-encoded object
See Also:   Base64.GZIP
See Also:   Base64.DONT_BREAK_LINES
since:
   2.0




encodeToFile
public static boolean encodeToFile(byte[] dataToEncode, String filename)(Code)
Convenience method for encoding data to a file.
Parameters:
  dataToEncode - byte array of data to encode in base64 form
Parameters:
  filename - Filename for saving encoded data true if successful, false otherwise
since:
   2.1



main
final public static void main(String[] args)(Code)
Encodes or decodes two files from the command line; feel free to delete this method (in fact you probably should) if you're embedding this code into a larger program.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(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.