BBjHttpResponse::setHeader (Deprecated)

BBjHttpResponse::setHeader is deprecated for BBj 21.00 and higher, and has been replaced by BBxServletResponse::setHeader.

Description

In BBj 12.00 and higher, this method sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Syntax

Return Value

Method

void

setHeader(string name, string value)

Parameters

Parameter

Description

name

the name of the header

value

the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

Return Value

None.

Remarks

The example below shows setting a header 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!.setHeader("MyHeader","Something")
        open (chan)"JSERVLET"
        print (chan)"<html><body><h1>Hello BBj!</h1>"
        print (chan)"</body></html>"
        close (chan)
    methodend
classend

See Also

BBjAPI

BBjServletEvent

BBjHttpRequest

BBjHttpResponse