BBjspPipelineConfig (Deprecated)

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

Description

In BBj 17.0 and higher, this class provides configuration detail for a BBJSP Pipeline. More details about pipelines can be found by reading the Pipeline Engine.

A pipeline consists of multiple stages which are implemented as a custom class designed to interact with BBjspSessionData objects. The pipeline is executed automatically when a BBjspCommand completes execution.

This class provides methods outlined below that can be used to configure a pipeline programmatically.

Creation

BBjAPI > BBjAdmin > BBjJettyServerConfiguration > BBjJettyContextConfiguration > BBjspPipelineConfig

The BBjspPipelineConfig is created through the following BBjJettyContextConfiguration methods:

Return Value

Method

BBjspPipelineConfig

addPipelineConfig(string name)

BBjVector

getPipelineConfigs()

Methods of BBjspPipelineConfig

Return Value

Method

BBjspPipelineStageConfig

createStage(string name, string source, string className)

string

getBBjConfig()

string

getFilename()

string

getName()

BBjspPipelineStageConfig

getStage(string name)

BBjVector

getStageNames()

BBjspPipelineStageConfig

removeStage(string name)

void

save()

void

setBBjConfig(string config)

Example

declare BBjAPI api!
declare BBjAdmin admin!
declare BBjJettyServerConfiguration config!
declare BBjJettyContextConfiguration root!
declare BBjspPipelineConfig pipelineConfig!
declare BBjspPipelineStageConfig stageConfig!
declare BBjVector stageNames!

api! = BBJAPI()
admin! = api!.getAdmin("admin","admin123")
config! = admin!.getJettyServerConfig()
root! = config!.getRootContextInfo()

pipelineConfig! = root!.getPipelineConfig("MyPipeline")

print "Pipeline Name = " + pipelineConfig!.getName()
print "Config File = " + pipelineConfig!.getFilename()
print "config.bbx = " + pipelineConfig!.getBBjConfig()

stageNames! = pipelineConfig!.getStageNames()
print stageNames!
sz = stageNames!.size()
if (sz) then
    for i = 0 to sz-1
        name$ = stageNames!.get(i)
        stageConfig! = pipelineConfig!.getStage(name$)
        print " " + name$ + " - " + stageConfig!.getSource() + "::" + stageConfig!.getClassname()
    next i
endif

pipelineConfig!.save()

See Also

BBJSP

Pipeline Engine

BBjspPipelineStage

BBjspPipelineStageConfig

BBjJettyContextConfiguration