Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.4 / apidocs / src-html / org / apache / shiro / mgt / SubjectDAO.html
blob: aa21cc2d53eaf298f081a7f2f9ebb208a612e40e [file] [log] [blame]
<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.subject.Subject;<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> * A {@code SubjectDAO} is responsible for persisting a Subject instance's internal state such that the Subject instance<a name="line.24"></a>
<FONT color="green">025</FONT> * can be recreated at a later time if necessary.<a name="line.25"></a>
<FONT color="green">026</FONT> * &lt;p/&gt;<a name="line.26"></a>
<FONT color="green">027</FONT> * Shiro's default {@code SecurityManager} implementations typically use a {@code SubjectDAO} in conjunction<a name="line.27"></a>
<FONT color="green">028</FONT> * with a {@link SubjectFactory}: after the {@code SubjectFactory} creates a {@code Subject} instance, the<a name="line.28"></a>
<FONT color="green">029</FONT> * {@code SubjectDAO} is used to persist that subject's state such that it can be accessed later if necessary.<a name="line.29"></a>
<FONT color="green">030</FONT> * &lt;h3&gt;Usage&lt;/h3&gt;<a name="line.30"></a>
<FONT color="green">031</FONT> * It should be noted that this component is used by {@code SecurityManager} implementations to manage Subject<a name="line.31"></a>
<FONT color="green">032</FONT> * state persistence. It does &lt;em&gt;not&lt;/em&gt; make Subject instances accessible to the<a name="line.32"></a>
<FONT color="green">033</FONT> * application (e.g. via {@link org.apache.shiro.SecurityUtils#getSubject() SecurityUtils.getSubject()}).<a name="line.33"></a>
<FONT color="green">034</FONT> *<a name="line.34"></a>
<FONT color="green">035</FONT> * @see DefaultSubjectDAO<a name="line.35"></a>
<FONT color="green">036</FONT> * @since 1.2<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public interface SubjectDAO {<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * Persists the specified Subject's state for later access. If there is a no existing state persisted, this<a name="line.41"></a>
<FONT color="green">042</FONT> * persists it if possible (i.e. a create operation). If there is existing state for the specified {@code Subject},<a name="line.42"></a>
<FONT color="green">043</FONT> * this method updates the existing state to reflect the current state (i.e. an update operation).<a name="line.43"></a>
<FONT color="green">044</FONT> *<a name="line.44"></a>
<FONT color="green">045</FONT> * @param subject the Subject instance for which its state will be created or updated.<a name="line.45"></a>
<FONT color="green">046</FONT> * @return the Subject instance to use after persistence is complete. This can be the same as the method argument<a name="line.46"></a>
<FONT color="green">047</FONT> * if the underlying implementation does not need to make any Subject changes.<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> Subject save(Subject subject);<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Removes any persisted state for the specified {@code Subject} instance. This is a delete operation such that<a name="line.52"></a>
<FONT color="green">053</FONT> * the Subject's state will not be accessible at a later time.<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * @param subject the Subject instance for which any persistent state should be deleted.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> void delete(Subject subject);<a name="line.57"></a>
<FONT color="green">058</FONT> }<a name="line.58"></a>
</PRE>
</BODY>
</HTML>