Package org.apache.velocity.tools.struts

Class SecureLinkTool

  • All Implemented Interfaces:
    Cloneable
    public class SecureLinkTool
extends LinkTool
    Tool to be able to use Struts SSL Extensions with Velocity.

    It has the same interface as StrutsLinkTool and can function as a substitute if Struts 1.x and SSL Ext are installed.

    The SecureLinkTool extends the standard LinkTool and has the exact same interface as StrutsLinkTool and the same function. It should substitute the StrutsLinkTool in the toolbox if SSL Ext is installed. It's functionality is a subset of the functionality provided by the sslext tag library for JSP.

    The SSL Ext. Struts extension package makes it possible to declare Struts actions secure, non-secure, or neutral in the struts config like so:

     <action path="/someSecurePath" type="some.important.Action">
     <set-property property="secure" value="true"/>
     <forward name="success" path="/somePage.vm" />
 </action>

    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.
    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

    These are the steps needed to enable SSL Ext:

    • SSL connections need to be enabled on the webserver.
    • 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)
    • In your tools.xml, add the SecureLinkTool to replace (same key) or complement (alternate key) the StrutsLinkTool
    • In struts-conf.xml the custom action-mapping class needs to be specified
    • In struts-conf.xml the custom controller class can optionally be specified (if the redirect feature is wanted)
    • In struts-conf.xml the SecurePlugIn needs to be added
    • 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.
    See SSL Ext.project home for more info.

    Usage: 

     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>

    Since:
    VelocityTools 1.1
    Version:
    $Revision$ $Date$
    Author:
    Marino A. Jonsson

    • Field Detail

      • application

        protected javax.servlet.ServletContext application

    • Constructor Detail

      • SecureLinkTool

        public SecureLinkTool()

    • Method Detail

      • configure

        protected void configure​(ValueParser props)
        Description copied from class: SafeConfig
        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.
        Overrides:
        configure in class LinkTool

      • setAction

        public SecureLinkTool setAction​(String action)

        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.

        Parameters:
        action - an action path as defined in struts-config.xml
        Returns:
        a new instance of StrutsLinkTool

      • setForward

        public SecureLinkTool setForward​(String forward)

        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, null is returned. This method will overwrite any previous URI reference settings but will copy the query string.

        Parameters:
        forward - a global forward name as defined in struts-config.xml
        Returns:
        a new instance of StrutsLinkTool

      • computeURL

        public String computeURL​(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.ServletContext app,
                         String link)
        Compute a hyperlink URL based on the specified action link. The returned URL will have already been passed to response.encodeURL() for adding a session identifier.
        Parameters:
        request - the current request.
        app - the current ServletContext.
        link - the action that is to be converted to a hyperlink URL
        Returns:
        the computed hyperlink URL

      • toEncoded

        public String toEncoded​(String url,
                        String sessionId)
        Return the specified URL with the specified session identifier suitably encoded.
        Parameters:
        url - URL to be encoded with the session id
        sessionId - Session id to be included in the encoded URL
        Returns:
        the specified URL with the specified session identifier suitably encoded