ossimHttpRequest Class Reference

#include <ossimHttpRequest.h>

Inheritance diagram for ossimHttpRequest:

Public Types
enum	HttpMethodType { HTTP_METHOD_UNKNOWN = 0, HTTP_METHOD_GET = 1, HTTP_METHOD_POST = 2 }

Public Member Functions
	ossimHttpRequest ()
bool	set (const ossimUrl &url, const ossimKeywordlist &headerOptions, HttpMethodType methodType=HTTP_METHOD_GET)
virtual	~ossimHttpRequest ()
void	setHeaderOptions (const ossimKeywordlist &options)
void	addHeaderOption (const ossimString &name, const ossimString &value)
void	clearHeaderOptions ()
ossimKeywordlist &	getHeaderOptions ()
const ossimKeywordlist &	getHeaderOptions () const
virtual ossimString	getLastError () const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
Public Member Functions inherited from ossimWebRequest
	ossimWebRequest ()
	ossimWebRequest (const ossimUrl &url)
const ossimUrl &	getUrl () const
virtual bool	setUrl (const ossimUrl &url)
void	clearLastError ()
void	clearLastError () const
const ossimString	getLastError ()
virtual ossimRefPtr< ossimWebResponse >	getResponse ()
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Attributes
ossimKeywordlist	m_headerOptions
HttpMethodType	m_methodType
	TYPE_DATA
Protected Attributes inherited from ossimWebRequest
ossimUrl	m_url
ossimString	m_lastError
	TYPE_DATA

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 9 of file ossimHttpRequest.h.

Member Enumeration Documentation

HttpMethodType

enum ossimHttpRequest::HttpMethodType

Enumerator
HTTP_METHOD_UNKNOWN
HTTP_METHOD_GET
HTTP_METHOD_POST

Definition at line 12 of file ossimHttpRequest.h.

   {
      HTTP_METHOD_UNKNOWN = 0,
      HTTP_METHOD_GET     = 1,
      HTTP_METHOD_POST    = 2
      // later we will add support for post
   };

Constructor & Destructor Documentation

ossimHttpRequest()

ossimHttpRequest::ossimHttpRequest ( )

inline

Definition at line 19 of file ossimHttpRequest.h.

   :m_methodType(HTTP_METHOD_UNKNOWN)
   {
   }

~ossimHttpRequest()

virtual ossimHttpRequest::~ossimHttpRequest ( )

inlinevirtual

Definition at line 33 of file ossimHttpRequest.h.

   {
   }

Member Function Documentation

addHeaderOption()

void ossimHttpRequest::addHeaderOption ( const ossimString &  name, const ossimString &  value  )

inline

Definition at line 40 of file ossimHttpRequest.h.

Referenced by ossimKakaduJpipHandler::allocateSession(), and ossimKakaduJpipHandler::loadClient().

   {
      m_headerOptions.add(name, value);
   }

clearHeaderOptions()

void ossimHttpRequest::clearHeaderOptions ( )

inline

Definition at line 44 of file ossimHttpRequest.h.

Referenced by ossimKakaduJpipHandler::loadClient(), and loadState().

{m_headerOptions.clear();}

getHeaderOptions() [1/2]

ossimKeywordlist& ossimHttpRequest::getHeaderOptions ( )

inline

Definition at line 45 of file ossimHttpRequest.h.

{return m_headerOptions;}

getHeaderOptions() [2/2]

const ossimKeywordlist& ossimHttpRequest::getHeaderOptions ( ) const

inline

Definition at line 46 of file ossimHttpRequest.h.

{return m_headerOptions;}

getLastError()

virtual ossimString ossimHttpRequest::getLastError ( ) const

inlinevirtual

Definition at line 49 of file ossimHttpRequest.h.

References ossimWebRequest::m_lastError.

{return m_lastError;}

loadState()

bool ossimHttpRequest::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Reimplemented in ossimCurlHttpRequest.

Definition at line 5 of file ossimHttpRequest.cpp.

References clearHeaderOptions(), ossimKeywordlist::find(), HTTP_METHOD_GET, HTTP_METHOD_POST, HTTP_METHOD_UNKNOWN, ossimObject::loadState(), m_methodType, and ossimString::upcase().

Referenced by ossimCurlHttpRequest::loadState().

{
   bool result = true;
   ossimObject::loadState(kwl, prefix);
   ossimString url = kwl.find(prefix, "url");
   ossimString method = kwl.find(prefix, "method");
   method = method.upcase();
   
   if(method == "GET")
   {
      m_methodType = HTTP_METHOD_GET;
   }
   else if(method == "POST")
   {
      m_methodType = HTTP_METHOD_POST;
   }
   else
   {
      m_methodType = HTTP_METHOD_UNKNOWN;
   }
   
   
   clearHeaderOptions();
   
   return result;
}

set()

bool ossimHttpRequest::set ( const ossimUrl &  url, const ossimKeywordlist &  headerOptions, HttpMethodType  methodType = HTTP_METHOD_GET  )

inline

Definition at line 23 of file ossimHttpRequest.h.

References ossimWebRequest::setUrl().

Referenced by ossimKakaduJpipHandler::allocateSession(), ossimWebPluginRequestFactory::create(), ossim::CurlStreamFactory::exists(), and ossimKakaduJpipHandler::loadClient().

   {
      bool result = setUrl(url);
      m_headerOptions = headerOptions;
      m_methodType    = methodType;
      
      return result;
   }

setHeaderOptions()

void ossimHttpRequest::setHeaderOptions ( const ossimKeywordlist &  options )

inline

Definition at line 36 of file ossimHttpRequest.h.

   {
      m_headerOptions = options;
   }

Member Data Documentation

m_headerOptions

ossimKeywordlist ossimHttpRequest::m_headerOptions

protected

Definition at line 54 of file ossimHttpRequest.h.

Referenced by ossimCurlHttpRequest::getContentLength(), and ossimCurlHttpRequest::getResponse().

m_methodType

HttpMethodType ossimHttpRequest::m_methodType

protected

Definition at line 55 of file ossimHttpRequest.h.

Referenced by ossimCurlHttpRequest::getResponse(), and loadState().

TYPE_DATA

ossimHttpRequest::TYPE_DATA

protected

Definition at line 56 of file ossimHttpRequest.h.

---

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

• ossimHttpRequest.h
• ossimHttpRequest.cpp