blob: 7361387365c90cc5a4e50e11ce6c6d294419db77 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.samples;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.SecurityUtils;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authc.UsernamePasswordToken;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authz.AuthorizationException;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.mgt.SecurityManager;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.subject.Subject;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.Assert;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.Logger;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.springframework.beans.factory.annotation.Autowired;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.springframework.stereotype.Component;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">import javax.annotation.PostConstruct;</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34">/**</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Simple Bean used to demonstrate subject usage.</a>
<span class="sourceLineNo">036</span><a id="line.36"> */</a>
<span class="sourceLineNo">037</span><a id="line.37">@Component</a>
<span class="sourceLineNo">038</span><a id="line.38">public class QuickStart {</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> private static Logger log = LoggerFactory.getLogger(QuickStart.class);</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> @Autowired</a>
<span class="sourceLineNo">043</span><a id="line.43"> private SecurityManager securityManager;</a>
<span class="sourceLineNo">044</span><a id="line.44"></a>
<span class="sourceLineNo">045</span><a id="line.45"> @Autowired</a>
<span class="sourceLineNo">046</span><a id="line.46"> private SimpleService simpleService;</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> public void run() {</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50"> // get the current subject</a>
<span class="sourceLineNo">051</span><a id="line.51"> Subject subject = SecurityUtils.getSubject();</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> // Subject is not authenticated yet</a>
<span class="sourceLineNo">054</span><a id="line.54"> Assert.isTrue(!subject.isAuthenticated());</a>
<span class="sourceLineNo">055</span><a id="line.55"></a>
<span class="sourceLineNo">056</span><a id="line.56"> // login the subject with a username / password</a>
<span class="sourceLineNo">057</span><a id="line.57"> UsernamePasswordToken token = new UsernamePasswordToken("joe.coder", "password");</a>
<span class="sourceLineNo">058</span><a id="line.58"> subject.login(token);</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> // joe.coder has the "user" role</a>
<span class="sourceLineNo">061</span><a id="line.61"> subject.checkRole("user");</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> // joe.coder does NOT have the admin role</a>
<span class="sourceLineNo">064</span><a id="line.64"> Assert.isTrue(!subject.hasRole("admin"));</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> // joe.coder has the "read" permission</a>
<span class="sourceLineNo">067</span><a id="line.67"> subject.checkPermission("read");</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> // current user is allowed to execute this method.</a>
<span class="sourceLineNo">070</span><a id="line.70"> simpleService.readRestrictedCall();</a>
<span class="sourceLineNo">071</span><a id="line.71"></a>
<span class="sourceLineNo">072</span><a id="line.72"> try {</a>
<span class="sourceLineNo">073</span><a id="line.73"> // but not this one!</a>
<span class="sourceLineNo">074</span><a id="line.74"> simpleService.writeRestrictedCall();</a>
<span class="sourceLineNo">075</span><a id="line.75"> }</a>
<span class="sourceLineNo">076</span><a id="line.76"> catch (AuthorizationException e) {</a>
<span class="sourceLineNo">077</span><a id="line.77"> log.info("Subject was NOT allowed to execute method 'writeRestrictedCall'");</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> // logout</a>
<span class="sourceLineNo">081</span><a id="line.81"> subject.logout();</a>
<span class="sourceLineNo">082</span><a id="line.82"> Assert.isTrue(!subject.isAuthenticated());</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84"></a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> /**</a>
<span class="sourceLineNo">087</span><a id="line.87"> * Sets the static instance of SecurityManager. This is NOT needed for web applications.</a>
<span class="sourceLineNo">088</span><a id="line.88"> */</a>
<span class="sourceLineNo">089</span><a id="line.89"> @PostConstruct</a>
<span class="sourceLineNo">090</span><a id="line.90"> private void initStaticSecurityManager() {</a>
<span class="sourceLineNo">091</span><a id="line.91"> SecurityUtils.setSecurityManager(securityManager);</a>
<span class="sourceLineNo">092</span><a id="line.92"> }</a>
<span class="sourceLineNo">093</span><a id="line.93">}</a>
</pre>
</div>
</main>
</body>
</html>