BBjHttpResponse::getCharacterEncoding (Deprecated)

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

Description

In BBj 12.00 and higher, this method returns the name of the character encoding (MIME charset) used for the body sent in this response. The character encoding may have been specified explicitly using the BBjHttpResponse::setCharacterEncoding(String) or BBjHttpResponse::setContentType(String) methods, or implicitly using the BBjHttpResponse::setLocale(Locale) method. Explicit specifications take precedence over implicit specifications. Calls made to these methods after the response has been committed have no effect on the character encoding. If no character encoding has been specified, ISO-8859-1 is returned.

Syntax

Return Value

Method

String

getCharacterEncoding()

Parameters

None.

Return Value

a string specifying the name of the character encoding, for example, UTF-8

Remarks

The example below shows getting the character encoding of a response 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>"
        print (chan)"Character Encoding:"+ response!.getCharacterEncoding()
        print (chan)"</body></html>"
        close (chan)
    methodend
classend

See Also

BBjAPI

BBjServletEvent

BBjHttpRequest

BBjHttpResponse