BBjspWebResponse::encodeRedirectURL (Deprecated)

The BBJSP system is deprecated. For new development, use BBxServlet.

Description

In BBj 16.0 and higher, this method encodes the specified URL for use in the BBjspWebResponse::sendRedirect(String) method or, if encoding is not needed, returns the URL unchanged. The implementation of this method includes the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination can differ from those used to decide whether to encode a normal link, this method is separated from the encodeURL method.

All URLs sent to the BBjspWebResponse::sendRedirect(String) method should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Syntax

Return Value	Method
String	encodeRedirectURL(string url)

Parameters

Variable	Description
url	the url to be encoded.

Return Value

the encoded URL if encoding is needed; the unchanged URL otherwise.

Remarks

The example below shows encoding a URL for redirect

Example

This example demonstrates how this works in a BBJSP web-page

<html>
    <body>
        <h1>Hello from BBJSP</h1>
        <%
            redirectURL$ = #Response!.encodeRedirectURL("/anotheServlet?wibble=123")
            #Response!.sendRedirect(redirectURL$)
        %>
    </body>
</html>

This example demonstrates how this works in a BBJSP servlet

class public MyServlet

  field private BBjspWebRequest request!
  field private BBjspWebResponse response!
  field private BBjspWebSession session!

  method public void service(BBjspServletContext context!)

    #request! = context!.getRequest()
    #response! = context!.getResponse()

    #response!.setContentType("text/html")
    s! = #response!.getOutputStream()

    s!.write("<html><body><h1>Hello from BBJSP</h1>")
    redirectURL$ = #response!.encodeRedirectURL("/servlet/anotheServlet?wibble=123")
    #response!.sendRedirect(redirectURL$)
    s!.write("</body></html>")
  methodend
classend