| <!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.mgt;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.AuthenticationException;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authc.AuthenticationToken;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authc.Authenticator;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.authz.Authorizer;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.session.mgt.SessionManager;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.subject.SubjectContext;</a> |
| <span class="sourceLineNo">028</span><a id="line.28"></a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30">/**</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * A {@code SecurityManager} executes all security operations for <em>all</em> Subjects (aka users) across a</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * single application.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * <p/></a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * The interface itself primarily exists as a convenience - it extends the {@link org.apache.shiro.authc.Authenticator},</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * {@link Authorizer}, and {@link SessionManager} interfaces, thereby consolidating</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * these behaviors into a single point of reference. For most Shiro usages, this simplifies configuration and</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * tends to be a more convenient approach than referencing {@code Authenticator}, {@code Authorizer}, and</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * {@code SessionManager} instances separately; instead one only needs to interact with a single</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * {@code SecurityManager} instance.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <p/></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * In addition to the above three interfaces, this interface provides a number of methods supporting</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * {@link Subject} behavior. A {@link org.apache.shiro.subject.Subject Subject} executes</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * authentication, authorization, and session operations for a <em>single</em> user, and as such can only be</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * managed by {@code A SecurityManager} which is aware of all three functions. The three parent interfaces on the</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * other hand do not 'know' about {@code Subject}s to ensure a clean separation of concerns.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * <p/></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <b>Usage Note</b>: In actuality the large majority of application programmers won't interact with a SecurityManager</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * very often, if at all. <em>Most</em> application programmers only care about security operations for the currently</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * executing user, usually attained by calling</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * {@link org.apache.shiro.SecurityUtils#getSubject() SecurityUtils.getSubject()}.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * <p/></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Framework developers on the other hand might find working with an actual SecurityManager useful.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> *</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @see org.apache.shiro.mgt.DefaultSecurityManager</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @since 0.2</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> */</a> |
| <span class="sourceLineNo">057</span><a id="line.57">public interface SecurityManager extends Authenticator, Authorizer, SessionManager {</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> /**</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * Logs in the specified Subject using the given {@code authenticationToken}, returning an updated Subject</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * instance reflecting the authenticated state if successful or throwing {@code AuthenticationException} if it is</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * not.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * <p/></a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * Note that most application developers should probably not call this method directly unless they have a good</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * reason for doing so. The preferred way to log in a Subject is to call</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * <code>subject.{@link org.apache.shiro.subject.Subject#login login(authenticationToken)}</code> (usually after</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * acquiring the Subject by calling {@link org.apache.shiro.SecurityUtils#getSubject() SecurityUtils.getSubject()}).</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * <p/></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * Framework developers on the other hand might find calling this method directly useful in certain cases.</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> *</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @param subject the subject against which the authentication attempt will occur</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * @param authenticationToken the token representing the Subject's principal(s) and credential(s)</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @return the subject instance reflecting the authenticated state after a successful attempt</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * @throws AuthenticationException if the login attempt failed.</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @since 1.0</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> */</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> Subject login(Subject subject, AuthenticationToken authenticationToken) throws AuthenticationException;</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"> * Logs out the specified Subject from the system.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * <p/></a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * Note that most application developers should not call this method unless they have a good reason for doing</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * so. The preferred way to logout a Subject is to call</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * <code>{@link org.apache.shiro.subject.Subject#logout Subject.logout()}</code>, not the</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * {@code SecurityManager} directly.</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * <p/></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * Framework developers on the other hand might find calling this method directly useful in certain cases.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> *</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @param subject the subject to log out.</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @since 1.0</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> */</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> void logout(Subject subject);</a> |
| <span class="sourceLineNo">093</span><a id="line.93"></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> /**</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * Creates a {@code Subject} instance reflecting the specified contextual data.</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> * <p/></a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * The context can be anything needed by this {@code SecurityManager} to construct a {@code Subject} instance.</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> * Most Shiro end-users will never call this method - it exists primarily for</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * framework development and to support any underlying custom {@link SubjectFactory SubjectFactory} implementations</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * that may be used by the {@code SecurityManager}.</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> * <h4>Usage</h4></a> |
| <span class="sourceLineNo">102</span><a id="line.102"> * After calling this method, the returned instance is <em>not</em> bound to the application for further use.</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * Callers are expected to know that {@code Subject} instances have local scope only and any</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * other further use beyond the calling method must be managed explicitly.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> *</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * @param context any data needed to direct how the Subject should be constructed.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * @return the {@code Subject} instance reflecting the specified initialization data.</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @see SubjectFactory#createSubject(SubjectContext)</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * @see Subject.Builder</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * @since 1.0</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> */</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> Subject createSubject(SubjectContext context);</a> |
| <span class="sourceLineNo">113</span><a id="line.113"></a> |
| <span class="sourceLineNo">114</span><a id="line.114">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
