| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> <a name="line.19"></a> |
| <FONT color="green">020</FONT> import org.apache.shiro.SecurityUtils;<a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.authc.*;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.config.IniSecurityManagerFactory;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.mgt.SecurityManager;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.session.Session;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.subject.Subject;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.util.Factory;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.slf4j.Logger;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.slf4j.LoggerFactory;<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> <a name="line.30"></a> |
| <FONT color="green">031</FONT> /**<a name="line.31"></a> |
| <FONT color="green">032</FONT> * Simple Quickstart application showing how to use Shiro's API.<a name="line.32"></a> |
| <FONT color="green">033</FONT> *<a name="line.33"></a> |
| <FONT color="green">034</FONT> * @since 0.9 RC2<a name="line.34"></a> |
| <FONT color="green">035</FONT> */<a name="line.35"></a> |
| <FONT color="green">036</FONT> public class Quickstart {<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);<a name="line.38"></a> |
| <FONT color="green">039</FONT> <a name="line.39"></a> |
| <FONT color="green">040</FONT> <a name="line.40"></a> |
| <FONT color="green">041</FONT> public static void main(String[] args) {<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> // The easiest way to create a Shiro SecurityManager with configured<a name="line.43"></a> |
| <FONT color="green">044</FONT> // realms, users, roles and permissions is to use the simple INI config.<a name="line.44"></a> |
| <FONT color="green">045</FONT> // We'll do that by using a factory that can ingest a .ini file and<a name="line.45"></a> |
| <FONT color="green">046</FONT> // return a SecurityManager instance:<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> // Use the shiro.ini file at the root of the classpath<a name="line.48"></a> |
| <FONT color="green">049</FONT> // (file: and url: prefixes load from files and urls respectively):<a name="line.49"></a> |
| <FONT color="green">050</FONT> Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");<a name="line.50"></a> |
| <FONT color="green">051</FONT> SecurityManager securityManager = factory.getInstance();<a name="line.51"></a> |
| <FONT color="green">052</FONT> <a name="line.52"></a> |
| <FONT color="green">053</FONT> // for this simple example quickstart, make the SecurityManager<a name="line.53"></a> |
| <FONT color="green">054</FONT> // accessible as a JVM singleton. Most applications wouldn't do this<a name="line.54"></a> |
| <FONT color="green">055</FONT> // and instead rely on their container configuration or web.xml for<a name="line.55"></a> |
| <FONT color="green">056</FONT> // webapps. That is outside the scope of this simple quickstart, so<a name="line.56"></a> |
| <FONT color="green">057</FONT> // we'll just do the bare minimum so you can continue to get a feel<a name="line.57"></a> |
| <FONT color="green">058</FONT> // for things.<a name="line.58"></a> |
| <FONT color="green">059</FONT> SecurityUtils.setSecurityManager(securityManager);<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> // Now that a simple Shiro environment is set up, let's see what you can do:<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> // get the currently executing user:<a name="line.63"></a> |
| <FONT color="green">064</FONT> Subject currentUser = SecurityUtils.getSubject();<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> // Do some stuff with a Session (no need for a web or EJB container!!!)<a name="line.66"></a> |
| <FONT color="green">067</FONT> Session session = currentUser.getSession();<a name="line.67"></a> |
| <FONT color="green">068</FONT> session.setAttribute("someKey", "aValue");<a name="line.68"></a> |
| <FONT color="green">069</FONT> String value = (String) session.getAttribute("someKey");<a name="line.69"></a> |
| <FONT color="green">070</FONT> if (value.equals("aValue")) {<a name="line.70"></a> |
| <FONT color="green">071</FONT> log.info("Retrieved the correct value! [" + value + "]");<a name="line.71"></a> |
| <FONT color="green">072</FONT> }<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> // let's login the current user so we can check against roles and permissions:<a name="line.74"></a> |
| <FONT color="green">075</FONT> if (!currentUser.isAuthenticated()) {<a name="line.75"></a> |
| <FONT color="green">076</FONT> UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");<a name="line.76"></a> |
| <FONT color="green">077</FONT> token.setRememberMe(true);<a name="line.77"></a> |
| <FONT color="green">078</FONT> try {<a name="line.78"></a> |
| <FONT color="green">079</FONT> currentUser.login(token);<a name="line.79"></a> |
| <FONT color="green">080</FONT> } catch (UnknownAccountException uae) {<a name="line.80"></a> |
| <FONT color="green">081</FONT> log.info("There is no user with username of " + token.getPrincipal());<a name="line.81"></a> |
| <FONT color="green">082</FONT> } catch (IncorrectCredentialsException ice) {<a name="line.82"></a> |
| <FONT color="green">083</FONT> log.info("Password for account " + token.getPrincipal() + " was incorrect!");<a name="line.83"></a> |
| <FONT color="green">084</FONT> } catch (LockedAccountException lae) {<a name="line.84"></a> |
| <FONT color="green">085</FONT> log.info("The account for username " + token.getPrincipal() + " is locked. " +<a name="line.85"></a> |
| <FONT color="green">086</FONT> "Please contact your administrator to unlock it.");<a name="line.86"></a> |
| <FONT color="green">087</FONT> }<a name="line.87"></a> |
| <FONT color="green">088</FONT> // ... catch more exceptions here (maybe custom ones specific to your application?<a name="line.88"></a> |
| <FONT color="green">089</FONT> catch (AuthenticationException ae) {<a name="line.89"></a> |
| <FONT color="green">090</FONT> //unexpected condition? error?<a name="line.90"></a> |
| <FONT color="green">091</FONT> }<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> //say who they are:<a name="line.94"></a> |
| <FONT color="green">095</FONT> //print their identifying principal (in this case, a username):<a name="line.95"></a> |
| <FONT color="green">096</FONT> log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> //test a role:<a name="line.98"></a> |
| <FONT color="green">099</FONT> if (currentUser.hasRole("schwartz")) {<a name="line.99"></a> |
| <FONT color="green">100</FONT> log.info("May the Schwartz be with you!");<a name="line.100"></a> |
| <FONT color="green">101</FONT> } else {<a name="line.101"></a> |
| <FONT color="green">102</FONT> log.info("Hello, mere mortal.");<a name="line.102"></a> |
| <FONT color="green">103</FONT> }<a name="line.103"></a> |
| <FONT color="green">104</FONT> <a name="line.104"></a> |
| <FONT color="green">105</FONT> //test a typed permission (not instance-level)<a name="line.105"></a> |
| <FONT color="green">106</FONT> if (currentUser.isPermitted("lightsaber:weild")) {<a name="line.106"></a> |
| <FONT color="green">107</FONT> log.info("You may use a lightsaber ring. Use it wisely.");<a name="line.107"></a> |
| <FONT color="green">108</FONT> } else {<a name="line.108"></a> |
| <FONT color="green">109</FONT> log.info("Sorry, lightsaber rings are for schwartz masters only.");<a name="line.109"></a> |
| <FONT color="green">110</FONT> }<a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> //a (very powerful) Instance Level permission:<a name="line.112"></a> |
| <FONT color="green">113</FONT> if (currentUser.isPermitted("winnebago:drive:eagle5")) {<a name="line.113"></a> |
| <FONT color="green">114</FONT> log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'. " +<a name="line.114"></a> |
| <FONT color="green">115</FONT> "Here are the keys - have fun!");<a name="line.115"></a> |
| <FONT color="green">116</FONT> } else {<a name="line.116"></a> |
| <FONT color="green">117</FONT> log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> //all done - log out!<a name="line.120"></a> |
| <FONT color="green">121</FONT> currentUser.logout();<a name="line.121"></a> |
| <FONT color="green">122</FONT> <a name="line.122"></a> |
| <FONT color="green">123</FONT> System.exit(0);<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> }<a name="line.125"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
