DtBasicEhsDoc Class Reference

Inheritance diagram for DtBasicEhsDoc:

Collaboration diagram for DtBasicEhsDoc:

List of all members.

Public Member Functions
	DtBasicEhsDoc (const DtString &name)
virtual	~DtBasicEhsDoc ()
DtString	name () const
virtual void	updateState (std::auto_ptr< DtWebSpyUtils::ConnectionState > connState, bool appendToExisting)
std::auto_ptr< DtString >	getComponentState (unsigned long componentId, DtWebSpyUtils::StateComponentType stateType) const
virtual void	appendLogEvent (unsigned long componentId, DtLrcConsoleLogXmlBlockSP logSegmentSP)
virtual ResponseCode	HandleRequest (HttpRequest *ipoHttpRequest, HttpResponse *ipoHttpResponse)
virtual DtBasicEhsDoc *	childDoc (const DtString &childName)
Protected Types
typedef std::auto_ptr < DtString >(DtBasicEhsDoc::*	RequestHandlerFn )(unsigned long, DtWwwRequestXmlBlockSP requestSP, std::auto_ptr< DtString > requestString)
typedef std::map < DtWebSpyUtils::WwwControlMsgCommandId, RequestHandlerFn >	MessageHandlersByKindMap
Protected Member Functions
virtual ResponseCode	HandleFileRequest (HttpRequest *ipoHttpRequest, HttpResponse *ipoHttpResponse)
virtual ResponseCode	HandleNonFileRequest (HttpRequest *ipoHttpRequest, HttpResponse *ipoHttpResponse)
std::auto_ptr< DtString >	processHttpRequest (HttpRequest *ipoHttpRequest)
DtWwwRequestXmlBlockSP	parseWebClientRequestMessage (const DtString &request) const
virtual DtString	getRequestParam (const DtString &paramName, DtWwwRequestXmlBlockSP request) const
void	setRequestParam (const DtString &paramName, const DtString &paramVal, DtWwwRequestXmlBlockSP request) const
virtual ResponseCode	forbiddenUriResponse403 (HttpRequest *ipoHttpRequest, HttpResponse *ipoHttpResponse)
virtual ResponseCode	uriNotFoundResponse404 (HttpRequest *ipoHttpRequest, HttpResponse *ipoHttpResponse)
void	registerRequestHandler (DtWebSpyUtils::WwwControlMsgCommandId kind, DtBasicEhsDoc::RequestHandlerFn func)
void	unRegisterRequestHandler (DtWebSpyUtils::WwwControlMsgCommandId kind, DtBasicEhsDoc::RequestHandlerFn func)
RequestHandlerFn	requestHandlerForKind (DtWebSpyUtils::WwwControlMsgCommandId kind) const
Protected Attributes
DtClock	myClock
DtString	myPageName
DtString	myPage
MessageHandlersByKindMap	myRequestHandlers
DtThreadSafe < DtWebSpyUtils::ConnectionState >	myState
DtThreadSafe< DtLrcEventLog >	myLrcLogs
Private Member Functions
	DtBasicEhsDoc ()
	DtBasicEhsDoc (const DtBasicEhsDoc &)
DtBasicEhsDoc &	operator= (const DtBasicEhsDoc &)

---

Member Typedef Documentation

typedef std::map< DtWebSpyUtils::WwwControlMsgCommandId, RequestHandlerFn > DtBasicEhsDoc::MessageHandlersByKindMap [protected]

typedef std::auto_ptr< DtString >( DtBasicEhsDoc::* DtBasicEhsDoc::RequestHandlerFn)(unsigned long, DtWwwRequestXmlBlockSP requestSP, std::auto_ptr< DtString > requestString) [protected]

---

Constructor & Destructor Documentation

DtBasicEhsDoc::DtBasicEhsDoc

(

)

[private]

DtBasicEhsDoc::DtBasicEhsDoc

(

const DtBasicEhsDoc &

)

[private]

DtBasicEhsDoc::DtBasicEhsDoc

(

const DtString &

name

)

DtBasicEhsDoc::~DtBasicEhsDoc

(

)

[virtual]

---

Member Function Documentation

void DtBasicEhsDoc::appendLogEvent	(	unsigned long	componentId,
		DtLrcConsoleLogXmlBlockSP	logSegmentSP
	)		[virtual]

References myLrcLogs.

DtBasicEhsDoc * DtBasicEhsDoc::childDoc

(

const DtString &

childName

)

[virtual]

Referenced by removeSubdir().

ResponseCode DtBasicEhsDoc::forbiddenUriResponse403	(	HttpRequest *	ipoHttpRequest,
		HttpResponse *	ipoHttpResponse
	)		[protected, virtual]

Referenced by HandleFileRequest().

std::auto_ptr< DtString > DtBasicEhsDoc::getComponentState	(	unsigned long	componentId,
		DtWebSpyUtils::StateComponentType	stateType
	)		const

References myState.

Referenced by DtForwarderXML::handleStateRequest(), DtFederateXML::handleStateRequest(), DtFederationXML::handleStateRequest(), and processHttpRequest().

DtString DtBasicEhsDoc::getRequestParam	(	const DtString &	paramName,
		DtWwwRequestXmlBlockSP	request
	)		const [protected, virtual]

Referenced by DtFederateXML::handleLogRequest(), DtFederationXML::handleLogRequest(), DtFederateXML::handleRTICommand(), and DtFederationXML::handleRtiExecCommand().

ResponseCode DtBasicEhsDoc::HandleFileRequest	(	HttpRequest *	ipoHttpRequest,
		HttpResponse *	ipoHttpResponse
	)		[protected, virtual]

