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