BBjCookie::getPath

Description

In BBj 12.00 and higher, this method returns the path on the server to which the browser returns this BBjCookie. The cookie is visible to all subpaths on the server.

Syntax

Return Value Method
String

getPath()

Parameters

None.

Return Value

A String specifying a path that contains a servlet name, for example, /catalog.

Example

CLASS PUBLIC CookieExampleServlet 
    method public void service(BBxServletContext context!) 
       
        request! = context!.getRequest()
        response! = context!.getResponse()
        session! = request!.getSession()

        s! = response!.getOutputStream()
        s!.write("<html><body>")
        
        cookies! = request!.getCookies()
        sz = cookies!.size()
        IF (sz) THEN
            s!.write("<ul>")
            FOR i = 0 TO sz-1
                cookie! = cookies!.get(i)
                s!.write("<li>")
                s!.write("The BBjCookie '" + cookie!.getName() + "' ")
                s!.write("has the value '" + cookie!.getValue() + "' ")
                
                domain! = cookie!.getDomain()
                IF domain! = NULL() THEN
                    domain! = "null"
                ENDIF
                
                path! = cookie!.getPath()
                IF path! = NULL() THEN
                    path! = "null"
                ENDIF
                
                s!.write("for the domain " + domain! + " ")
                s!.write("at path " + path! + " ")
                s!.write("will expire in " + Integer.toString(cookie!.getMaxAge()) + " seconds ")
                
                IF cookie!.getSecure() THEN
                    s!.write(" for HTTPS protocol ")
                ENDIF

                IF cookie!.isHttpOnly() THEN
                    s!.write(" only for HTTP protocol ")
                ENDIF
                
                s!.write("is version " + Integer.toString(cookie!.getVersion()) + " ")
                
                IF cookie!.getComment() <> NULL() THEN
                    s!.write("comment '" + cookie!.getComment() + "' ")
                ENDIF
                
            NEXT i
            s!.write("</ul>")
        ENDIF
        s!.write("</body></html>")
    METHODEND
CLASSEND

See Also

BBjAPI

BBxServletContext

BBxServletResponse

BBxServletRequest

BBjCookie