Daraja HTTP Framework  2.0
HTTP server framework for Object Pascal
TdjWebComponentContextHandler Class Reference

Context Handler for Web Components. More...

+ Inheritance diagram for TdjWebComponentContextHandler:

Public Member Functions

 TdjWebComponentContextHandler (const string ContextPath, Boolean Sessions=False)
 Constructor. More...
 
 ~TdjWebComponentContextHandler ()
 Destructor.
 
 AddWebComponent (const TdjWebComponentClass ComponentClass, const string PathSpec)
 Add a Web Component. More...
 
 Add (const TdjWebComponentClass ComponentClass, const string PathSpec)
 Convenience method to add a Web Component. More...
 
 AddWebComponent (const TdjWebComponentHolder Holder, const string PathSpec)
 Add a Web Component. More...
 
 Handle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
 Handle a HTTP request. More...
 
 DoStart ()
 Start the handler.
 
 DoStop ()
 Stop the handler.
 
- Public Member Functions inherited from TdjContextHandler
 TdjContextHandler (const string ContextPath)
 Create a ContextHandler.
 
 ~TdjContextHandler ()
 Destructor.
 
IContext GetCurrentContext ()
 The internal IContext field.
 
 SetInitParameter (const string Key, const string Value)
 Set initialization parameter. More...
 
 DoStart ()
 Start the handler.
 
 DoStop ()
 Stop the handler.
 
 Handle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
 Handle a HTTP request. More...
 
- Public Member Functions inherited from TdjHandlerWrapper
 AddHandler (const IHandler Handler)
 Add a handler to the container. More...
 
 RemoveHandler (const IHandler Handler)
 Remove a handler from the container. More...
 
 DoStart ()
 Start the handler.
 
 DoStop ()
 Stop the handler.
 
 Handle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
 Handle a HTTP request. More...
 
- Public Member Functions inherited from TdjAbstractHandler
 TdjAbstractHandler ()
 Constructor.
 
 DoStart ()
 Start the handler.
 
 DoStop ()
 Start the handler.
 
 Handle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
 Handle a HTTP request. More...
 
- Public Member Functions inherited from TdjLifeCycle
 TdjLifeCycle ()
 Constructor.
 
 Start ()
 Start the handler. More...
 
 Stop ()
 Stop the handler. More...
 
Boolean IsStarted ()
 
Boolean IsStopped ()
 

Protected Member Functions

 DoHandle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
 
- Protected Member Functions inherited from TdjContextHandler
Boolean ContextMatches (const string ConnectorName, const string Target)
 Check if the Document matches this context. More...
 
string ToConnectorName (TdjServerContext Context)
 Creates connector name in the form 'host:port'. More...
 
- Protected Member Functions inherited from TdjHandlerWrapper
TIdHTTPSession GetSession (TdjServerContext Context, TdjRequest Request, TdjResponse Response, const Boolean Create)
 Get a HTTP session.
 
- Protected Member Functions inherited from TdjAbstractHandlerContainer
 AddHandler (const IHandler Handler)
 Add a handler. More...
 
 RemoveHandler (const IHandler Handler)
 Remove a handler. More...
 
- Protected Member Functions inherited from TdjLifeCycle
 DoStart ()
 Execute the custom start code.
 
 DoStop ()
 Execute the custom stop code.
 
 CheckStarted ()
 Raises an exception if the lifecycle is in "started" state.
 
 CheckStopped ()
 Raises an exception if the lifecycle is in "stopped" state.
 

Additional Inherited Members

- Public Attributes inherited from TdjContextHandler
TStrings ConnectorNames
 
string ContextPath
 
IHandler ErrorHandler
 
- Public Attributes inherited from TdjHandlerWrapper
IHandler Handler
 
- Public Attributes inherited from TdjLifeCycle
Boolean Started
 True if the state is "started". More...
 
Boolean Stopped
 True if the state is "stopped". More...
 

Detailed Description

Context Handler for Web Components.

Constructor & Destructor Documentation

◆ TdjWebComponentContextHandler()

TdjWebComponentContextHandler::TdjWebComponentContextHandler ( const string  ContextPath,
Boolean  Sessions = False 
)

Constructor.

Parameters
ContextPaththe context path
Sessionsenable HTTP sessions

References TdjHandlerWrapper::AddHandler(), and TdjContextHandler::ContextPath.

Member Function Documentation

◆ Add()

TdjWebComponentContextHandler::Add ( const TdjWebComponentClass  ComponentClass,
const string  PathSpec 
)

Convenience method to add a Web Component.

Parameters
ComponentClassWebComponent class
PathSpecpath specification
Exceptions
EWebComponentExceptionif the Web Component can not be added

References AddWebComponent(), TdjWebComponentHandler::AddWithMapping(), and TdjWebComponentHandler::FindHolder().

◆ AddWebComponent() [1/2]

TdjWebComponentContextHandler::AddWebComponent ( const TdjWebComponentClass  ComponentClass,
const string  PathSpec 
)

Add a Web Component.

Parameters
ComponentClassWebComponent class
PathSpecpath specification
Exceptions
EWebComponentExceptionif the Web Component can not be added

Referenced by Add().

◆ AddWebComponent() [2/2]

TdjWebComponentContextHandler::AddWebComponent ( const TdjWebComponentHolder  Holder,
const string  PathSpec 
)

Add a Web Component.

Parameters
Holderholds information about the Web Component
PathSpecpath specification
Exceptions
EWebComponentExceptionif the Web Component can not be added

References TdjWebComponentHandler::AddWithMapping(), TdjWebComponentHolder::GetContext(), TdjWebComponentHolder::SetContext(), and TdjWebComponentHolder::WebComponentClass.

◆ DoHandle()

TdjWebComponentContextHandler::DoHandle ( const string  Target,
TdjServerContext  Context,
TdjRequest  Request,
TdjResponse  Response 
)
protected
Parameters
TargetRequest target
ContextHTTP server context
RequestHTTP request
ResponseHTTP response

References TdjContextHandler::ContextPath, and TdjWebComponentHandler::Handle().

Referenced by Handle().

◆ Handle()

TdjWebComponentContextHandler::Handle ( const string  Target,
TdjServerContext  Context,
TdjRequest  Request,
TdjResponse  Response 
)

Handle a HTTP request.

Parameters
TargetRequest target
ContextHTTP server context
RequestHTTP request
ResponseHTTP response
Exceptions
EWebComponentExceptionif an exception occurs that interferes with the component's normal operation
See also
IHandler

References TdjContextHandler::ContextMatches(), DoHandle(), TdjHandlerWrapper::GetSession(), and TdjContextHandler::ToConnectorName().