View Javadoc

1   /**
2    *
3    *  Licensed to the Apache Software Foundation (ASF) under one or more
4    *  contributor license agreements.  See the NOTICE file distributed with
5    *  this work for additional information regarding copyright ownership.
6    *  The ASF licenses this file to You under the Apache License, Version 2.0
7    *  (the "License"); you may not use this file except in compliance with
8    *  the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing, software
13   *  distributed under the License is distributed on an "AS IS" BASIS,
14   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *  See the License for the specific language governing permissions and
16   *  limitations under the License.
17   */
18  
19  package org.apache.geronimo.util.encoders;
20  
21  /**
22   * Convert binary data to and from UrlBase64 encoding.  This is identical to
23   * Base64 encoding, except that the padding character is "." and the other
24   * non-alphanumeric characters are "-" and "_" instead of "+" and "/".
25   * <p>
26   * The purpose of UrlBase64 encoding is to provide a compact encoding of binary
27   * data that is safe for use as an URL parameter. Base64 encoding does not
28   * produce encoded values that are safe for use in URLs, since "/" can be
29   * interpreted as a path delimiter; "+" is the encoded form of a space; and
30   * "=" is used to separate a name from the corresponding value in an URL
31   * parameter.
32   */
33  public class UrlBase64Encoder extends Base64Encoder
34  {
35      public UrlBase64Encoder()
36      {
37          encodingTable[encodingTable.length - 2] = (byte) '-';
38          encodingTable[encodingTable.length - 1] = (byte) '_';
39          padding = (byte) '.';
40          // we must re-create the decoding table with the new encoded values.
41          initialiseDecodingTable();
42      }
43  }