blob: 2762866d62e86ed47ef9d95ee4d769b6b9730761 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.shiro.util;
/**
* A {@code ByteSource} wraps a byte array and provides additional encoding operations. Most users will find
* that the {@link SimpleByteSource SimpleByteSource} implementation meets most needs.
*
* @since 1.0
* @see SimpleByteSource
*/
public interface ByteSource {
/**
* Returns the wrapped byte array.
*
* @return the wrapped byte array.
*/
public byte[] getBytes();
/**
* Returns the <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hex</a>-formatted String representation of the
* underlying wrapped byte array.
*
* @return the <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hex</a>-formatted String representation of the
* underlying wrapped byte array.
*/
public String toHex();
/**
* Returns the <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a>-formatted String representation of the
* underlying wrapped byte array.
*
* @return the <a href="http://en.wikipedia.org/wiki/Base64">Base 64</a>-formatted String representation of the
* underlying wrapped byte array.
*/
public String toBase64();
}