\section{Handler Class Reference}
\label{classHandler}\index{Handler@{Handler}}
interface for handlers. 


{\tt \#include $<$Handler.h$>$}

\subsection*{Public Methods}
\begin{CompactItemize}
\item 
{\bf Handler} ()
\item 
virtual {\bf $\sim$Handler} ()
\item 
const string \& {\bf get\-Option} (const string \&s\-Arg)
\item 
void {\bf set\-Option\-List} (const map$<$ string, string $>$ $\ast$Option\-List)
\item 
int AXISCALL {\bf get\-Type} ()
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
const map$<$ string, string $>$ $\ast$ {\bf m\_\-p\-Option}
\item 
string {\bf m\_\-s\-Empty}
\end{CompactItemize}


\subsection{Detailed Description}
interface for handlers.

\begin{Desc}
\item[Author: ]\par
Damitha Kumarage ({\tt damitha@opensource.lk}, {\tt damitha@jkcsworld.com}) , Roshan Weerasuriya ({\tt roshan@opensource.lk}, {\tt roshanw@jkcsworld.com}) \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{Handler@{Handler}!Handler@{Handler}}
\index{Handler@{Handler}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Handler::Handler ()\hspace{0.3cm}{\tt  [inline]}}\label{classHandler_a0}


Constructor. \index{Handler@{Handler}!~Handler@{$\sim$Handler}}
\index{~Handler@{$\sim$Handler}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual Handler::$\sim$Handler ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classHandler_a1}


Destructor. 

\subsection{Member Function Documentation}
\index{Handler@{Handler}!getOption@{getOption}}
\index{getOption@{getOption}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const string\& Handler::get\-Option (const string \& {\em s\-Arg})\hspace{0.3cm}{\tt  [inline]}}\label{classHandler_a2}


Returns the value of the given option.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
s\-Arg}]The option name, i.e key \end{description}
\end{Desc}
\begin{Desc}
\item[Returns: ]\par
The option value. \end{Desc}
\index{Handler@{Handler}!getType@{getType}}
\index{getType@{getType}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int AXISCALL Handler::get\-Type ()\hspace{0.3cm}{\tt  [inline]}}\label{classHandler_a4}


Gets and returns the type of the handler. The return value here is always NORMAL\_\-HANDLER.

\begin{Desc}
\item[Returns: ]\par
returns the type of the handler. The return value here is always NORMAL\_\-HANDLER. \end{Desc}
\index{Handler@{Handler}!setOptionList@{setOptionList}}
\index{setOptionList@{setOptionList}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Handler::set\-Option\-List (const map$<$ string, string $>$ $\ast$ {\em Option\-List})\hspace{0.3cm}{\tt  [inline]}}\label{classHandler_a3}


This method is automatically called by the Axis Engine when it loads a Handler. The purpose of this method is described below: For each Handler we could configure various parameters/options in the Server.wsdd or Client.wsdd. If the engine finds any such options then the engine will automaticaly call this method of each handler and will set those options to each Handler by calling this method of each  Handler which those configuration options belong to. Normaly a Handler writer doesn't need to interact/deal with this method.\begin{Desc}
\item[Parameters: ]\par
\begin{description}
\item[{\em 
Option\-List}]The map which contains the options to be set. \end{description}
\end{Desc}


\subsection{Member Data Documentation}
\index{Handler@{Handler}!m_pOption@{m\_\-pOption}}
\index{m_pOption@{m\_\-pOption}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const map$<$string, string$>$$\ast$ Handler::m\_\-p\-Option\hspace{0.3cm}{\tt  [protected]}}\label{classHandler_n0}


Used to store the options which are configured in the WSDD. \index{Handler@{Handler}!m_sEmpty@{m\_\-sEmpty}}
\index{m_sEmpty@{m\_\-sEmpty}!Handler@{Handler}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}string Handler::m\_\-s\-Empty\hspace{0.3cm}{\tt  [protected]}}\label{classHandler_n1}


Represents an empty string. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
Handler.h\end{CompactItemize}
