| <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 java.util.Collection;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> /**<a name="line.23"></a> |
| <FONT color="green">024</FONT> * Enables Shiro end-users to configure and initialize one or more {@link Realm Realm} instances<a name="line.24"></a> |
| <FONT color="green">025</FONT> * in any manner desired.<a name="line.25"></a> |
| <FONT color="green">026</FONT> * <p/><a name="line.26"></a> |
| <FONT color="green">027</FONT> * This interface exists to support environments where end-users may not wish to use Shiro's default<a name="line.27"></a> |
| <FONT color="green">028</FONT> * text-based configuration to create and configure realms, and instead wish to retrieve a realm configured in a<a name="line.28"></a> |
| <FONT color="green">029</FONT> * proprietary manner. An implementation of this interface can access that proprietary mechanism to retrieve the<a name="line.29"></a> |
| <FONT color="green">030</FONT> * already-created <tt>Realm</tt>s.<a name="line.30"></a> |
| <FONT color="green">031</FONT> *<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <p>The <code>Realm</code> instances returned will used to construct the application's<a name="line.32"></a> |
| <FONT color="green">033</FONT> * {@link org.apache.shiro.mgt.SecurityManager SecurityManager} instance.<a name="line.33"></a> |
| <FONT color="green">034</FONT> *<a name="line.34"></a> |
| <FONT color="green">035</FONT> * @since 0.9<a name="line.35"></a> |
| <FONT color="green">036</FONT> */<a name="line.36"></a> |
| <FONT color="green">037</FONT> public interface RealmFactory {<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> /**<a name="line.39"></a> |
| <FONT color="green">040</FONT> * Returns a collection of {@link Realm Realm} instances that will be used to construct<a name="line.40"></a> |
| <FONT color="green">041</FONT> * the application's SecurityManager instance.<a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * <p>The order of the collection is important. The {@link org.apache.shiro.mgt.SecurityManager SecurityManager}<a name="line.43"></a> |
| <FONT color="green">044</FONT> * implementation will consult the Realms during authentication (log-in) and authorization (access control)<a name="line.44"></a> |
| <FONT color="green">045</FONT> * operations in the collection's <b>iteration order</b>. That is, the resulting collection's<a name="line.45"></a> |
| <FONT color="green">046</FONT> * {@link java.util.Iterator Iterator} determines the order in which Realms are used.<a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @return the <code>Collection</code> of Realms that the application's <code>SecurityManager</code> will use<a name="line.48"></a> |
| <FONT color="green">049</FONT> * for security data access.<a name="line.49"></a> |
| <FONT color="green">050</FONT> */<a name="line.50"></a> |
| <FONT color="green">051</FONT> Collection<Realm> getRealms();<a name="line.51"></a> |
| <FONT color="green">052</FONT> <a name="line.52"></a> |
| <FONT color="green">053</FONT> }<a name="line.53"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
