| <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.realm;<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.AuthenticationInfo;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> /**<a name="line.25"></a> |
| <FONT color="green">026</FONT> * A <tt>Realm</tt> is a security component that can access application-specific security entities<a name="line.26"></a> |
| <FONT color="green">027</FONT> * such as users, roles, and permissions to determine authentication and authorization operations.<a name="line.27"></a> |
| <FONT color="green">028</FONT> *<a name="line.28"></a> |
| <FONT color="green">029</FONT> * <p><tt>Realm</tt>s usually have a 1-to-1 correspondance with a datasource such as a relational database,<a name="line.29"></a> |
| <FONT color="green">030</FONT> * file sysetem, or other similar resource. As such, implementations of this interface use datasource-specific APIs to<a name="line.30"></a> |
| <FONT color="green">031</FONT> * determine authorization data (roles, permissions, etc), such as JDBC, File IO, Hibernate or JPA, or any other<a name="line.31"></a> |
| <FONT color="green">032</FONT> * Data Access API. They are essentially security-specific<a name="line.32"></a> |
| <FONT color="green">033</FONT> * <a href="http://en.wikipedia.org/wiki/Data_Access_Object" target="_blank">DAO</a>s.<a name="line.33"></a> |
| <FONT color="green">034</FONT> *<a name="line.34"></a> |
| <FONT color="green">035</FONT> * <p>Because most of these datasources usually contain Subject (a.k.a. User) information such as usernames and<a name="line.35"></a> |
| <FONT color="green">036</FONT> * passwords, a Realm can act as a pluggable authentication module in a<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <a href="http://en.wikipedia.org/wiki/Pluggable_Authentication_Modules">PAM</a> configuration. This allows a Realm to<a name="line.37"></a> |
| <FONT color="green">038</FONT> * perform <i>both</i> authentication and authorization duties for a single datasource, which caters to the large<a name="line.38"></a> |
| <FONT color="green">039</FONT> * majority of applications. If for some reason you don't want your Realm implementation to perform authentication<a name="line.39"></a> |
| <FONT color="green">040</FONT> * duties, you should override the {@link #supports(org.apache.shiro.authc.AuthenticationToken)} method to always<a name="line.40"></a> |
| <FONT color="green">041</FONT> * return <tt>false</tt>.<a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * <p>Because every application is different, security data such as users and roles can be<a name="line.43"></a> |
| <FONT color="green">044</FONT> * represented in any number of ways. Shiro tries to maintain a non-intrusive development philosophy whenever<a name="line.44"></a> |
| <FONT color="green">045</FONT> * possible - it does not require you to implement or extend any <tt>User</tt>, <tt>Group</tt> or <tt>Role</tt><a name="line.45"></a> |
| <FONT color="green">046</FONT> * interfaces or classes.<a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p>Instead, Shiro allows applications to implement this interface to access environment-specific datasources<a name="line.48"></a> |
| <FONT color="green">049</FONT> * and data model objects. The implementation can then be plugged in to the application's Shiro configuration.<a name="line.49"></a> |
| <FONT color="green">050</FONT> * This modular technique abstracts away any environment/modeling details and allows Shiro to be deployed in<a name="line.50"></a> |
| <FONT color="green">051</FONT> * practically any application environment.<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * <p>Most users will not implement the <tt>Realm</tt> interface directly, but will extend one of the subclasses,<a name="line.53"></a> |
| <FONT color="green">054</FONT> * {@link org.apache.shiro.realm.AuthenticatingRealm AuthenticatingRealm} or {@link org.apache.shiro.realm.AuthorizingRealm}, greatly reducing the effort requird<a name="line.54"></a> |
| <FONT color="green">055</FONT> * to implement a <tt>Realm</tt> from scratch.</p><a name="line.55"></a> |
| <FONT color="green">056</FONT> *<a name="line.56"></a> |
| <FONT color="green">057</FONT> * @see org.apache.shiro.realm.CachingRealm CachingRealm<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @see org.apache.shiro.realm.AuthenticatingRealm AuthenticatingRealm<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @see org.apache.shiro.realm.AuthorizingRealm AuthorizingRealm<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @see org.apache.shiro.authc.pam.ModularRealmAuthenticator ModularRealmAuthenticator<a name="line.60"></a> |
| <FONT color="green">061</FONT> * @since 0.1<a name="line.61"></a> |
| <FONT color="green">062</FONT> */<a name="line.62"></a> |
| <FONT color="green">063</FONT> public interface Realm {<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * Returns the (application-unique) name assigned to this <code>Realm</code>. All realms configured for a single<a name="line.66"></a> |
| <FONT color="green">067</FONT> * application must have a unique name.<a name="line.67"></a> |
| <FONT color="green">068</FONT> *<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @return the (application-unique) name assigned to this <code>Realm</code>.<a name="line.69"></a> |
| <FONT color="green">070</FONT> */<a name="line.70"></a> |
| <FONT color="green">071</FONT> String getName();<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> * Returns <tt>true</tt> if this realm wishes to authenticate the Subject represented by the given<a name="line.74"></a> |
| <FONT color="green">075</FONT> * {@link org.apache.shiro.authc.AuthenticationToken AuthenticationToken} instance, <tt>false</tt> otherwise.<a name="line.75"></a> |
| <FONT color="green">076</FONT> *<a name="line.76"></a> |
| <FONT color="green">077</FONT> * <p>If this method returns <tt>false</tt>, it will not be called to authenticate the Subject represented by<a name="line.77"></a> |
| <FONT color="green">078</FONT> * the token - more specifically, a <tt>false</tt> return value means this Realm instance's<a name="line.78"></a> |
| <FONT color="green">079</FONT> * {@link #getAuthenticationInfo} method will not be invoked for that token.<a name="line.79"></a> |
| <FONT color="green">080</FONT> *<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @param token the AuthenticationToken submitted for the authentication attempt<a name="line.81"></a> |
| <FONT color="green">082</FONT> * @return <tt>true</tt> if this realm can/will authenticate Subjects represented by specified token,<a name="line.82"></a> |
| <FONT color="green">083</FONT> * <tt>false</tt> otherwise.<a name="line.83"></a> |
| <FONT color="green">084</FONT> */<a name="line.84"></a> |
| <FONT color="green">085</FONT> boolean supports(AuthenticationToken token);<a name="line.85"></a> |
| <FONT color="green">086</FONT> <a name="line.86"></a> |
| <FONT color="green">087</FONT> /**<a name="line.87"></a> |
| <FONT color="green">088</FONT> * Returns an account's authentication-specific information for the specified <tt>token</tt>,<a name="line.88"></a> |
| <FONT color="green">089</FONT> * or <tt>null</tt> if no account could be found based on the <tt>token</tt>.<a name="line.89"></a> |
| <FONT color="green">090</FONT> *<a name="line.90"></a> |
| <FONT color="green">091</FONT> * <p>This method effectively represents a login attempt for the corresponding user with the underlying EIS datasource.<a name="line.91"></a> |
| <FONT color="green">092</FONT> * Most implementations merely just need to lookup and return the account data only (as the method name implies)<a name="line.92"></a> |
| <FONT color="green">093</FONT> * and let Shiro do the rest, but implementations may of course perform eis specific login operations if so<a name="line.93"></a> |
| <FONT color="green">094</FONT> * desired.<a name="line.94"></a> |
| <FONT color="green">095</FONT> *<a name="line.95"></a> |
| <FONT color="green">096</FONT> * @param token the application-specific representation of an account principal and credentials.<a name="line.96"></a> |
| <FONT color="green">097</FONT> * @return the authentication information for the account associated with the specified <tt>token</tt>,<a name="line.97"></a> |
| <FONT color="green">098</FONT> * or <tt>null</tt> if no account could be found.<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @throws org.apache.shiro.authc.AuthenticationException<a name="line.99"></a> |
| <FONT color="green">100</FONT> * if there is an error obtaining or constructing an AuthenticationInfo object based on the<a name="line.100"></a> |
| <FONT color="green">101</FONT> * specified <tt>token</tt> or implementation-specifc login behavior fails.<a name="line.101"></a> |
| <FONT color="green">102</FONT> */<a name="line.102"></a> |
| <FONT color="green">103</FONT> AuthenticationInfo getAuthenticationInfo(AuthenticationToken token) throws AuthenticationException;<a name="line.103"></a> |
| <FONT color="green">104</FONT> <a name="line.104"></a> |
| <FONT color="green">105</FONT> }<a name="line.105"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
