| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_65) on Fri Mar 04 17:58:56 EST 2016 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| SubjectContext (Apache Shiro 1.2.4 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2016-03-04"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SubjectContext (Apache Shiro 1.2.4 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SubjectContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/subject/SubjectContext.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SubjectContext.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.shiro.subject</FONT> |
| <BR> |
| Interface SubjectContext</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/shiro/web/subject/WebSubjectContext.html" title="interface in org.apache.shiro.web.subject">WebSubjectContext</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/shiro/subject/support/DefaultSubjectContext.html" title="class in org.apache.shiro.subject.support">DefaultSubjectContext</A>, <A HREF="../../../../org/apache/shiro/web/subject/support/DefaultWebSubjectContext.html" title="class in org.apache.shiro.web.subject.support">DefaultWebSubjectContext</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.59"><B>SubjectContext</B></A><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></DL> |
| </PRE> |
| |
| <P> |
| A <code>SubjectContext</code> is a 'bucket' of data presented to a <A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><CODE>SecurityManager</CODE></A> which interprets |
| this data to construct <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instances. It is essentially a Map of data |
| with a few additional type-safe methods for easy retrieval of objects commonly used to construct Subject instances. |
| <p/> |
| While this interface contains type-safe setters and getters for common data types, the map can contain anything |
| additional that might be needed by the <A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><CODE>SecurityManager</CODE></A> or |
| <A HREF="../../../../org/apache/shiro/mgt/SubjectFactory.html" title="interface in org.apache.shiro.mgt"><CODE>SubjectFactory</CODE></A> implementation to construct <code>Subject</code> instances. |
| <h2>Data Resolution</h2> |
| The <A HREF="../../../../org/apache/shiro/subject/SubjectContext.html" title="interface in org.apache.shiro.subject"><CODE>SubjectContext</CODE></A> interface also allows for heuristic resolution of data used to construct a subject |
| instance. That is, if an attribute has not been explicitly provided via a setter method, the <code>resolve*</code> |
| methods can use heuristics to obtain that data in another way from other attributes. |
| <p/> |
| For example, if one calls <A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getPrincipals()"><CODE>getPrincipals()</CODE></A> and no principals are returned, perhaps the principals exist |
| in the <A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getSession()"><CODE>session</CODE></A> or another attribute in the context. The <A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#resolvePrincipals()"><CODE>resolvePrincipals()</CODE></A> will know |
| how to resolve the principals based on heuristics. If the <code>resolve*</code> methods return <code>null</code> then the |
| data could not be achieved by any heuristics and must be considered as not available in the context. |
| <p/> |
| The general idea is that the normal getters can be called to see if the value was explicitly set. The |
| <code>resolve*</code> methods should be used when actually constructing the <code>Subject</code> instance to ensure the most |
| specific/accurate data can be used. |
| <p/> |
| <b>USAGE</b>: Most Shiro end-users will never use a <code>SubjectContext</code> instance directly and instead will use a |
| <A HREF="../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject"><CODE>Subject.Builder</CODE></A> (which internally uses a <code>SubjectContext</code>) and build <code>Subject</code> instances that |
| way. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html#createSubject(org.apache.shiro.subject.SubjectContext)"><CODE>SecurityManager.createSubject</CODE></A>, |
| <A HREF="../../../../org/apache/shiro/mgt/SubjectFactory.html" title="interface in org.apache.shiro.mgt"><CODE>SubjectFactory</CODE></A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Nested Class Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="nested_classes_inherited_from_class_java.util.Map"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">K</A>,<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">V</A>></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getAuthenticationInfo()">getAuthenticationInfo</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getAuthenticationToken()">getAuthenticationToken</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getHost()">getHost</A></B>()</CODE> |
| |
| <BR> |
| Returns the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getPrincipals()">getPrincipals</A></B>()</CODE> |
| |
| <BR> |
| Returns the principals (aka identity) that the constructed <code>Subject</code> should reflect.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getSecurityManager()">getSecurityManager</A></B>()</CODE> |
| |
| <BR> |
| Returns the SecurityManager instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance or |
| <code>null</code> if one has not yet been provided to this context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getSession()">getSession</A></B>()</CODE> |
| |
| <BR> |
| Returns the <code>Session</code> to use when building the <code>Subject</code> instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getSessionId()">getSessionId</A></B>()</CODE> |
| |
| <BR> |
| Returns the session id of the session that should be associated with the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#getSubject()">getSubject</A></B>()</CODE> |
| |
| <BR> |
| Returns any existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#isAuthenticated()">isAuthenticated</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the constructed <code>Subject</code> should be considered authenticated, <code>false</code> |
| otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#isSessionCreationEnabled()">isSessionCreationEnabled</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the constructed <code>Subject</code> should be allowed to create a session, <code>false</code> |
| otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#resolveAuthenticated()">resolveAuthenticated</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#resolveHost()">resolveHost</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#resolvePrincipals()">resolvePrincipals</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#resolveSecurityManager()">resolveSecurityManager</A></B>()</CODE> |
| |
| <BR> |
| Resolves the <code>SecurityManager</code> instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> |
| instance (typically used to support <A HREF="../../../../org/apache/shiro/subject/support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><CODE>DelegatingSubject</CODE></A> implementations).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#resolveSession()">resolveSession</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setAuthenticated(boolean)">setAuthenticated</A></B>(boolean authc)</CODE> |
| |
| <BR> |
| Sets whether or not the constructed <code>Subject</code> instance should be considered as authenticated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setAuthenticationInfo(org.apache.shiro.authc.AuthenticationInfo)">setAuthenticationInfo</A></B>(<A HREF="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</A> info)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setAuthenticationToken(org.apache.shiro.authc.AuthenticationToken)">setAuthenticationToken</A></B>(<A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A> token)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setHost(java.lang.String)">setHost</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> host)</CODE> |
| |
| <BR> |
| Sets the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setPrincipals(org.apache.shiro.subject.PrincipalCollection)">setPrincipals</A></B>(<A HREF="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</A> principals)</CODE> |
| |
| <BR> |
| Sets the principals (aka identity) that the constructed <code>Subject</code> should reflect.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSecurityManager(org.apache.shiro.mgt.SecurityManager)">setSecurityManager</A></B>(<A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</A> securityManager)</CODE> |
| |
| <BR> |
| Sets the SecurityManager instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance |
| (typically used to support <A HREF="../../../../org/apache/shiro/subject/support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><CODE>DelegatingSubject</CODE></A> implementations).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSession(org.apache.shiro.session.Session)">setSession</A></B>(<A HREF="../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</A> session)</CODE> |
| |
| <BR> |
| Sets the <code>Session</code> to use when building the <code>Subject</code> instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSessionCreationEnabled(boolean)">setSessionCreationEnabled</A></B>(boolean enabled)</CODE> |
| |
| <BR> |
| Sets whether or not the constructed <code>Subject</code> instance should be allowed to create a session, |
| <code>false</code> otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSessionId(java.io.Serializable)">setSessionId</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A> sessionId)</CODE> |
| |
| <BR> |
| Sets the session id of the session that should be associated with the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSubject(org.apache.shiro.subject.Subject)">setSubject</A></B>(<A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</A> subject)</CODE> |
| |
| <BR> |
| Sets the existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.util.Map"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface java.util.<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util">clear</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#containsKey(java.lang.Object)" title="class or interface in java.util">containsKey</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#containsValue(java.lang.Object)" title="class or interface in java.util">containsValue</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#entrySet()" title="class or interface in java.util">entrySet</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#get(java.lang.Object)" title="class or interface in java.util">get</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#hashCode()" title="class or interface in java.util">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util">isEmpty</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util">keySet</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#put(K, V)" title="class or interface in java.util">put</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#putAll(java.util.Map)" title="class or interface in java.util">putAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util">remove</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#size()" title="class or interface in java.util">size</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true#values()" title="class or interface in java.util">values</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getSecurityManager()"><!-- --></A><H3> |
| getSecurityManager</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.68"><B>getSecurityManager</B></A>()</PRE> |
| <DL> |
| <DD>Returns the SecurityManager instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance or |
| <code>null</code> if one has not yet been provided to this context. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the SecurityManager instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance or |
| <code>null</code> if one has not yet been provided to this context.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSecurityManager(org.apache.shiro.mgt.SecurityManager)"><!-- --></A><H3> |
| setSecurityManager</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.77"><B>setSecurityManager</B></A>(<A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</A> securityManager)</PRE> |
| <DL> |
| <DD>Sets the SecurityManager instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance |
| (typically used to support <A HREF="../../../../org/apache/shiro/subject/support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><CODE>DelegatingSubject</CODE></A> implementations). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>securityManager</CODE> - the SecurityManager instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> |
| instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveSecurityManager()"><!-- --></A><H3> |
| resolveSecurityManager</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.86"><B>resolveSecurityManager</B></A>()</PRE> |
| <DL> |
| <DD>Resolves the <code>SecurityManager</code> instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> |
| instance (typically used to support <A HREF="../../../../org/apache/shiro/subject/support/DelegatingSubject.html" title="class in org.apache.shiro.subject.support"><CODE>DelegatingSubject</CODE></A> implementations). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>SecurityManager</code> instance that should be used to back the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> |
| instance</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSessionId()"><!-- --></A><H3> |
| getSessionId</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.96"><B>getSessionId</B></A>()</PRE> |
| <DL> |
| <DD>Returns the session id of the session that should be associated with the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance. |
| <p/> |
| The construction process is expected to resolve the session with the specified id and then construct the Subject |
| instance based on the resolved session. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the session id of the session that should be associated with the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSessionId(java.io.Serializable)"><!-- --></A><H3> |
| setSessionId</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.107"><B>setSessionId</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A> sessionId)</PRE> |
| <DL> |
| <DD>Sets the session id of the session that should be associated with the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> instance. |
| <p/> |
| The construction process is expected to resolve the session with the specified id and then construct the Subject |
| instance based on the resolved session. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sessionId</CODE> - the session id of the session that should be associated with the constructed <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><CODE>Subject</CODE></A> |
| instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSubject()"><!-- --></A><H3> |
| getSubject</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.121"><B>getSubject</B></A>()</PRE> |
| <DL> |
| <DD>Returns any existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created. |
| <p/> |
| This is typically used in the case where the existing <code>Subject</code> instance returned by |
| this method is unauthenticated and a new <code>Subject</code> instance is being created to reflect a successful |
| authentication - you want to return most of the state of the previous <code>Subject</code> instance when creating the |
| newly authenticated instance. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>any existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSubject(org.apache.shiro.subject.Subject)"><!-- --></A><H3> |
| setSubject</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.135"><B>setSubject</B></A>(<A HREF="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</A> subject)</PRE> |
| <DL> |
| <DD>Sets the existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created. |
| <p/> |
| This is typically used in the case where the existing <code>Subject</code> instance returned by |
| this method is unauthenticated and a new <code>Subject</code> instance is being created to reflect a successful |
| authentication - you want to return most of the state of the previous <code>Subject</code> instance when creating the |
| newly authenticated instance. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>subject</CODE> - the existing <code>Subject</code> that may be in use at the time the new <code>Subject</code> instance is |
| being created.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrincipals()"><!-- --></A><H3> |
| getPrincipals</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.142"><B>getPrincipals</B></A>()</PRE> |
| <DL> |
| <DD>Returns the principals (aka identity) that the constructed <code>Subject</code> should reflect. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the principals (aka identity) that the constructed <code>Subject</code> should reflect.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolvePrincipals()"><!-- --></A><H3> |
| resolvePrincipals</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.144"><B>resolvePrincipals</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrincipals(org.apache.shiro.subject.PrincipalCollection)"><!-- --></A><H3> |
| setPrincipals</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.151"><B>setPrincipals</B></A>(<A HREF="../../../../org/apache/shiro/subject/PrincipalCollection.html" title="interface in org.apache.shiro.subject">PrincipalCollection</A> principals)</PRE> |
| <DL> |
| <DD>Sets the principals (aka identity) that the constructed <code>Subject</code> should reflect. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>principals</CODE> - the principals (aka identity) that the constructed <code>Subject</code> should reflect.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSession()"><!-- --></A><H3> |
| getSession</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.160"><B>getSession</B></A>()</PRE> |
| <DL> |
| <DD>Returns the <code>Session</code> to use when building the <code>Subject</code> instance. Note that it is more |
| common to specify a <A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSessionId(java.io.Serializable)"><CODE>sessionId</CODE></A> to acquire the desired session rather than having to |
| construct a <code>Session</code> to be returned by this method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>Session</code> to use when building the <code>Subject</code> instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSession(org.apache.shiro.session.Session)"><!-- --></A><H3> |
| setSession</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.169"><B>setSession</B></A>(<A HREF="../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</A> session)</PRE> |
| <DL> |
| <DD>Sets the <code>Session</code> to use when building the <code>Subject</code> instance. Note that it is more |
| common to specify a <A HREF="../../../../org/apache/shiro/subject/SubjectContext.html#setSessionId(java.io.Serializable)"><CODE>sessionId</CODE></A> to automatically resolve the desired session rather than |
| constructing a <code>Session</code> to call this method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>session</CODE> - the <code>Session</code> to use when building the <code>Subject</code> instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveSession()"><!-- --></A><H3> |
| resolveSession</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/session/Session.html" title="interface in org.apache.shiro.session">Session</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.171"><B>resolveSession</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isAuthenticated()"><!-- --></A><H3> |
| isAuthenticated</H3> |
| <PRE> |
| boolean <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.181"><B>isAuthenticated</B></A>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if the constructed <code>Subject</code> should be considered authenticated, <code>false</code> |
| otherwise. Be careful setting this value to <code>true</code> - you should know what you are doing and have a good |
| reason for ignoring Shiro's default authentication state mechanisms. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if the constructed <code>Subject</code> should be considered authenticated, <code>false</code> |
| otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAuthenticated(boolean)"><!-- --></A><H3> |
| setAuthenticated</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.190"><B>setAuthenticated</B></A>(boolean authc)</PRE> |
| <DL> |
| <DD>Sets whether or not the constructed <code>Subject</code> instance should be considered as authenticated. Be careful |
| when specifying <code>true</code> - you should know what you are doing and have a good reason for ignoring Shiro's |
| default authentication state mechanisms. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>authc</CODE> - whether or not the constructed <code>Subject</code> instance should be considered as authenticated.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSessionCreationEnabled()"><!-- --></A><H3> |
| isSessionCreationEnabled</H3> |
| <PRE> |
| boolean <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.200"><B>isSessionCreationEnabled</B></A>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if the constructed <code>Subject</code> should be allowed to create a session, <code>false</code> |
| otherwise. Shiro's configuration defaults to <code>true</code> as most applications find value in Sessions. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if the constructed <code>Subject</code> should be allowed to create sessions, <code>false</code> |
| otherwise.<DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSessionCreationEnabled(boolean)"><!-- --></A><H3> |
| setSessionCreationEnabled</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.210"><B>setSessionCreationEnabled</B></A>(boolean enabled)</PRE> |
| <DL> |
| <DD>Sets whether or not the constructed <code>Subject</code> instance should be allowed to create a session, |
| <code>false</code> otherwise. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>enabled</CODE> - whether or not the constructed <code>Subject</code> instance should be allowed to create a session, |
| <code>false</code> otherwise.<DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveAuthenticated()"><!-- --></A><H3> |
| resolveAuthenticated</H3> |
| <PRE> |
| boolean <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.212"><B>resolveAuthenticated</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAuthenticationInfo()"><!-- --></A><H3> |
| getAuthenticationInfo</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.214"><B>getAuthenticationInfo</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAuthenticationInfo(org.apache.shiro.authc.AuthenticationInfo)"><!-- --></A><H3> |
| setAuthenticationInfo</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.216"><B>setAuthenticationInfo</B></A>(<A HREF="../../../../org/apache/shiro/authc/AuthenticationInfo.html" title="interface in org.apache.shiro.authc">AuthenticationInfo</A> info)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAuthenticationToken()"><!-- --></A><H3> |
| getAuthenticationToken</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.218"><B>getAuthenticationToken</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAuthenticationToken(org.apache.shiro.authc.AuthenticationToken)"><!-- --></A><H3> |
| setAuthenticationToken</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.220"><B>setAuthenticationToken</B></A>(<A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A> token)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHost()"><!-- --></A><H3> |
| getHost</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.227"><B>getHost</B></A>()</PRE> |
| <DL> |
| <DD>Returns the host name or IP that should reflect the constructed <code>Subject</code>'s originating location. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setHost(java.lang.String)"><!-- --></A><H3> |
| setHost</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.234"><B>setHost</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> host)</PRE> |
| <DL> |
| <DD>Sets the host name or IP that should reflect the constructed <code>Subject</code>'s originating location. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>host</CODE> - the host name or IP that should reflect the constructed <code>Subject</code>'s originating location.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveHost()"><!-- --></A><H3> |
| resolveHost</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/shiro/subject/SubjectContext.html#line.236"><B>resolveHost</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SubjectContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/shiro/subject/Subject.Builder.html" title="class in org.apache.shiro.subject"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/subject/SubjectContext.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SubjectContext.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |