BBjspCommandContext (Deprecated)

The BBJSP system is deprecated. For new development, use BBxServlet.

Description

In BBj 16.0 and higher, this class provides a context for the execution phase of BBjspCommands. When a BBjspCommand is executed by the BBJSP framework then the BBjspCommandContext is passed as a parameter to the BBjspCommand::execute method.

Methods of BBjspCommandContext

Return Value

Method

BBjspSessionData

getBBjspSession()

string

getContextName()

BBjJettyContext

getJettyContext()

BBjspLogger

getLogger()

BBjspWebRequest

getRequest()

BBjspWebResponse

getResponse()

BBjspCommandResult

getResult()

BBjspWebSession

getSession()

void

saveBBjspSession()

Example

rem '=== This is a basic BBJSP Command.
rem '=== It must implement the BBjspCommand interface and have the execute method.
rem '===

class public MyCommand implements BBjspCommang

    rem '===
    rem '=== This method is defined in the BBjspCommand interface
    rem '===

    method public BBjspCommandResult execute(BBjspCommandContext context!)

        declare BBjspWebRequest request!
        declare BBjspWebResponse response!
        declare BBjspSessionData data!
        declare BBjJettyContext jettyContext!
        declare BBjspLogger logger!

        request! = context!.getRequest()
        response! = context!.getResponse()
        data! = context!.getBBjspSession()
        jettyContext! = context!.getJettyContext()
        logger! = context!.getLogger()

        logger!.log("Executing 'MyCommand'")

        rem '=== Get a BBjspCommandResult from the BBjspCommand Context
        result! = context!.getResult()

        rem '===
        rem '=== INSERT BUSINESS LOGIC
        rem '===
        rem '=== Set the outcome policy to 'success'
        result!.setForward("success")

        rem '=== Save any changes to the BB
        context!.saveBBjspSession()

        jettyContext!.getLogger().log("Completed execution of MyCommand in context "+context!.getContextName())

        methodret result!
    methodend

classend

See Also

BBJSP

BBjspWebRequest

BBjspWebResponse

BBjspWebSession

BBjspCommandResult

Logging

BBjspLogger

BBjspLogManager