| <!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 Tue Feb 25 18:15:53 EST 2014 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| RedirectView (Apache Shiro 1.2.3 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2014-02-25"> |
| |
| <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="RedirectView (Apache Shiro 1.2.3 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/RedirectView.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"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/shiro/web/util/RequestPairSource.html" title="interface in org.apache.shiro.web.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/shiro/web/util/RedirectView.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="RedirectView.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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.web.util</FONT> |
| <BR> |
| Class RedirectView</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.web.util.RedirectView</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.63"><B>RedirectView</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></DL> |
| </PRE> |
| |
| <P> |
| View that redirects to an absolute, context relative, or current request |
| relative URL, exposing all model attributes as HTTP query parameters. |
| <p/> |
| A URL for this view is supposed to be a HTTP redirect URL, i.e. |
| suitable for HttpServletResponse's <code>sendRedirect</code> method, which |
| is what actually does the redirect if the HTTP 1.0 flag is on, or via sending |
| back an HTTP 303 code - if the HTTP 1.0 compatibility flag is off. |
| <p/> |
| Note that while the default value for the "contextRelative" flag is off, |
| you will probably want to almost always set it to true. With the flag off, |
| URLs starting with "/" are considered relative to the web server root, while |
| with the flag on, they are considered relative to the web application root. |
| Since most web apps will never know or care what their context path actually |
| is, they are much better off setting this flag to true, and submitting paths |
| which are to be considered relative to the web application root. |
| <p/> |
| Note that in a Servlet 2.2 environment, i.e. a servlet container which |
| is only compliant to the limits of this spec, this class will probably fail |
| when feeding in URLs which are not fully absolute, or relative to the current |
| request (no leading "/"), as these are the only two types of URL that |
| <code>sendRedirect</code> supports in a Servlet 2.2 environment. |
| <p/> |
| <em>This class was borrowed from a nearly identical version found in |
| the <a href="http://www.springframework.org/">Spring Framework</a>, with minor modifications to |
| avoid a dependency on Spring itself for a very small amount of code - we couldn't have done it better, and |
| don't want to repeat all of their great effort ;). |
| The original author names and copyright (Apache 2.0) has been left in place. A special |
| thanks to Rod Johnson, Juergen Hoeller, and Colin Sampaleanu for making this available.</em> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.2</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#setContextRelative(boolean)"><CODE>setContextRelative(boolean)</CODE></A>, |
| <A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#setHttp10Compatible(boolean)"><CODE>setHttp10Compatible(boolean)</CODE></A>, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletResponse.html?is-external=true#sendRedirect(java.lang.String)" title="class or interface in javax.servlet.http"><CODE>HttpServletResponse.sendRedirect(java.lang.String)</CODE></A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <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/web/util/RedirectView.html#DEFAULT_ENCODING_SCHEME">DEFAULT_ENCODING_SCHEME</A></B></CODE> |
| |
| <BR> |
| The default encoding scheme: UTF-8</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== 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/web/util/RedirectView.html#RedirectView()">RedirectView</A></B>()</CODE> |
| |
| <BR> |
| Constructor for use as a bean.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#RedirectView(java.lang.String)">RedirectView</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> url)</CODE> |
| |
| <BR> |
| Create a new RedirectView with the given URL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#RedirectView(java.lang.String, boolean)">RedirectView</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> url, |
| boolean contextRelative)</CODE> |
| |
| <BR> |
| Create a new RedirectView with the given URL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#RedirectView(java.lang.String, boolean, boolean)">RedirectView</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> url, |
| boolean contextRelative, |
| boolean http10Compatible)</CODE> |
| |
| <BR> |
| Create a new RedirectView with the given URL.</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>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#appendQueryProperties(java.lang.StringBuilder, java.util.Map, java.lang.String)">appendQueryProperties</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> targetUrl, |
| <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> model, |
| <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> encodingScheme)</CODE> |
| |
| <BR> |
| Append query properties to the redirect URL.</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/web/util/RedirectView.html#getUrl()">getUrl</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#queryProperties(java.util.Map)">queryProperties</A></B>(<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> model)</CODE> |
| |
| <BR> |
| Determine name-value pairs for query strings, which will be stringified, |
| URL-encoded and formatted by appendQueryProperties.</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/web/util/RedirectView.html#renderMergedOutputModel(java.util.Map, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">renderMergedOutputModel</A></B>(<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> model, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</A> response)</CODE> |
| |
| <BR> |
| Convert model to request parameters and redirect to the given URL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, boolean)">sendRedirect</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, |
| <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> targetUrl, |
| boolean http10Compatible)</CODE> |
| |
| <BR> |
| Send a redirect back to the HTTP client</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/web/util/RedirectView.html#setContextRelative(boolean)">setContextRelative</A></B>(boolean contextRelative)</CODE> |
| |
| <BR> |
| Set whether to interpret a given URL that starts with a slash ("/") |
| as relative to the current ServletContext, i.e.</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/web/util/RedirectView.html#setEncodingScheme(java.lang.String)">setEncodingScheme</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> encodingScheme)</CODE> |
| |
| <BR> |
| Set the encoding scheme for this view.</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/web/util/RedirectView.html#setHttp10Compatible(boolean)">setHttp10Compatible</A></B>(boolean http10Compatible)</CODE> |
| |
| <BR> |
| Set whether to stay compatible with HTTP 1.0 clients.</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/web/util/RedirectView.html#setUrl(java.lang.String)">setUrl</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> url)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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/web/util/RedirectView.html#urlEncode(java.lang.String, java.lang.String)">urlEncode</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> input, |
| <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> encodingScheme)</CODE> |
| |
| <BR> |
| URL-encode the given input String with the given encoding scheme, using |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URLEncoder.html?is-external=true#encode(java.lang.String, java.lang.String)" title="class or interface in java.net"><CODE>URLEncoder.encode(input, enc)</CODE></A>.</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#toString()" title="class or interface in java.lang">toString</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> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DEFAULT_ENCODING_SCHEME"><!-- --></A><H3> |
| DEFAULT_ENCODING_SCHEME</H3> |
| <PRE> |
| public static final <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/web/util/RedirectView.html#line.70"><B>DEFAULT_ENCODING_SCHEME</B></A></PRE> |
| <DL> |
| <DD>The default encoding scheme: UTF-8 |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.shiro.web.util.RedirectView.DEFAULT_ENCODING_SCHEME">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= 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="RedirectView()"><!-- --></A><H3> |
| RedirectView</H3> |
| <PRE> |
| public <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.84"><B>RedirectView</B></A>()</PRE> |
| <DL> |
| <DD>Constructor for use as a bean. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="RedirectView(java.lang.String)"><!-- --></A><H3> |
| RedirectView</H3> |
| <PRE> |
| public <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.95"><B>RedirectView</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> url)</PRE> |
| <DL> |
| <DD>Create a new RedirectView with the given URL. |
| <p>The given URL will be considered as relative to the web server, |
| not as relative to the current ServletContext. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL to redirect to<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#RedirectView(java.lang.String, boolean)"><CODE>RedirectView(String, boolean)</CODE></A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="RedirectView(java.lang.String, boolean)"><!-- --></A><H3> |
| RedirectView</H3> |
| <PRE> |
| public <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.106"><B>RedirectView</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> url, |
| boolean contextRelative)</PRE> |
| <DL> |
| <DD>Create a new RedirectView with the given URL. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL to redirect to<DD><CODE>contextRelative</CODE> - whether to interpret the given URL as |
| relative to the current ServletContext</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="RedirectView(java.lang.String, boolean, boolean)"><!-- --></A><H3> |
| RedirectView</H3> |
| <PRE> |
| public <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.119"><B>RedirectView</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> url, |
| boolean contextRelative, |
| boolean http10Compatible)</PRE> |
| <DL> |
| <DD>Create a new RedirectView with the given URL. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - the URL to redirect to<DD><CODE>contextRelative</CODE> - whether to interpret the given URL as |
| relative to the current ServletContext<DD><CODE>http10Compatible</CODE> - whether to stay compatible with HTTP 1.0 clients</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="getUrl()"><!-- --></A><H3> |
| getUrl</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/web/util/RedirectView.html#line.126"><B>getUrl</B></A>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUrl(java.lang.String)"><!-- --></A><H3> |
| setUrl</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.130"><B>setUrl</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> url)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContextRelative(boolean)"><!-- --></A><H3> |
| setContextRelative</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.148"><B>setContextRelative</B></A>(boolean contextRelative)</PRE> |
| <DL> |
| <DD>Set whether to interpret a given URL that starts with a slash ("/") |
| as relative to the current ServletContext, i.e. as relative to the |
| web application root. |
| <p/> |
| Default is "false": A URL that starts with a slash will be interpreted |
| as absolute, i.e. taken as-is. If true, the context path will be |
| prepended to the URL in such a case. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>contextRelative</CODE> - whether to interpret a given URL that starts with a slash ("/") |
| as relative to the current ServletContext, i.e. as relative to the |
| web application root.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getContextPath()" title="class or interface in javax.servlet.http"><CODE>HttpServletRequest.getContextPath()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setHttp10Compatible(boolean)"><!-- --></A><H3> |
| setHttp10Compatible</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.165"><B>setHttp10Compatible</B></A>(boolean http10Compatible)</PRE> |
| <DL> |
| <DD>Set whether to stay compatible with HTTP 1.0 clients. |
| <p>In the default implementation, this will enforce HTTP status code 302 |
| in any case, i.e. delegate to <code>HttpServletResponse.sendRedirect</code>. |
| Turning this off will send HTTP status code 303, which is the correct |
| code for HTTP 1.1 clients, but not understood by HTTP 1.0 clients. |
| <p>Many HTTP 1.1 clients treat 302 just like 303, not making any |
| difference. However, some clients depend on 303 when redirecting |
| after a POST request; turn this flag off in such a scenario. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>http10Compatible</CODE> - whether to stay compatible with HTTP 1.0 clients.<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletResponse.html?is-external=true#sendRedirect(java.lang.String)" title="class or interface in javax.servlet.http"><CODE>HttpServletResponse.sendRedirect(java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setEncodingScheme(java.lang.String)"><!-- --></A><H3> |
| setEncodingScheme</H3> |
| <PRE> |
| public void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.175"><B>setEncodingScheme</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> encodingScheme)</PRE> |
| <DL> |
| <DD>Set the encoding scheme for this view. Default is UTF-8. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>encodingScheme</CODE> - the encoding scheme for this view. Default is UTF-8.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="renderMergedOutputModel(java.util.Map, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> |
| renderMergedOutputModel</H3> |
| <PRE> |
| public final void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.190"><B>renderMergedOutputModel</B></A>(<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> model, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</A> response) |
| throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Convert model to request parameters and redirect to the given URL. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>model</CODE> - the model to convert<DD><CODE>request</CODE> - the incoming HttpServletRequest<DD><CODE>response</CODE> - the outgoing HttpServletResponse |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if there is a problem issuing the redirect<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#appendQueryProperties(java.lang.StringBuilder, java.util.Map, java.lang.String)"><CODE>appendQueryProperties(java.lang.StringBuilder, java.util.Map, java.lang.String)</CODE></A>, |
| <A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, boolean)"><CODE>sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, boolean)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="appendQueryProperties(java.lang.StringBuilder, java.util.Map, java.lang.String)"><!-- --></A><H3> |
| appendQueryProperties</H3> |
| <PRE> |
| protected void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.218"><B>appendQueryProperties</B></A>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</A> targetUrl, |
| <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> model, |
| <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> encodingScheme) |
| throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></PRE> |
| <DL> |
| <DD>Append query properties to the redirect URL. |
| Stringifies, URL-encodes and formats model attributes as query properties. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>targetUrl</CODE> - the StringBuffer to append the properties to<DD><CODE>model</CODE> - Map that contains model attributes<DD><CODE>encodingScheme</CODE> - the encoding scheme to use |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></CODE> - if string encoding failed<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#urlEncode(java.lang.String, java.lang.String)"><CODE>urlEncode(java.lang.String, java.lang.String)</CODE></A>, |
| <A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#queryProperties(java.util.Map)"><CODE>queryProperties(java.util.Map)</CODE></A>, |
| <A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#urlEncode(java.lang.String, java.lang.String)"><CODE>urlEncode(String, String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="urlEncode(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| urlEncode</H3> |
| <PRE> |
| protected <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/web/util/RedirectView.html#line.268"><B>urlEncode</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> input, |
| <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> encodingScheme) |
| throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></PRE> |
| <DL> |
| <DD>URL-encode the given input String with the given encoding scheme, using |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URLEncoder.html?is-external=true#encode(java.lang.String, java.lang.String)" title="class or interface in java.net"><CODE>URLEncoder.encode(input, enc)</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>input</CODE> - the unencoded input String<DD><CODE>encodingScheme</CODE> - the encoding scheme |
| <DT><B>Returns:</B><DD>the encoded output String |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</A></CODE> - if thrown by the JDK URLEncoder<DT><B>See Also:</B><DD><A HREF="http://java.sun.com/javase/6/docs/api/java/net/URLEncoder.html?is-external=true#encode(java.lang.String, java.lang.String)" title="class or interface in java.net"><CODE>URLEncoder.encode(String, String)</CODE></A>, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URLEncoder.html?is-external=true#encode(java.lang.String)" title="class or interface in java.net"><CODE>URLEncoder.encode(String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="queryProperties(java.util.Map)"><!-- --></A><H3> |
| queryProperties</H3> |
| <PRE> |
| protected <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="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.282"><B>queryProperties</B></A>(<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> model)</PRE> |
| <DL> |
| <DD>Determine name-value pairs for query strings, which will be stringified, |
| URL-encoded and formatted by appendQueryProperties. |
| <p/> |
| This implementation returns all model elements as-is. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>model</CODE> - the model elements for which to determine name-value pairs. |
| <DT><B>Returns:</B><DD>the name-value pairs for query strings.<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/shiro/web/util/RedirectView.html#appendQueryProperties(java.lang.StringBuilder, java.util.Map, java.lang.String)"><CODE>appendQueryProperties(java.lang.StringBuilder, java.util.Map, java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, boolean)"><!-- --></A><H3> |
| sendRedirect</H3> |
| <PRE> |
| protected void <A HREF="../../../../../src-html/org/apache/shiro/web/util/RedirectView.html#line.296"><B>sendRedirect</B></A>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</A> request, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletResponse</A> response, |
| <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> targetUrl, |
| boolean http10Compatible) |
| throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Send a redirect back to the HTTP client |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - current HTTP request (allows for reacting to request method)<DD><CODE>response</CODE> - current HTTP response (for sending response headers)<DD><CODE>targetUrl</CODE> - the name URL to redirect to<DD><CODE>http10Compatible</CODE> - whether to stay compatible with HTTP 1.0 clients |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if thrown by response methods</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/RedirectView.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"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/shiro/web/util/RequestPairSource.html" title="interface in org.apache.shiro.web.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/shiro/web/util/RedirectView.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="RedirectView.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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-2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
