BBjCookie::setMaxAge

Description

In BBj 12.00 and higher, this method sets the maximum age of the cookie in seconds.

A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.

A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.

Syntax

Return Value	Method
void	setMaxAge(int `expiry`)

Parameters

Parameter	Description
expiry	An integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie.

Return Value

None.

Example

The example below shows setting the MaxAge of a BBjCookie of a within a BBjServlet.

rem 'Obtain the instance of the BBjAPI object

let myAPI! = BBjAPI()
MyServlet! = new MyServlet()

data!.setCallback(data!.ON_WEB_CONNECTION, myServlet!, "myMethod")

process_events
class public MyServlet
    method public void myMethod(BBjServletEvent p_event!)
        let chan = UNT
        request! = p_event!.getHttpRequest()
        response! = p_event!.getHttpResponse()
        response!.setContentType("text/html")
        cookie! = response!.addCookie("MyCookie")
        cookie!.setValue("My cookie data")
        cookie!.setPath("/servlet/MyServlet")
        cookie!.setDomain("www.wibble.com")
        cookie!.setMaxAge(3600)
        cookie!.setSecure(0)
        cookie!.setVersion(1)
        cookie!.setComment("comment)
        open (chan)"JSERVLET"
        print (chan)"<html><body><h1>Hello BBj!</h1>"
        print (chan)"</body></html>"
        close (chan)
    methodend
classend

See Also

BBxServletContext

BBxServletResponse

BBxServletRequest