| <!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.5.0_14) on Mon Apr 26 10:16:14 PDT 2010 --> | |
| <TITLE> | |
| SecureLinkTool (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.SecureLinkTool class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="SecureLinkTool (VelocityTools 2.0 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= 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="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/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/struts/SecureLinkTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="SecureLinkTool.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.velocity.tools.struts</FONT> | |
| <BR> | |
| Class SecureLinkTool</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.LinkTool</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">org.apache.velocity.tools.view.LinkTool</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.struts.SecureLinkTool</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>SecureLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</A></DL> | |
| </PRE> | |
| <P> | |
| Tool to be able to use Struts SSL Extensions with Velocity. | |
| <p>It has the same interface as StrutsLinkTool and can function as a | |
| substitute if Struts 1.x and SSL Ext are installed. </p> | |
| <p>The SecureLinkTool extends the standard | |
| <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view"><CODE>LinkTool</CODE></A> and has the exact same interface as | |
| <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><CODE>StrutsLinkTool</CODE></A> and the same function. It should | |
| substitute the <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><CODE>StrutsLinkTool</CODE></A> in the toolbox if | |
| <a href="http://sslext.sourceforge.net">SSL Ext</a> is installed. | |
| It's functionality is a subset of the functionality provided by the | |
| sslext tag library for JSP.</p> | |
| <p>The SSL Ext. Struts extension package makes it possible to declare Struts actions | |
| secure, non-secure, or neutral in the struts config like so:</p> | |
| <pre> | |
| <action path="/someSecurePath" type="some.important.Action"> | |
| <set-property property="secure" value="true"/> | |
| <forward name="success" path="/somePage.vm" /> | |
| </action> | |
| </pre> | |
| <p>If an action is declared secure the SecureLinkTool will render the relevant link | |
| as https (if not already in ssl-mode). In the same way, if an action is declared | |
| non-secure the SecureLinkTool will render the relevant link as http (if in ssl-mode). | |
| If the action is declared as neutral (with a "secure" property of "any") then the | |
| SecureLinkTool won't force a protocol change either way.<br/> If the custom | |
| request processor is also used then a request will be redirected to the correct | |
| protocol if an action URL is manually entered into the browser with the wrong protocol</p> | |
| <p>These are the steps needed to enable SSL Ext:</p> | |
| <ul> | |
| <li>SSL connections need to be enabled on the webserver.</li> | |
| <li>The Java Secure Socket Extension (JSSE) package needs to be in place (it's | |
| integrated into the Java 2 SDK Standard Edition, v. 1.4 but optional for earlier | |
| versions)</li> | |
| <li>In your tools.xml, add the SecureLinkTool to replace (same key) or complement | |
| (alternate key) the <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><CODE>StrutsLinkTool</CODE></A></li> | |
| <li>In struts-conf.xml the custom action-mapping class needs to be specified</li> | |
| <li>In struts-conf.xml the custom controller class can optionally be specified | |
| (if the redirect feature is wanted)</li> | |
| <li>In struts-conf.xml the SecurePlugIn needs to be added</li> | |
| <li>In struts-conf.xml, when using Tiles, the SecureTilesPlugin substitues both the | |
| TilesPlugin and the SecurePlugIn and it also takes care of setting the correct | |
| controller so there is no need to specify the custom controller.</li> | |
| </ul> | |
| See <a href="http://sslext.sourceforge.net">SSL Ext.project home</a> for more info. | |
| <p>Usage: | |
| <pre> | |
| Template example: | |
| <!-- Use just like a regular StrutsLinkTool --> | |
| $link.action.nameOfAction | |
| $link.action.nameOfForward | |
| If the action or forward is marked as secure, or not, | |
| in your struts-config then the link will be rendered | |
| with https or http accordingly. | |
| Toolbox configuration: | |
| <tools> | |
| <toolbox scope="request"> | |
| <tool class="org.apache.velocity.tools.struts.SecureLinkTool"/> | |
| </toolbox> | |
| </tools> | |
| </pre> | |
| </p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>VelocityTools 1.1</DD> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Revision: 707788 $ $Date: 2008-10-24 16:28:06 -0700 (Fri, 24 Oct 2008) $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD><a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a></DD> | |
| </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>protected javax.servlet.ServletContext</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#application">application</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#HTTP">HTTP</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#HTTPS">HTTPS</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#STD_HTTP_PORT">STD_HTTP_PORT</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#STD_HTTPS_PORT">STD_HTTPS_PORT</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.view.LinkTool"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.view.<A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#INCLUDE_REQUEST_PARAMS_KEY">INCLUDE_REQUEST_PARAMS_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#includeRequestParams">includeRequestParams</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#response">response</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.LinkTool"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#APPEND_PARAMS_KEY">APPEND_PARAMS_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendParams">appendParams</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#charset">charset</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#CHARSET_KEY">CHARSET_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#DEFAULT_CHARSET">DEFAULT_CHARSET</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#DEFAULT_SCHEME">DEFAULT_SCHEME</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#FORCE_RELATIVE_KEY">FORCE_RELATIVE_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#forceRelative">forceRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#fragment">fragment</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#FRAGMENT_KEY">FRAGMENT_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#host">host</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#HOST_KEY">HOST_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#LOG">LOG</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#opaque">opaque</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#path">path</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#PATH_KEY">PATH_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#port">port</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#PORT_KEY">PORT_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#query">query</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#QUERY_KEY">QUERY_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#queryDelim">queryDelim</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#scheme">scheme</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#SCHEME_KEY">SCHEME_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#SECURE_SCHEME">SECURE_SCHEME</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#self">self</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#URI_KEY">URI_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#user">user</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#USER_KEY">USER_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#XHTML_MODE_KEY">XHTML_MODE_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#OLD_LOCK_CONFIG_KEY">OLD_LOCK_CONFIG_KEY</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></CODE></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/velocity/tools/struts/SecureLinkTool.html#SecureLinkTool()">SecureLinkTool</A></B>()</CODE> | |
| <BR> | |
| </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> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#computeURL(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)">computeURL</A></B>(javax.servlet.http.HttpServletRequest request, | |
| javax.servlet.ServletContext app, | |
| java.lang.String link)</CODE> | |
| <BR> | |
| Compute a hyperlink URL based on the specified action link.</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/velocity/tools/struts/SecureLinkTool.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> props)</CODE> | |
| <BR> | |
| Does the actual configuration.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static org.apache.struts.config.SecureActionConfig</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#getActionConfig(javax.servlet.ServletContext, java.lang.String)">getActionConfig</A></B>(javax.servlet.ServletContext app, | |
| java.lang.String linkString)</CODE> | |
| <BR> | |
| Finds the configuration definition for the specified action link</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#setAction(java.lang.String)">setAction</A></B>(java.lang.String action)</CODE> | |
| <BR> | |
| Returns a copy of the link with the given action name | |
| converted into a server-relative URI reference.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#setForward(java.lang.String)">setForward</A></B>(java.lang.String forward)</CODE> | |
| <BR> | |
| Returns a copy of the link with the given global forward name | |
| converted into a server-relative URI reference.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static java.lang.StringBuilder</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#startNewUrlString(javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.String)">startNewUrlString</A></B>(javax.servlet.http.HttpServletRequest request, | |
| java.lang.String desiredScheme, | |
| java.lang.String desiredPort)</CODE> | |
| <BR> | |
| Builds the protocol, server name, and port portion of the new URL</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#toEncoded(java.lang.String, java.lang.String)">toEncoded</A></B>(java.lang.String url, | |
| java.lang.String sessionId)</CODE> | |
| <BR> | |
| Return the specified URL with the specified session identifier | |
| suitably encoded.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.view.LinkTool"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.view.<A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#addMissingRequestParams(java.lang.String...)">addMissingRequestParams</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#addRequestParams(java.lang.String...)">addRequestParams</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#addRequestParamsExcept(java.lang.String...)">addRequestParamsExcept</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#getContextPath()">getContextPath</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#getContextURL()">getContextURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#getRequestPath()">getRequestPath</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#isPathChanged()">isPathChanged</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#setFromRequest(javax.servlet.http.HttpServletRequest)">setFromRequest</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#setIncludeRequestParams(boolean)">setIncludeRequestParams</A>, <A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#toString()">toString</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.LinkTool"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html" title="class in org.apache.velocity.tools.generic">LinkTool</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#absolute()">absolute</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#absolute(java.lang.Object)">absolute</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#anchor(java.lang.Object)">anchor</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#append(java.lang.Object)">append</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#append(java.lang.Object, java.lang.Object)">append</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendAsArray(java.lang.StringBuilder, java.lang.Object, java.lang.Object[])">appendAsArray</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendPath(java.lang.Object)">appendPath</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#appendQuery(java.lang.Object)">appendQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#combinePath(java.lang.String, java.lang.String)">combinePath</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#combineQuery(java.lang.String, java.lang.String)">combineQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#createURI()">createURI</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#debug(java.lang.String, java.lang.Object...)">debug</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#debug(java.lang.String, java.lang.Throwable, java.lang.Object...)">debug</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#decode(java.lang.Object)">decode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#decodeQueryPercents(java.lang.String)">decodeQueryPercents</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#directory()">directory</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#duplicate()">duplicate</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#duplicate(boolean)">duplicate</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#encode(java.lang.Object)">encode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getAnchor()">getAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getAppendParams()">getAppendParams</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getBaseRef()">getBaseRef</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getCharacterEncoding()">getCharacterEncoding</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getDirectory()">getDirectory</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getFile()">getFile</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getHost()">getHost</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getParams()">getParams</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getPath()">getPath</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getPort()">getPort</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getQuery()">getQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getRoot()">getRoot</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getScheme()">getScheme</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getSelf()">getSelf</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getUri()">getUri</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#getUser()">getUser</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#handleParamsBoolean(boolean)">handleParamsBoolean</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#hashCode()">hashCode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#host(java.lang.Object)">host</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#insecure()">insecure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isAbsolute()">isAbsolute</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isOpaque()">isOpaque</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isRelative()">isRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isSecure()">isSecure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#isXHTML()">isXHTML</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#normalizeQuery(java.lang.String)">normalizeQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#param(java.lang.Object, java.lang.Object)">param</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#params(java.lang.Object)">params</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#parseQuery(java.lang.String)">parseQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#parseQuery(java.lang.String, java.lang.String)">parseQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#path(java.lang.Object)">path</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#port(java.lang.Object)">port</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#query(java.lang.Object)">query</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#relative()">relative</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#relative(java.lang.Object)">relative</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#remove(java.lang.Object)">remove</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#removeParam(java.lang.Object)">removeParam</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#root()">root</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#scheme(java.lang.Object)">scheme</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#secure()">secure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#set(java.lang.Object, java.lang.Object)">set</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setAppendParams(boolean)">setAppendParams</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setForceRelative(boolean)">setForceRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setFragment(java.lang.Object)">setFragment</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setFromURI(java.lang.Object)">setFromURI</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setHost(java.lang.Object)">setHost</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setParam(java.lang.Object, java.lang.Object, boolean)">setParam</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setParams(java.lang.Object, boolean)">setParams</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setPath(java.lang.Object)">setPath</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setPort(java.lang.Object)">setPort</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setQuery(java.lang.Object)">setQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setScheme(java.lang.Object)">setScheme</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setUserInfo(java.lang.Object)">setUserInfo</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#setXHTML(boolean)">setXHTML</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toQuery(java.util.Map)">toQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toQuery(java.lang.Object, java.lang.Object)">toQuery</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#toURI(java.lang.Object)">toURI</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#uri(java.lang.Object)">uri</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/LinkTool.html#user(java.lang.Object)">user</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.SafeConfig"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(java.util.Map)">configure</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked()">isConfigLocked</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode()">isSafeMode</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig(boolean)">setLockConfig</A>, <A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode(boolean)">setSafeMode</A></CODE></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.Object</B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="application"><!-- --></A><H3> | |
| application</H3> | |
| <PRE> | |
| protected javax.servlet.ServletContext <B>application</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="HTTP"><!-- --></A><H3> | |
| HTTP</H3> | |
| <PRE> | |
| private static final java.lang.String <B>HTTP</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.HTTP">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="HTTPS"><!-- --></A><H3> | |
| HTTPS</H3> | |
| <PRE> | |
| private static final java.lang.String <B>HTTPS</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.HTTPS">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="STD_HTTP_PORT"><!-- --></A><H3> | |
| STD_HTTP_PORT</H3> | |
| <PRE> | |
| private static final java.lang.String <B>STD_HTTP_PORT</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.STD_HTTP_PORT">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="STD_HTTPS_PORT"><!-- --></A><H3> | |
| STD_HTTPS_PORT</H3> | |
| <PRE> | |
| private static final java.lang.String <B>STD_HTTPS_PORT</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.struts.SecureLinkTool.STD_HTTPS_PORT">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="SecureLinkTool()"><!-- --></A><H3> | |
| SecureLinkTool</H3> | |
| <PRE> | |
| public <B>SecureLinkTool</B>()</PRE> | |
| <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="configure(org.apache.velocity.tools.generic.ValueParser)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| protected void <B>configure</B>(<A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A> props)</PRE> | |
| <DL> | |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure(org.apache.velocity.tools.generic.ValueParser)">SafeConfig</A></CODE></B></DD> | |
| <DD>Does the actual configuration. This is protected, so | |
| subclasses may share the same ValueParser and call configure | |
| at any time, while preventing templates from doing so when | |
| configure(Map) is locked. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html#configure(org.apache.velocity.tools.generic.ValueParser)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/view/LinkTool.html" title="class in org.apache.velocity.tools.view">LinkTool</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setAction(java.lang.String)"><!-- --></A><H3> | |
| setAction</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A> <B>setAction</B>(java.lang.String action)</PRE> | |
| <DL> | |
| <DD><p>Returns a copy of the link with the given action name | |
| converted into a server-relative URI reference. This method | |
| does not check if the specified action really is defined. | |
| This method will overwrite any previous URI reference settings | |
| but will copy the query string.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>action</CODE> - an action path as defined in struts-config.xml | |
| <DT><B>Returns:</B><DD>a new instance of StrutsLinkTool</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setForward(java.lang.String)"><!-- --></A><H3> | |
| setForward</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A> <B>setForward</B>(java.lang.String forward)</PRE> | |
| <DL> | |
| <DD><p>Returns a copy of the link with the given global forward name | |
| converted into a server-relative URI reference. If the parameter | |
| does not map to an existing global forward name, <code>null</code> | |
| is returned. This method will overwrite any previous URI reference | |
| settings but will copy the query string.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>forward</CODE> - a global forward name as defined in struts-config.xml | |
| <DT><B>Returns:</B><DD>a new instance of StrutsLinkTool</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="computeURL(javax.servlet.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)"><!-- --></A><H3> | |
| computeURL</H3> | |
| <PRE> | |
| public java.lang.String <B>computeURL</B>(javax.servlet.http.HttpServletRequest request, | |
| javax.servlet.ServletContext app, | |
| java.lang.String link)</PRE> | |
| <DL> | |
| <DD>Compute a hyperlink URL based on the specified action link. | |
| The returned URL will have already been passed to | |
| <code>response.encodeURL()</code> for adding a session identifier. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the current request.<DD><CODE>app</CODE> - the current ServletContext.<DD><CODE>link</CODE> - the action that is to be converted to a hyperlink URL | |
| <DT><B>Returns:</B><DD>the computed hyperlink URL</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getActionConfig(javax.servlet.ServletContext, java.lang.String)"><!-- --></A><H3> | |
| getActionConfig</H3> | |
| <PRE> | |
| private static org.apache.struts.config.SecureActionConfig <B>getActionConfig</B>(javax.servlet.ServletContext app, | |
| java.lang.String linkString)</PRE> | |
| <DL> | |
| <DD>Finds the configuration definition for the specified action link | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>app</CODE> - the current ServletContext.<DD><CODE>linkString</CODE> - The action we are searching for, specified as a | |
| link. (i.e. may include "..") | |
| <DT><B>Returns:</B><DD>The SecureActionConfig object entry for this action, | |
| or null if not found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="startNewUrlString(javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| startNewUrlString</H3> | |
| <PRE> | |
| private static java.lang.StringBuilder <B>startNewUrlString</B>(javax.servlet.http.HttpServletRequest request, | |
| java.lang.String desiredScheme, | |
| java.lang.String desiredPort)</PRE> | |
| <DL> | |
| <DD>Builds the protocol, server name, and port portion of the new URL | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - The current request<DD><CODE>desiredScheme</CODE> - The scheme (http or https) to be used in the new URL<DD><CODE>desiredPort</CODE> - The port number to be used in th enew URL | |
| <DT><B>Returns:</B><DD>The new URL as a StringBuilder</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="toEncoded(java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| toEncoded</H3> | |
| <PRE> | |
| public java.lang.String <B>toEncoded</B>(java.lang.String url, | |
| java.lang.String sessionId)</PRE> | |
| <DL> | |
| <DD>Return the specified URL with the specified session identifier | |
| suitably encoded. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - URL to be encoded with the session id<DD><CODE>sessionId</CODE> - Session id to be included in the encoded URL | |
| <DT><B>Returns:</B><DD>the specified URL with the specified session identifier suitably encoded</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="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/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/struts/SecureLinkTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="SecureLinkTool.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 (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |