com.gridsystems
Class Base64Encoder

java.lang.Object
  java.io.OutputStream
      java.io.FilterOutputStream
          com.gridsystems.Base64Encoder

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable

public class Base64Encoder
extends java.io.FilterOutputStream

A class to encode Base64 streams and strings. See RFC 1521 section 5.2 for details of the Base64 algorithm.

This class can be used for encoding strings:

 String unencoded = "webmaster:try2gueSS";
 String encoded = Base64Encoder.encode(unencoded);
 

or for encoding streams:

 OutputStream out = new Base64Encoder(System.out);
 

Version:

1.1, 2000/11/17, fixed bug with sign bit for char values, 1.0, 2000/06/11

Author:

Jason Hunter, Copyright © 2000, Rodrigo Ruiz (modifications for internal use by GridSystems)

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Base64Encoder(java.io.OutputStream out)
Constructs a new Base64 encoder that writes output to the given OutputStream.

Method Summary

static byte[]	binaryEncode(byte[] unencoded) Returns the encoded form of the given unencoded byte array.
static byte[]	binaryEncode(java.io.InputStream is) Returns the encoded form of the given unencoded byte array.
void	close() Closes the stream, this MUST be called to ensure proper padding is written to the end of the output stream.
static java.lang.String	encode(java.lang.String s) Returns the Base64 encoded form of the given string.
void	write(byte[] b, int off, int len) Writes the given byte array to the output stream in an encoded form.
void	write(int b) Writes the given byte to the output stream in an encoded form.
void	write(java.lang.String s) Write a String to the output stream.

Methods inherited from class java.io.FilterOutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64Encoder

public Base64Encoder(java.io.OutputStream out)

Constructs a new Base64 encoder that writes output to the given OutputStream.

Parameters:

out - the output stream

Method Detail

write

public void write(int b)
           throws java.io.IOException

Writes the given byte to the output stream in an encoded form.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - the byte to write

Throws:

java.io.IOException - if an I/O error occurs

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes the given byte array to the output stream in an encoded form.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - the data to be written

off - the start offset of the data

len - the length of the data

Throws:

java.io.IOException - if an I/O error occurs

write

public void write(java.lang.String s)
           throws java.io.IOException

Write a String to the output stream.

Parameters:

s - the string to write

Throws:

java.io.IOException - if an I/O error occurs

close

public void close()
           throws java.io.IOException

Closes the stream, this MUST be called to ensure proper padding is written to the end of the output stream.

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.FilterOutputStream

Throws:

java.io.IOException - if an I/O error occurs

encode

public static java.lang.String encode(java.lang.String s)

Returns the Base64 encoded form of the given string.

Parameters:

s - the string to encode

Returns:

the encoded form of the unencoded string

binaryEncode

public static byte[] binaryEncode(byte[] unencoded)

Returns the encoded form of the given unencoded byte array.

Parameters:

unencoded - the byte array to encode

Returns:

the encoded form of the unencoded byte array

binaryEncode

public static byte[] binaryEncode(java.io.InputStream is)

Returns the encoded form of the given unencoded byte array.

Parameters:

is - the input stream to encode

Returns:

the encoded form of the unencoded byte array