| <!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.4.2_08) on Mon Nov 14 10:15:17 PST 2005 -->
|
| <TITLE>
|
| SecureLinkTool (Velocity Tools 1.2 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 (Velocity Tools 1.2 Documentation)";
|
| }
|
| </SCRIPT>
|
|
|
| </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=3 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" 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: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool">NESTED</A> | <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/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">org.apache.velocity.tools.view.tools.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, <A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public class <B>SecureLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></DL>
|
|
|
| <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.1 and SSL Ext are installed. </p> |
| <p>Usage: |
| <pre> |
| Template example: |
| <!-- Use just like a regular StrutsLinkTool --> |
| $link.setAction("nameOfAction") |
| $link.setForward("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: |
| <tool> |
| <key>link</key> |
| <scope>request</scope> |
| <class>org.apache.velocity.tools.struts.SecureLinkTool</class> |
| </tool> |
| </pre> |
| </p>
|
| <P>
|
|
|
| <P>
|
| <DL>
|
| <DT><B>Since:</B></DT> |
| <DD>VelocityTools 1.1</DD> |
| <DT><B>Version:</B></DT> |
| <DD>$Revision: 154929 $ $Date: 2005-02-22 18:04:46 -0800 (Tue, 22 Feb 2005) $</DD> |
| <DT><B>Author:</B></DT> |
| <DD><a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a></DD> |
| </DL>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
| <A NAME="nested_class_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Nested Class Summary</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Nested classes inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools">LinkTool.QueryPair</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Field Summary</B></FONT></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.tools.LinkTool"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Fields inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#LOG">LOG</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#response">response</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</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">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Constructor Summary</B></FONT></TD>
|
| </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">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></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#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>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.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)">getActionConfig</A></B>(javax.servlet.http.HttpServletRequest request, |
| 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.StringBuffer</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.tools.LinkTool"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#addQueryData(java.lang.String, java.lang.Object)">addQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(org.apache.velocity.tools.view.tools.LinkTool.QueryPair)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.lang.String)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWithAnchor(java.lang.String)">copyWithAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#encodeURL(java.lang.String)">encodeURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getAnchor()">getAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getBaseRef()">getBaseRef</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextPath()">getContextPath</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextURL()">getContextURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()">getQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()">getURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#init(java.lang.Object)">init</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setAnchor(java.lang.String)">setAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setRelative(java.lang.String)">setRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setURI(java.lang.String)">setURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setXhtml(boolean)">setXhtml</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#toString()">toString</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">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE>clone, equals, finalize, getClass, hashCode, 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">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <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">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Constructor Detail</B></FONT></TD>
|
| </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">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <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.http.HttpServletRequest, javax.servlet.ServletContext, java.lang.String)"><!-- --></A><H3>
|
| getActionConfig</H3>
|
| <PRE>
|
| private static org.apache.struts.config.SecureActionConfig <B>getActionConfig</B>(javax.servlet.http.HttpServletRequest request, |
| 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>request</CODE> - the current request.<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.StringBuffer <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 StringBuffer</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=3 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" 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: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool">NESTED</A> | <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 Apache Software Foundation
|
| </BODY>
|
| </HTML>
|
