Package org.craftercms.commons.crypto
Class Base64
- java.lang.Object
-
- org.craftercms.commons.crypto.Base64
-
@Deprecated public class Base64 extends Object
Deprecated.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Base64.InputStream
Deprecated.ABase64.InputStream
will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.static class
Base64.OutputStream
Deprecated.ABase64.OutputStream
will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
-
Field Summary
Fields Modifier and Type Field Description static int
DECODE
Deprecated.Specify decoding.static int
DONT_BREAK_LINES
Deprecated.Don't break lines when encoding (violates strict Base64 specification)static int
ENCODE
Deprecated.Specify encoding.static int
GZIP
Deprecated.Specify that data should be gzip-compressed.static int
NO_OPTIONS
Deprecated.No options specified.static int
ORDERED
Deprecated.Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.static int
URL_SAFE
Deprecated.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
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static byte[]
decode(byte[] source, int off, int len, int options)
Deprecated.Very low-level access to decoding ASCII characters in the form of a byte array.static byte[]
decode(String s)
Deprecated.Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.static byte[]
decode(String s, int options)
Deprecated.Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.static void
decodeFileToFile(String infile, String outfile)
Deprecated.Reads infile and decodes it to outfile.static byte[]
decodeFromFile(String filename)
Deprecated.Convenience method for reading a base64-encoded file and decoding it.static boolean
decodeToFile(String dataToDecode, String filename)
Deprecated.Convenience method for decoding data to a file.static Object
decodeToObject(String encodedObject)
Deprecated.Attempts to decode Base64 data and deserialize a Java Object within.static String
encodeBytes(byte[] source)
Deprecated.Encodes a byte array into Base64 notation.static String
encodeBytes(byte[] source, int options)
Deprecated.Encodes a byte array into Base64 notation.static String
encodeBytes(byte[] source, int off, int len)
Deprecated.Encodes a byte array into Base64 notation.static String
encodeBytes(byte[] source, int off, int len, int options)
Deprecated.Encodes a byte array into Base64 notation.static void
encodeFileToFile(String infile, String outfile)
Deprecated.Reads infile and encodes it to outfile.static String
encodeFromFile(String filename)
Deprecated.Convenience method for reading a binary file and base64-encoding it.static String
encodeObject(Serializable serializableObject)
Deprecated.Serializes an object and returns the Base64-encoded version of that serialized object.static String
encodeObject(Serializable serializableObject, int options)
Deprecated.Serializes an object and returns the Base64-encoded version of that serialized object.static boolean
encodeToFile(byte[] dataToEncode, String filename)
Deprecated.Convenience method for encoding data to a file.static void
main(String[] args)
Deprecated.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.
-
-
-
Field Detail
-
NO_OPTIONS
public static final int NO_OPTIONS
Deprecated.No options specified. Value is zero.- See Also:
- Constant Field Values
-
ENCODE
public static final int ENCODE
Deprecated.Specify encoding.- See Also:
- Constant Field Values
-
DECODE
public static final int DECODE
Deprecated.Specify decoding.- See Also:
- Constant Field Values
-
GZIP
public static final int GZIP
Deprecated.Specify that data should be gzip-compressed.- See Also:
- Constant Field Values
-
DONT_BREAK_LINES
public static final int DONT_BREAK_LINES
Deprecated.Don't break lines when encoding (violates strict Base64 specification)- See Also:
- Constant Field Values
-
URL_SAFE
public static final int URL_SAFE
Deprecated.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.- See Also:
- Constant Field Values
-
ORDERED
public static final int ORDERED
Deprecated.Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.- See Also:
- Constant Field Values
-
-
Method Detail
-
main
public static final void main(String[] args)
Deprecated.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.
-
encodeObject
public static String encodeObject(Serializable serializableObject)
Deprecated.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- Returns:
- The Base64-encoded object
- Since:
- 1.4
-
encodeObject
public static String encodeObject(Serializable serializableObject, int options)
Deprecated.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 )
orExample:
encodeObject( myObj, Base64.GZIP | Base64.DONT_BREAK_LINES )
- Parameters:
serializableObject
- The object to encodeoptions
- Specified options- Returns:
- The Base64-encoded object
- Since:
- 2.0
- See Also:
GZIP
,DONT_BREAK_LINES
-
encodeBytes
public static String encodeBytes(byte[] source)
Deprecated.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)
Deprecated.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 )
orExample:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
- Parameters:
source
- The data to convertoptions
- Specified options- Since:
- 2.0
- See Also:
GZIP
,DONT_BREAK_LINES
-
encodeBytes
public static String encodeBytes(byte[] source, int off, int len)
Deprecated.Encodes a byte array into Base64 notation. Does not GZip-compress data.- Parameters:
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convert- Since:
- 1.4
-
encodeBytes
public static String encodeBytes(byte[] source, int off, int len, int options)
Deprecated.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 )
orExample:
encodeBytes( myData, Base64.GZIP | Base64.DONT_BREAK_LINES )
- Parameters:
source
- The data to convertoff
- Offset in array where conversion should beginlen
- Length of data to convertoptions
- Specified options- Since:
- 2.0
- See Also:
GZIP
,DONT_BREAK_LINES
-
decode
public static byte[] decode(byte[] source, int off, int len, int options)
Deprecated.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 dataoff
- The offset of where to begin decodinglen
- The length of characters to decode- Returns:
- decoded data
- Since:
- 1.3
-
decode
public static byte[] decode(String s)
Deprecated.Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.- Parameters:
s
- the string to decode- Returns:
- the decoded data
- Since:
- 1.4
-
decode
public static byte[] decode(String s, int options)
Deprecated.Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.- Parameters:
s
- the string to decodeoptions
- encode options such as URL_SAFE- Returns:
- the decoded data
- Since:
- 1.4
-
decodeToObject
public static Object decodeToObject(String encodedObject)
Deprecated.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- Returns:
- The decoded and deserialized object
- Since:
- 1.5
-
encodeToFile
public static boolean encodeToFile(byte[] dataToEncode, String filename)
Deprecated.Convenience method for encoding data to a file.- Parameters:
dataToEncode
- byte array of data to encode in base64 formfilename
- Filename for saving encoded data- Returns:
- true if successful, false otherwise
- Since:
- 2.1
-
decodeToFile
public static boolean decodeToFile(String dataToDecode, String filename)
Deprecated.Convenience method for decoding data to a file.- Parameters:
dataToDecode
- Base64-encoded data as a stringfilename
- Filename for saving decoded data- Returns:
- true if successful, false otherwise
- Since:
- 2.1
-
decodeFromFile
public static byte[] decodeFromFile(String filename)
Deprecated.Convenience method for reading a base64-encoded file and decoding it.- Parameters:
filename
- Filename for reading encoded data- Returns:
- decoded byte array or null if unsuccessful
- Since:
- 2.1
-
encodeFromFile
public static String encodeFromFile(String filename)
Deprecated.Convenience method for reading a binary file and base64-encoding it.- Parameters:
filename
- Filename for reading binary data- Returns:
- base64-encoded string or null if unsuccessful
- Since:
- 2.1
-
encodeFileToFile
public static void encodeFileToFile(String infile, String outfile)
Deprecated.Reads infile and encodes it to outfile.- Parameters:
infile
- Input fileoutfile
- Output file- Since:
- 2.2
-
-