blob: 2626269beee9866ef3a798cac2a4acaf8a38aced [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ByteSource xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/shiro/util/ByteSource.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.util;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="23" href="#23">23</a>
<a name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em>
<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * A {@code ByteSource} wraps a byte array and provides additional encoding operations. Most users will find the</em>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * {@link Util} inner class sufficient to construct ByteSource instances.</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> *</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> */</em>
<a name="30" href="#30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> {
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Returns the wrapped byte array.</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @return the wrapped byte array.</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
<a name="37" href="#37">37</a> byte[] getBytes();
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Returns the &lt;a href="<a href="http://en.wikipedia.org/wiki/Hexadecimal" target="alexandria_uri">http://en.wikipedia.org/wiki/Hexadecimal</a>"&gt;Hex&lt;/a&gt;-formatted String representation of the</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * underlying wrapped byte array.</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @return the &lt;a href="<a href="http://en.wikipedia.org/wiki/Hexadecimal" target="alexandria_uri">http://en.wikipedia.org/wiki/Hexadecimal</a>"&gt;Hex&lt;/a&gt;-formatted String representation of the</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * underlying wrapped byte array.</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em>
<a name="46" href="#46">46</a> String toHex();
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Returns the &lt;a href="<a href="http://en.wikipedia.org/wiki/Base64" target="alexandria_uri">http://en.wikipedia.org/wiki/Base64</a>"&gt;Base 64&lt;/a&gt;-formatted String representation of the</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * underlying wrapped byte array.</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @return the &lt;a href="<a href="http://en.wikipedia.org/wiki/Base64" target="alexandria_uri">http://en.wikipedia.org/wiki/Base64</a>"&gt;Base 64&lt;/a&gt;-formatted String representation of the</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * underlying wrapped byte array.</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
<a name="55" href="#55">55</a> String toBase64();
<a name="56" href="#56">56</a>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the underlying wrapped byte array is null or empty (zero length), {@code false}</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * otherwise.</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @return {@code true} if the underlying wrapped byte array is null or empty (zero length), {@code false}</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * otherwise.</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a name="65" href="#65">65</a> <strong class="jxr_keyword">boolean</strong> isEmpty();
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Utility class that can construct ByteSource instances. This is slightly nicer than needing to know the</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * {@code ByteSource} implementation class to use.</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
<a name="73" href="#73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">Util</a> {
<a name="74" href="#74">74</a>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * Returns a new {@code ByteSource} instance representing the specified byte array.</em>
<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em>
<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to represent as a {@code ByteSource} instance.</em>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @return a new {@code ByteSource} instance representing the specified byte array.</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
<a name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(byte[] bytes) {
<a name="82" href="#82">82</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/util/SimpleByteSource.html">SimpleByteSource</a>(bytes);
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Returns a new {@code ByteSource} instance representing the specified character array's bytes. The byte</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * array is obtained assuming {@code UTF-8} encoding.</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> *</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param chars the character array to represent as a {@code ByteSource} instance.</em>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @return a new {@code ByteSource} instance representing the specified character array's bytes.</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
<a name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(<strong class="jxr_keyword">char</strong>[] chars) {
<a name="93" href="#93">93</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/util/SimpleByteSource.html">SimpleByteSource</a>(chars);
<a name="94" href="#94">94</a> }
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Returns a new {@code ByteSource} instance representing the specified string's bytes. The byte</em>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * array is obtained assuming {@code UTF-8} encoding.</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> *</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @param string the string to represent as a {@code ByteSource} instance.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @return a new {@code ByteSource} instance representing the specified string's bytes.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> */</em>
<a name="103" href="#103">103</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(String string) {
<a name="104" href="#104">104</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/util/SimpleByteSource.html">SimpleByteSource</a>(string);
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">/**</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * Returns a new {@code ByteSource} instance representing the specified ByteSource.</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> *</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @param source the ByteSource to represent as a new {@code ByteSource} instance.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @return a new {@code ByteSource} instance representing the specified ByteSource.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em>
<a name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(<a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> source) {
<a name="114" href="#114">114</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/util/SimpleByteSource.html">SimpleByteSource</a>(source);
<a name="115" href="#115">115</a> }
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Returns a new {@code ByteSource} instance representing the specified File's bytes.</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> *</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param file the file to represent as a {@code ByteSource} instance.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @return a new {@code ByteSource} instance representing the specified File's bytes.</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em>
<a name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(File file) {
<a name="124" href="#124">124</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/util/SimpleByteSource.html">SimpleByteSource</a>(file);
<a name="125" href="#125">125</a> }
<a name="126" href="#126">126</a>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Returns a new {@code ByteSource} instance representing the specified InputStream's bytes.</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> *</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @param stream the InputStream to represent as a {@code ByteSource} instance.</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @return a new {@code ByteSource} instance representing the specified InputStream's bytes.</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em>
<a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(InputStream stream) {
<a name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/shiro/util/SimpleByteSource.html">SimpleByteSource</a>(stream);
<a name="135" href="#135">135</a> }
<a name="136" href="#136">136</a>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the specified object can be easily represented as a {@code ByteSource} using</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * the {@link ByteSource.Util}'s default heuristics, {@code false} otherwise.</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * This implementation merely returns {@link SimpleByteSource}.{@link SimpleByteSource#isCompatible(Object) isCompatible(source)}.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> *</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @param source the object to test to see if it can be easily converted to ByteSource instances using default</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * heuristics.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * @return {@code true} if the specified object can be easily represented as a {@code ByteSource} using</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * the {@link ByteSource.Util}'s default heuristics, {@code false} otherwise.</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em>
<a name="148" href="#148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isCompatible(Object source) {
<a name="149" href="#149">149</a> <strong class="jxr_keyword">return</strong> SimpleByteSource.isCompatible(source);
<a name="150" href="#150">150</a> }
<a name="151" href="#151">151</a>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * Returns a {@code ByteSource} instance representing the specified byte source argument. If the argument</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * &lt;em&gt;cannot&lt;/em&gt; be easily converted to bytes (as is indicated by the {@link #isCompatible(Object)} JavaDoc),</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * this method will throw an {@link IllegalArgumentException}.</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> *</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param source the byte-backed instance that should be represented as a {@code ByteSource} instance.</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @return a {@code ByteSource} instance representing the specified byte source argument.</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the argument &lt;em&gt;cannot&lt;/em&gt; be easily converted to bytes</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * (as indicated by the {@link #isCompatible(Object)} JavaDoc)</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em>
<a name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> bytes(Object source) <strong class="jxr_keyword">throws</strong> IllegalArgumentException {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">if</strong> (source == <strong class="jxr_keyword">null</strong>) {
<a name="164" href="#164">164</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="165" href="#165">165</a> }
<a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> (!isCompatible(source)) {
<a name="167" href="#167">167</a> String msg = <span class="jxr_string">"Unable to heuristically acquire bytes for object of type ["</span> +
<a name="168" href="#168">168</a> source.getClass().getName() + <span class="jxr_string">"]. If this type is indeed a byte-backed data type, you might "</span> +
<a name="169" href="#169">169</a> <span class="jxr_string">"want to write your own ByteSource implementation to extract its bytes explicitly."</span>;
<a name="170" href="#170">170</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg);
<a name="171" href="#171">171</a> }
<a name="172" href="#172">172</a> <strong class="jxr_keyword">if</strong> (source instanceof byte[]) {
<a name="173" href="#173">173</a> <strong class="jxr_keyword">return</strong> bytes((byte[]) source);
<a name="174" href="#174">174</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (source instanceof ByteSource) {
<a name="175" href="#175">175</a> <strong class="jxr_keyword">return</strong> (ByteSource) source;
<a name="176" href="#176">176</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (source instanceof <strong class="jxr_keyword">char</strong>[]) {
<a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> bytes((<strong class="jxr_keyword">char</strong>[]) source);
<a name="178" href="#178">178</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (source instanceof String) {
<a name="179" href="#179">179</a> <strong class="jxr_keyword">return</strong> bytes((String) source);
<a name="180" href="#180">180</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (source instanceof File) {
<a name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> bytes((File) source);
<a name="182" href="#182">182</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (source instanceof InputStream) {
<a name="183" href="#183">183</a> <strong class="jxr_keyword">return</strong> bytes((InputStream) source);
<a name="184" href="#184">184</a> } <strong class="jxr_keyword">else</strong> {
<a name="185" href="#185">185</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Encountered unexpected byte source. This is a bug - please notify "</span> +
<a name="186" href="#186">186</a> <span class="jxr_string">"the Shiro developer list asap (the isCompatible implementation does not reflect this "</span> +
<a name="187" href="#187">187</a> <span class="jxr_string">"method's implementation)."</span>);
<a name="188" href="#188">188</a> }
<a name="189" href="#189">189</a> }
<a name="190" href="#190">190</a> }
<a name="191" href="#191">191</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>