src/site/assets/static/1.2.5/apidocs/src-html/org/apache/shiro/crypto/AbstractSymmetricCipherService.html - shiro-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html lang="en">
 <head>
 <title>Source code</title>
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 </head>
 <body>
 <div class="sourceContainer">
 <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
 <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
 <span class="sourceLineNo">003</span> * or more contributor license agreements.  See the NOTICE file<a name="line.3"></a>
 <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
 <span class="sourceLineNo">005</span> * regarding copyright ownership.  The ASF licenses this file<a name="line.5"></a>
 <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
 <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
 <span class="sourceLineNo">008</span> * with the License.  You may obtain a copy of the License at<a name="line.8"></a>
 <span class="sourceLineNo">009</span> *<a name="line.9"></a>
 <span class="sourceLineNo">010</span> *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
 <span class="sourceLineNo">011</span> *<a name="line.11"></a>
 <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
 <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
 <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
 <span class="sourceLineNo">015</span> * KIND, either express or implied.  See the License for the<a name="line.15"></a>
 <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
 <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
 <span class="sourceLineNo">018</span> */<a name="line.18"></a>
 <span class="sourceLineNo">019</span>package org.apache.shiro.crypto;<a name="line.19"></a>
 <span class="sourceLineNo">020</span><a name="line.20"></a>
 <span class="sourceLineNo">021</span>import javax.crypto.KeyGenerator;<a name="line.21"></a>
 <span class="sourceLineNo">022</span>import java.security.Key;<a name="line.22"></a>
 <span class="sourceLineNo">023</span>import java.security.NoSuchAlgorithmException;<a name="line.23"></a>
 <span class="sourceLineNo">024</span><a name="line.24"></a>
 <span class="sourceLineNo">025</span>/**<a name="line.25"></a>
 <span class="sourceLineNo">026</span> * Base abstract class for supporting symmetric key cipher algorithms.<a name="line.26"></a>
 <span class="sourceLineNo">027</span> *<a name="line.27"></a>
 <span class="sourceLineNo">028</span> * @since 1.0<a name="line.28"></a>
 <span class="sourceLineNo">029</span> */<a name="line.29"></a>
 <span class="sourceLineNo">030</span>public abstract class AbstractSymmetricCipherService extends JcaCipherService {<a name="line.30"></a>
 <span class="sourceLineNo">031</span><a name="line.31"></a>
 <span class="sourceLineNo">032</span>    protected AbstractSymmetricCipherService(String algorithmName) {<a name="line.32"></a>
 <span class="sourceLineNo">033</span>        super(algorithmName);<a name="line.33"></a>
 <span class="sourceLineNo">034</span>    }<a name="line.34"></a>
 <span class="sourceLineNo">035</span><a name="line.35"></a>
 <span class="sourceLineNo">036</span>    /**<a name="line.36"></a>
 <span class="sourceLineNo">037</span>     * Generates a new {@link java.security.Key Key} suitable for this CipherService's {@link #getAlgorithmName() algorithm}<a name="line.37"></a>
 <span class="sourceLineNo">038</span>     * by calling {@link #generateNewKey(int) generateNewKey(128)} (uses a 128 bit size by default).<a name="line.38"></a>
 <span class="sourceLineNo">039</span>     *<a name="line.39"></a>
 <span class="sourceLineNo">040</span>     * @return a new {@link java.security.Key Key}, 128 bits in length.<a name="line.40"></a>
 <span class="sourceLineNo">041</span>     */<a name="line.41"></a>
 <span class="sourceLineNo">042</span>    public Key generateNewKey() {<a name="line.42"></a>
 <span class="sourceLineNo">043</span>        return generateNewKey(getKeySize());<a name="line.43"></a>
 <span class="sourceLineNo">044</span>    }<a name="line.44"></a>
 <span class="sourceLineNo">045</span><a name="line.45"></a>
 <span class="sourceLineNo">046</span>    /**<a name="line.46"></a>
 <span class="sourceLineNo">047</span>     * Generates a new {@link Key Key} of the specified size suitable for this CipherService<a name="line.47"></a>
 <span class="sourceLineNo">048</span>     * (based on the {@link #getAlgorithmName() algorithmName} using the JDK {@link javax.crypto.KeyGenerator KeyGenerator}.<a name="line.48"></a>
 <span class="sourceLineNo">049</span>     *<a name="line.49"></a>
 <span class="sourceLineNo">050</span>     * @param keyBitSize the bit size of the key to create<a name="line.50"></a>
 <span class="sourceLineNo">051</span>     * @return the created key suitable for use with this CipherService<a name="line.51"></a>
 <span class="sourceLineNo">052</span>     */<a name="line.52"></a>
 <span class="sourceLineNo">053</span>    public Key generateNewKey(int keyBitSize) {<a name="line.53"></a>
 <span class="sourceLineNo">054</span>        KeyGenerator kg;<a name="line.54"></a>
 <span class="sourceLineNo">055</span>        try {<a name="line.55"></a>
 <span class="sourceLineNo">056</span>            kg = KeyGenerator.getInstance(getAlgorithmName());<a name="line.56"></a>
 <span class="sourceLineNo">057</span>        } catch (NoSuchAlgorithmException e) {<a name="line.57"></a>
 <span class="sourceLineNo">058</span>            String msg = "Unable to acquire " + getAlgorithmName() + " algorithm.  This is required to function.";<a name="line.58"></a>
 <span class="sourceLineNo">059</span>            throw new IllegalStateException(msg, e);<a name="line.59"></a>
 <span class="sourceLineNo">060</span>        }<a name="line.60"></a>
 <span class="sourceLineNo">061</span>        kg.init(keyBitSize);<a name="line.61"></a>
 <span class="sourceLineNo">062</span>        return kg.generateKey();<a name="line.62"></a>
 <span class="sourceLineNo">063</span>    }<a name="line.63"></a>
 <span class="sourceLineNo">064</span><a name="line.64"></a>
 <span class="sourceLineNo">065</span>}<a name="line.65"></a>


 </pre>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<html lang="en">
	<head>
	<title>Source code</title>
	<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
	</head>
	<body>
	<div class="sourceContainer">
	<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
	<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
	<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
	<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
	<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
	<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
	<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
	<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
	<span class="sourceLineNo">009</span> *<a name="line.9"></a>
	<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
	<span class="sourceLineNo">011</span> *<a name="line.11"></a>
	<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
	<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
	<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
	<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
	<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
	<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
	<span class="sourceLineNo">018</span> */<a name="line.18"></a>
	<span class="sourceLineNo">019</span>package org.apache.shiro.crypto;<a name="line.19"></a>
	<span class="sourceLineNo">020</span><a name="line.20"></a>
	<span class="sourceLineNo">021</span>import javax.crypto.KeyGenerator;<a name="line.21"></a>
	<span class="sourceLineNo">022</span>import java.security.Key;<a name="line.22"></a>
	<span class="sourceLineNo">023</span>import java.security.NoSuchAlgorithmException;<a name="line.23"></a>
	<span class="sourceLineNo">024</span><a name="line.24"></a>
	<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
	<span class="sourceLineNo">026</span> * Base abstract class for supporting symmetric key cipher algorithms.<a name="line.26"></a>
	<span class="sourceLineNo">027</span> *<a name="line.27"></a>
	<span class="sourceLineNo">028</span> * @since 1.0<a name="line.28"></a>
	<span class="sourceLineNo">029</span> */<a name="line.29"></a>
	<span class="sourceLineNo">030</span>public abstract class AbstractSymmetricCipherService extends JcaCipherService {<a name="line.30"></a>
	<span class="sourceLineNo">031</span><a name="line.31"></a>
	<span class="sourceLineNo">032</span> protected AbstractSymmetricCipherService(String algorithmName) {<a name="line.32"></a>
	<span class="sourceLineNo">033</span> super(algorithmName);<a name="line.33"></a>
	<span class="sourceLineNo">034</span> }<a name="line.34"></a>
	<span class="sourceLineNo">035</span><a name="line.35"></a>
	<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
	<span class="sourceLineNo">037</span> * Generates a new {@link java.security.Key Key} suitable for this CipherService's {@link #getAlgorithmName() algorithm}<a name="line.37"></a>
	<span class="sourceLineNo">038</span> * by calling {@link #generateNewKey(int) generateNewKey(128)} (uses a 128 bit size by default).<a name="line.38"></a>
	<span class="sourceLineNo">039</span> *<a name="line.39"></a>
	<span class="sourceLineNo">040</span> * @return a new {@link java.security.Key Key}, 128 bits in length.<a name="line.40"></a>
	<span class="sourceLineNo">041</span> */<a name="line.41"></a>
	<span class="sourceLineNo">042</span> public Key generateNewKey() {<a name="line.42"></a>
	<span class="sourceLineNo">043</span> return generateNewKey(getKeySize());<a name="line.43"></a>
	<span class="sourceLineNo">044</span> }<a name="line.44"></a>
	<span class="sourceLineNo">045</span><a name="line.45"></a>
	<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
	<span class="sourceLineNo">047</span> * Generates a new {@link Key Key} of the specified size suitable for this CipherService<a name="line.47"></a>
	<span class="sourceLineNo">048</span> * (based on the {@link #getAlgorithmName() algorithmName} using the JDK {@link javax.crypto.KeyGenerator KeyGenerator}.<a name="line.48"></a>
	<span class="sourceLineNo">049</span> *<a name="line.49"></a>
	<span class="sourceLineNo">050</span> * @param keyBitSize the bit size of the key to create<a name="line.50"></a>
	<span class="sourceLineNo">051</span> * @return the created key suitable for use with this CipherService<a name="line.51"></a>
	<span class="sourceLineNo">052</span> */<a name="line.52"></a>
	<span class="sourceLineNo">053</span> public Key generateNewKey(int keyBitSize) {<a name="line.53"></a>
	<span class="sourceLineNo">054</span> KeyGenerator kg;<a name="line.54"></a>
	<span class="sourceLineNo">055</span> try {<a name="line.55"></a>
	<span class="sourceLineNo">056</span> kg = KeyGenerator.getInstance(getAlgorithmName());<a name="line.56"></a>
	<span class="sourceLineNo">057</span> } catch (NoSuchAlgorithmException e) {<a name="line.57"></a>
	<span class="sourceLineNo">058</span> String msg = "Unable to acquire " + getAlgorithmName() + " algorithm. This is required to function.";<a name="line.58"></a>
	<span class="sourceLineNo">059</span> throw new IllegalStateException(msg, e);<a name="line.59"></a>
	<span class="sourceLineNo">060</span> }<a name="line.60"></a>
	<span class="sourceLineNo">061</span> kg.init(keyBitSize);<a name="line.61"></a>
	<span class="sourceLineNo">062</span> return kg.generateKey();<a name="line.62"></a>
	<span class="sourceLineNo">063</span> }<a name="line.63"></a>
	<span class="sourceLineNo">064</span><a name="line.64"></a>
	<span class="sourceLineNo">065</span>}<a name="line.65"></a>




























































	</pre>
	</div>
	</body>
	</html>