| <!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><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import com.google.inject.Guice;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import com.google.inject.Injector;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.SecurityUtils;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.authc.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.mgt.SecurityManager;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.session.Session;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.subject.Subject;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.slf4j.LoggerFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Simple Quickstart application showing how to use Shiro's API with Guice integration.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * @since 0.9 RC2<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> */<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public class QuickstartGuice {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private static final transient Logger log = LoggerFactory.getLogger(QuickstartGuice.class);<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> public static void main(String[] args) {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> // We will utilize standard Guice bootstrapping to create a Shiro SecurityManager.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> Injector injector = Guice.createInjector(new QuickstartShiroModule());<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> SecurityManager securityManager = injector.getInstance(SecurityManager.class);<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> // for this simple example quickstart, make the SecurityManager<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> // accessible as a JVM singleton. Most applications wouldn't do this<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> // and instead rely on their container configuration or web.xml for<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> // webapps. That is outside the scope of this simple quickstart, so<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> // we'll just do the bare minimum so you can continue to get a feel<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> // for things.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> SecurityUtils.setSecurityManager(securityManager);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> // Now that a simple Shiro environment is set up, let's see what you can do:<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> // get the currently executing user:<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> Subject currentUser = SecurityUtils.getSubject();<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> // Do some stuff with a Session (no need for a web or EJB container!!!)<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> Session session = currentUser.getSession();<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> session.setAttribute("someKey", "aValue");<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> String value = (String) session.getAttribute("someKey");<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> if (value.equals("aValue")) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> log.info("Retrieved the correct value! [" + value + "]");<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> // let's login the current user so we can check against roles and permissions:<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> if (!currentUser.isAuthenticated()) {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> token.setRememberMe(true);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> try {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> currentUser.login(token);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> } catch (UnknownAccountException uae) {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> log.info("There is no user with username of " + token.getPrincipal());<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> } catch (IncorrectCredentialsException ice) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> log.info("Password for account " + token.getPrincipal() + " was incorrect!");<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> } catch (LockedAccountException lae) {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> log.info("The account for username " + token.getPrincipal() + " is locked. " +<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> "Please contact your administrator to unlock it.");<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // ... catch more exceptions here (maybe custom ones specific to your application?<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> catch (AuthenticationException ae) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> //unexpected condition? error?<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> //say who they are:<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> //print their identifying principal (in this case, a username):<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> //test a role:<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (currentUser.hasRole("schwartz")) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> log.info("May the Schwartz be with you!");<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> } else {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> log.info("Hello, mere mortal.");<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> //test a typed permission (not instance-level)<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (currentUser.isPermitted("lightsaber:weild")) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> log.info("You may use a lightsaber ring. Use it wisely.");<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> } else {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> log.info("Sorry, lightsaber rings are for schwartz masters only.");<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> //a (very powerful) Instance Level permission:<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> if (currentUser.isPermitted("winnebago:drive:eagle5")) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'. " +<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> "Here are the keys - have fun!");<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> } else {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> //all done - log out!<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> currentUser.logout();<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> System.exit(0);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span>}<a name="line.118"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