Reimplemented in DtWwwDocSubDir.

References forbiddenUriResponse403(), DtWebSpyUtils::getPathToHtmlRoot(), DtWebSpyUtils::htmlContentTypeForFile(), DtWebSpyUtils::isValidBinaryFileType(), DtWebSpyUtils::isValidTextFileType(), DtWebSpyUtils::readBinaryFileIntoBuffer(), DtWebSpyUtils::readTextFileIntoString(), and uriNotFoundResponse404().

Referenced by HandleRequest().

ResponseCode DtBasicEhsDoc::HandleNonFileRequest	(	HttpRequest *	ipoHttpRequest,
		HttpResponse *	ipoHttpResponse
	)		[protected, virtual]

Reimplemented in DtWwwDocRoot, DtWwwDocSubDir, DtServerConnectionListXML, DtFederationXML, DtFederateXML, DtForwarderXML, and DtAboutHTML.

References processHttpRequest(), and uriNotFoundResponse404().

Referenced by HandleRequest().

ResponseCode DtBasicEhsDoc::HandleRequest	(	HttpRequest *	ipoHttpRequest,
		HttpResponse *	ipoHttpResponse
	)		[virtual]

References HandleFileRequest(), and HandleNonFileRequest().

DtString DtBasicEhsDoc::name

(

)

const [inline]

References myPageName.

Referenced by addSubdir(), DtWwwDocRoot::setupAboutPage(), DtWwwDocRoot::setupFrontPage(), and DtWwwDocRoot::~DtWwwDocRoot().

DtBasicEhsDoc& DtBasicEhsDoc::operator=

(

const DtBasicEhsDoc &

)

[private]

DtWwwRequestXmlBlockSP DtBasicEhsDoc::parseWebClientRequestMessage

(

const DtString &

request

)

const [protected]

References DtSpyXmlDocument::root().

Referenced by processHttpRequest().

std::auto_ptr< DtString > DtBasicEhsDoc::processHttpRequest

(

HttpRequest *

ipoHttpRequest

)

[protected]

References DtWebSpyUtils::DtBaseStateType, getComponentState(), myClock, parseWebClientRequestMessage(), and requestHandlerForKind().

Referenced by HandleNonFileRequest().

void DtBasicEhsDoc::registerRequestHandler	(	DtWebSpyUtils::WwwControlMsgCommandId	kind,
		DtBasicEhsDoc::RequestHandlerFn	func
	)		[protected]

References myRequestHandlers.

Referenced by DtFederateXML::DtFederateXML(), DtFederationXML::DtFederationXML(), and DtForwarderXML::DtForwarderXML().

DtBasicEhsDoc::RequestHandlerFn DtBasicEhsDoc::requestHandlerForKind

(

DtWebSpyUtils::WwwControlMsgCommandId

kind

)

const [protected]

References myRequestHandlers.

Referenced by processHttpRequest().

void DtBasicEhsDoc::setRequestParam	(	const DtString &	paramName,
		const DtString &	paramVal,
		DtWwwRequestXmlBlockSP	request
	)		const [protected]

Referenced by DtFederateXML::handleLogRequest(), and DtFederationXML::handleLogRequest().

void DtBasicEhsDoc::unRegisterRequestHandler	(	DtWebSpyUtils::WwwControlMsgCommandId	kind,
		DtBasicEhsDoc::RequestHandlerFn	func
	)		[protected]

References myRequestHandlers.

void DtBasicEhsDoc::updateState	(	std::auto_ptr< DtWebSpyUtils::ConnectionState >	connState,
		bool	appendToExisting
	)		[virtual]

References myState.

ResponseCode DtBasicEhsDoc::uriNotFoundResponse404	(	HttpRequest *	ipoHttpRequest,
		HttpResponse *	ipoHttpResponse
	)		[protected, virtual]

Referenced by HandleFileRequest(), and HandleNonFileRequest().

---

Member Data Documentation

DtClock DtBasicEhsDoc::myClock [protected]

Referenced by DtFederateXML::handleLogRequest(), DtFederationXML::handleLogRequest(), DtForwarderXML::handleStateRequest(), DtFederateXML::handleStateRequest(), DtFederationXML::handleStateRequest(), and processHttpRequest().

DtThreadSafe< DtLrcEventLog > DtBasicEhsDoc::myLrcLogs [protected]

Referenced by appendLogEvent(), DtFederateXML::handleLogRequest(), and DtFederationXML::handleLogRequest().

DtString DtBasicEhsDoc::myPage [protected]

Referenced by DtServerConnectionListXML::buildResponse(), DtAboutHTML::DtAboutHTML(), DtWwwDocRoot::DtWwwDocRoot(), DtAboutHTML::HandleNonFileRequest(), DtServerConnectionListXML::HandleNonFileRequest(), DtWwwDocRoot::HandleNonFileRequest(), DtForwarderXML::initializePage(), DtFederateXML::initializePage(), DtFederationXML::initializePage(), and DtWwwDocRoot::setupDirectRequestPage().

DtString DtBasicEhsDoc::myPageName [protected]

Referenced by name().

MessageHandlersByKindMap DtBasicEhsDoc::myRequestHandlers [protected]

Referenced by registerRequestHandler(), requestHandlerForKind(), and unRegisterRequestHandler().

DtThreadSafe< DtWebSpyUtils::ConnectionState > DtBasicEhsDoc::myState [protected]

Referenced by getComponentState(), DtForwarderXML::handleStateRequest(), DtFederateXML::handleStateRequest(), DtFederationXML::handleStateRequest(), and updateState().

---

The documentation for this class was generated from the following files:

• basicEhsDoc.h
• basicEhsDoc.cxx