HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions | Related Functions
rwsf::HttpSessionIdGenerator Class Referenceabstract

Abstract base class for implementing HTTP session ID generator. More...

#include <rwsf/servlet/http/HttpSessionIdGenerator.h>

Public Member Functions

virtual ~HttpSessionIdGenerator ()
 
virtual std::string generateSessionId ()=0
 

Related Functions

(Note that these are not member functions.)

#define RWSF_DEFINE_HTTP_SESSION_ID_GENERATOR(NAME)
 

Detailed Description

rwsf::HttpSessionIdGenerator serves as a base class for implementing a unique string generator used by the servlet container to identify a session. To create a generator, derive from this class and override the generateSessionId() function.

To register a generator, see RWSF_DEFINE_HTTP_SESSION_ID_GENERATOR documentation.

Constructor & Destructor Documentation

virtual rwsf::HttpSessionIdGenerator::~HttpSessionIdGenerator ( )
inlinevirtual

Destuctor.

Member Function Documentation

virtual std::string rwsf::HttpSessionIdGenerator::generateSessionId ( )
pure virtual

Returns a unique string.

Friends And Related Function Documentation

#define RWSF_DEFINE_HTTP_SESSION_ID_GENERATOR (   NAME)
related

Defines a function that returns an instance of NAME. The Agent uses the function to construct an instance of HttpSessionIdGenerator. For example, to register MyGenerator:

and then add the property "http-session-id-generator" with the value of "library.createMyGenerator" to the handler chain for the servlet type in the main configuration file (usually <installdir>/conf/rwagent.xml).

...
<rwsf:handler name="servlet"
class="rwsf_servlet<ver>.createServletMessageInfoHandlerImp"
handlerChain="request">
...
<rwsf:property name="rwsf:httpSessionIdGenerator" value="library.createMyGenerator"/>
</rwsf:handler>
...

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.