001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.util;
020    
021    /**
022     * A {@code ByteSource} wraps a byte array and provides additional encoding operations.
023     *
024     * @author Les Hazlewood
025     * @since 1.0
026     */
027    public interface ByteSource {
028    
029        /**
030         * Returns the wrapped byte array.
031         *
032         * @return the wrapped byte array.
033         */
034        public byte[] getBytes();
035    
036        /**
037         * Returns the <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hex</a>-formatted String representation of the
038         * underlying wrapped byte array.
039         *
040         * @return the <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hex</a>-formatted String representation of the
041         *         underlying wrapped byte array.
042         */
043        @SuppressWarnings({"UnusedDeclaration"})
044        public String toHex();
045    
046        /**
047         * Returns the <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a>-formatted String representation of the
048         * underlying wrapped byte array.
049         *
050         * @return the <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a>-formatted String representation of the
051         *         underlying wrapped byte array.
052         */
053        public String toBase64();
054    }