| <!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:54 EST 2016 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| UsernamePasswordToken (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="UsernamePasswordToken (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/UsernamePasswordToken.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/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/authc/UsernamePasswordToken.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="UsernamePasswordToken.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.authc</FONT> |
| <BR> |
| Class UsernamePasswordToken</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.shiro.authc.UsernamePasswordToken</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><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="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A>, <A HREF="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</A>, <A HREF="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.45"><B>UsernamePasswordToken</B></A><DT>extends <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><DT>implements <A HREF="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</A>, <A HREF="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</A></DL> |
| </PRE> |
| |
| <P> |
| <p>A simple username/password authentication token to support the most widely-used authentication mechanism. This |
| class also implements the <A HREF="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc"><CODE>RememberMeAuthenticationToken</CODE></A> interface to support |
| "Remember Me" services across user sessions as well as the |
| <A HREF="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc"><CODE>HostAuthenticationToken</CODE></A> interface to retain the host name |
| or IP address location from where the authentication attempt is occuring.</p> |
| <p/> |
| <p>"Remember Me" authentications are disabled by default, but if the application developer wishes to allow |
| it for a login attempt, all that is necessary is to call <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#setRememberMe(boolean)"><CODE>setRememberMe(true)</CODE></A>. If the underlying |
| <tt>SecurityManager</tt> implementation also supports <tt>RememberMe</tt> services, the user's identity will be |
| remembered across sessions. |
| <p/> |
| <p>Note that this class stores a password as a char[] instead of a String |
| (which may seem more logical). This is because Strings are immutable and their |
| internal value cannot be overwritten - meaning even a nulled String instance might be accessible in memory at a later |
| time (e.g. memory dump). This is not good for sensitive information such as passwords. For more information, see the |
| <a href="http://java.sun.com/j2se/1.5.0/docs/guide/security/jce/JCERefGuide.html#PBEEx"> |
| Java Cryptography Extension Reference Guide</a>.</p> |
| <p/> |
| <p>To avoid this possibility of later memory access, the application developer should always call |
| <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#clear()"><CODE>clear()</CODE></A> after using the token to perform a login attempt.</p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.1</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.shiro.authc.UsernamePasswordToken">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken()">UsernamePasswordToken</A></B>()</CODE> |
| |
| <BR> |
| JavaBeans compatible no-arg constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[])">UsernamePasswordToken</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> username, |
| char[] password)</CODE> |
| |
| <BR> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><CODE>host</CODE></A> and a |
| <tt>rememberMe</tt> default of <tt>false</tt>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[], boolean)">UsernamePasswordToken</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> username, |
| char[] password, |
| boolean rememberMe)</CODE> |
| |
| <BR> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[], boolean, java.lang.String)">UsernamePasswordToken</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> username, |
| char[] password, |
| boolean rememberMe, |
| <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> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is ocurring.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, char[], java.lang.String)">UsernamePasswordToken</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> username, |
| char[] password, |
| <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> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String)">UsernamePasswordToken</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> username, |
| <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> password)</CODE> |
| |
| <BR> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><CODE>host</CODE></A> and |
| a <tt>rememberMe</tt> default of <tt>false</tt> |
| <p/></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String, boolean)">UsernamePasswordToken</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> username, |
| <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> password, |
| boolean rememberMe)</CODE> |
| |
| <BR> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String, boolean, java.lang.String)">UsernamePasswordToken</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> username, |
| <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> password, |
| boolean rememberMe, |
| <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> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is ocurring.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#UsernamePasswordToken(java.lang.String, java.lang.String, java.lang.String)">UsernamePasswordToken</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> username, |
| <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> password, |
| <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> |
| Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt> |
| <p/></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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clears out (nulls) the username, password, rememberMe, and inetAddress.</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/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getCredentials()">getCredentials</A></B>()</CODE> |
| |
| <BR> |
| Returns the <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()"><CODE>password</CODE></A> char array.</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/authc/UsernamePasswordToken.html#getHost()">getHost</A></B>()</CODE> |
| |
| <BR> |
| Returns the host name or IP string from where the authentication attempt occurs.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> char[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()">getPassword</A></B>()</CODE> |
| |
| <BR> |
| Returns the password submitted during an authentication attempt as a character array.</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/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPrincipal()">getPrincipal</A></B>()</CODE> |
| |
| <BR> |
| Simply returns <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()"><CODE>getUsername()</CODE></A>.</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/authc/UsernamePasswordToken.html#getUsername()">getUsername</A></B>()</CODE> |
| |
| <BR> |
| Returns the username submitted during an authentication attempt.</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/authc/UsernamePasswordToken.html#isRememberMe()">isRememberMe</A></B>()</CODE> |
| |
| <BR> |
| Returns <tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered |
| across sessions, <tt>false</tt> 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/authc/UsernamePasswordToken.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 string from where the authentication attempt occurs.</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/authc/UsernamePasswordToken.html#setPassword(char[])">setPassword</A></B>(char[] password)</CODE> |
| |
| <BR> |
| Sets the password for submission during an authentication attempt.</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/authc/UsernamePasswordToken.html#setRememberMe(boolean)">setRememberMe</A></B>(boolean rememberMe)</CODE> |
| |
| <BR> |
| Sets if the submitting user wishes their identity (pricipal(s)) to be remembered across sessions.</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/authc/UsernamePasswordToken.html#setUsername(java.lang.String)">setUsername</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> username)</CODE> |
| |
| <BR> |
| Sets the username for submission during an authentication attempt.</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/authc/UsernamePasswordToken.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| Returns the String representation.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="UsernamePasswordToken()"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.83"><B>UsernamePasswordToken</B></A>()</PRE> |
| <DL> |
| <DD>JavaBeans compatible no-arg constructor. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, char[])"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.94"><B>UsernamePasswordToken</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> username, |
| char[] password)</PRE> |
| <DL> |
| <DD>Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><CODE>host</CODE></A> and a |
| <tt>rememberMe</tt> default of <tt>false</tt>. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password character array submitted for authentication</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.110"><B>UsernamePasswordToken</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> username, |
| <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> password)</PRE> |
| <DL> |
| <DD>Constructs a new UsernamePasswordToken encapsulating the username and password submitted |
| during an authentication attempt, with a <tt>null</tt> <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getHost()"><CODE>host</CODE></A> and |
| a <tt>rememberMe</tt> default of <tt>false</tt> |
| <p/> |
| <p>This is a convience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password string submitted for authentication</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, char[], java.lang.String)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.123"><B>UsernamePasswordToken</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> username, |
| char[] password, |
| <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>Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password string submitted for authentication<DD><CODE>host</CODE> - the host name or IP string from where the attempt is occuring<DT><B>Since:</B></DT> |
| <DD>0.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.140"><B>UsernamePasswordToken</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> username, |
| <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> password, |
| <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>Constructs a new UsernamePasswordToken encapsulating the username and password submitted, the |
| inetAddress from where the attempt is occurring, and a default <tt>rememberMe</tt> value of <tt>false</tt> |
| <p/> |
| <p>This is a convience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password string submitted for authentication<DD><CODE>host</CODE> - the host name or IP string from where the attempt is occuring<DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, char[], boolean)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.153"><B>UsernamePasswordToken</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> username, |
| char[] password, |
| boolean rememberMe)</PRE> |
| <DL> |
| <DD>Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password string submitted for authentication<DD><CODE>rememberMe</CODE> - if the user wishes their identity to be remembered across sessions<DT><B>Since:</B></DT> |
| <DD>0.9</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.170"><B>UsernamePasswordToken</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> username, |
| <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> password, |
| boolean rememberMe)</PRE> |
| <DL> |
| <DD>Constructs a new UsernamePasswordToken encapsulating the username and password submitted, as well as if the user |
| wishes their identity to be remembered across sessions. |
| <p/> |
| <p>This is a convience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password string submitted for authentication<DD><CODE>rememberMe</CODE> - if the user wishes their identity to be remembered across sessions<DT><B>Since:</B></DT> |
| <DD>0.9</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, char[], boolean, java.lang.String)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.184"><B>UsernamePasswordToken</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> username, |
| char[] password, |
| boolean rememberMe, |
| <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>Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is ocurring. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password character array submitted for authentication<DD><CODE>rememberMe</CODE> - if the user wishes their identity to be remembered across sessions<DD><CODE>host</CODE> - the host name or IP string from where the attempt is occuring<DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="UsernamePasswordToken(java.lang.String, java.lang.String, boolean, java.lang.String)"><!-- --></A><H3> |
| UsernamePasswordToken</H3> |
| <PRE> |
| public <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.208"><B>UsernamePasswordToken</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> username, |
| <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> password, |
| boolean rememberMe, |
| <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>Constructs a new UsernamePasswordToken encapsulating the username and password submitted, if the user |
| wishes their identity to be remembered across sessions, and the inetAddress from where the attempt is ocurring. |
| <p/> |
| <p>This is a convience constructor and maintains the password internally via a character |
| array, i.e. <tt>password.toCharArray();</tt>. Note that storing a password as a String |
| in your code could have possible security implications as noted in the class JavaDoc.</p> |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username submitted for authentication<DD><CODE>password</CODE> - the password string submitted for authentication<DD><CODE>rememberMe</CODE> - if the user wishes their identity to be remembered across sessions<DD><CODE>host</CODE> - the host name or IP string from where the attempt is occuring<DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| </DL> |
| |
| <!-- ============ 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="getUsername()"><!-- --></A><H3> |
| getUsername</H3> |
| <PRE> |
| public <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/authc/UsernamePasswordToken.html#line.222"><B>getUsername</B></A>()</PRE> |
| <DL> |
| <DD>Returns the username submitted during an authentication attempt. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the username submitted during an authentication attempt.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUsername(java.lang.String)"><!-- --></A><H3> |
| setUsername</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.231"><B>setUsername</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> username)</PRE> |
| <DL> |
| <DD>Sets the username for submission during an authentication attempt. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>username</CODE> - the username to be used for submission during an authentication attempt.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPassword()"><!-- --></A><H3> |
| getPassword</H3> |
| <PRE> |
| public char[] <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.241"><B>getPassword</B></A>()</PRE> |
| <DL> |
| <DD>Returns the password submitted during an authentication attempt as a character array. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the password submitted during an authentication attempt as a character array.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPassword(char[])"><!-- --></A><H3> |
| setPassword</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.250"><B>setPassword</B></A>(char[] password)</PRE> |
| <DL> |
| <DD>Sets the password for submission during an authentication attempt. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>password</CODE> - the password to be used for submission during an authentication attemp.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrincipal()"><!-- --></A><H3> |
| getPrincipal</H3> |
| <PRE> |
| public <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> <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.260"><B>getPrincipal</B></A>()</PRE> |
| <DL> |
| <DD>Simply returns <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()"><CODE>getUsername()</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html#getPrincipal()">getPrincipal</A></CODE> in interface <CODE><A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getUsername()"><CODE>username</CODE></A>.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html#getPrincipal()"><CODE>AuthenticationToken.getPrincipal()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCredentials()"><!-- --></A><H3> |
| getCredentials</H3> |
| <PRE> |
| public <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> <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.270"><B>getCredentials</B></A>()</PRE> |
| <DL> |
| <DD>Returns the <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()"><CODE>password</CODE></A> char array. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html#getCredentials()">getCredentials</A></CODE> in interface <CODE><A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html" title="interface in org.apache.shiro.authc">AuthenticationToken</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <A HREF="../../../../org/apache/shiro/authc/UsernamePasswordToken.html#getPassword()"><CODE>password</CODE></A> char array.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/shiro/authc/AuthenticationToken.html#getCredentials()"><CODE>AuthenticationToken.getCredentials()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHost()"><!-- --></A><H3> |
| getHost</H3> |
| <PRE> |
| public <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/authc/UsernamePasswordToken.html#line.285"><B>getHost</B></A>()</PRE> |
| <DL> |
| <DD>Returns the host name or IP string from where the authentication attempt occurs. May be <tt>null</tt> if the |
| host name/IP is unknown or explicitly omitted. It is up to the Authenticator implementation processing this |
| token if an authentication attempt without a host is valid or not. |
| <p/> |
| <p>(Shiro's default Authenticator allows <tt>null</tt> hosts to support localhost and proxy server environments).</p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/shiro/authc/HostAuthenticationToken.html#getHost()">getHost</A></CODE> in interface <CODE><A HREF="../../../../org/apache/shiro/authc/HostAuthenticationToken.html" title="interface in org.apache.shiro.authc">HostAuthenticationToken</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the host from where the authentication attempt occurs, or <tt>null</tt> if it is unknown or |
| explicitly omitted.<DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setHost(java.lang.String)"><!-- --></A><H3> |
| setHost</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.299"><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 string from where the authentication attempt occurs. It is up to the Authenticator |
| implementation processing this token if an authentication attempt without a host is valid or not. |
| <p/> |
| <p>(Shiro's default Authenticator |
| allows <tt>null</tt> hosts to allow localhost and proxy server environments).</p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>host</CODE> - the host name or IP string from where the attempt is occuring<DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isRememberMe()"><!-- --></A><H3> |
| isRememberMe</H3> |
| <PRE> |
| public boolean <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.311"><B>isRememberMe</B></A>()</PRE> |
| <DL> |
| <DD>Returns <tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered |
| across sessions, <tt>false</tt> otherwise. Unless overridden, this value is <tt>false</tt> by default. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html#isRememberMe()">isRememberMe</A></CODE> in interface <CODE><A HREF="../../../../org/apache/shiro/authc/RememberMeAuthenticationToken.html" title="interface in org.apache.shiro.authc">RememberMeAuthenticationToken</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><tt>true</tt> if the submitting user wishes their identity (principal(s)) to be remembered |
| across sessions, <tt>false</tt> otherwise (<tt>false</tt> by default).<DT><B>Since:</B></DT> |
| <DD>0.9</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRememberMe(boolean)"><!-- --></A><H3> |
| setRememberMe</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.323"><B>setRememberMe</B></A>(boolean rememberMe)</PRE> |
| <DL> |
| <DD>Sets if the submitting user wishes their identity (pricipal(s)) to be remembered across sessions. Unless |
| overridden, the default value is <tt>false</tt>, indicating <em>not</em> to be remembered across sessions. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>rememberMe</CODE> - value inidicating if the user wishes their identity (principal(s)) to be remembered across |
| sessions.<DT><B>Since:</B></DT> |
| <DD>0.9</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| public void <A HREF="../../../../src-html/org/apache/shiro/authc/UsernamePasswordToken.html#line.335"><B>clear</B></A>()</PRE> |
| <DL> |
| <DD>Clears out (nulls) the username, password, rememberMe, and inetAddress. The password bytes are explicitly set to |
| <tt>0x00</tt> before nulling to eliminate the possibility of memory access at a later time. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public <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/authc/UsernamePasswordToken.html#line.357"><B>toString</B></A>()</PRE> |
| <DL> |
| <DD>Returns the String representation. It does not include the password in the resulting |
| string for security reasons to prevent accidentially printing out a password |
| that might be widely viewable). |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><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></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the String representation of the <tt>UsernamePasswordToken</tt>, omitting |
| the password.</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/UsernamePasswordToken.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/authc/UnknownAccountException.html" title="class in org.apache.shiro.authc"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/shiro/authc/UsernamePasswordToken.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="UsernamePasswordToken.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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> |
