BBjCookie::getComment

Description

In BBj 12.0 and higher, this method returns the comment from the current BBjCookie object.

Syntax

Return Value	Method
String	getComment()

Parameters

None.

Return Value

A String containing the comment, or null if none.

Remarks

The example below shows getting the comment from a BBjCookie of a within a BBjServlet

Example

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")
    open (chan)"JSERVLET"
    print (chan)"<html><body><h1>Hello BBj!</h1>"
    vCookies! = request!.getCookies()
    sz = vCookies!.size()
    if sz then
      print (chan)"<ul>"
      for i = 0 to sz-1
        cookie! = vCoolies!.get(i)
        print (chan)"<li>"
        print (chan)"The BBjCookie '" + cookie!.getName() + "' "
        print (chan)"has the value '" + cookie!.getValue() + "' "
        print (chan)"for the domain " + cookie!.getDomain() + " "
        print (chan)"at path " + cookie!.getPath() + " "
        print (chan)"will expire in " + cookie!.getMaxAge() + " seconds "
        if cookie!.isSecure()
          print (chan)" for HTTPS protocol "
        endif
        print (chan)"is version " + cookie!.getVersion() + " "
        print (chan)"comment '" + cookie!.getComment() + "' "
      next i
      print (chan)"</ul>"
    endif
    print (chan)"</body></html>"
    close (chan)
  methodend
classend