X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=xmltooling%2Fio%2FGenericRequest.h;h=e540b2ecb584de26ddc6ddff58f1b71732b1df52;hb=894a579a1a41f535a9b73155c86ee96c587979c2;hp=af983d57c7e88627fc2f98cdf74a753bc4456bb0;hpb=a6ec5ba5d5a9ce4f3e127fdc455eea31051390c2;p=shibboleth%2Fcpp-xmltooling.git diff --git a/xmltooling/io/GenericRequest.h b/xmltooling/io/GenericRequest.h index af983d5..e540b2e 100644 --- a/xmltooling/io/GenericRequest.h +++ b/xmltooling/io/GenericRequest.h @@ -1,6 +1,6 @@ /* - * Copyright 2001-2007 Internet2 - * + * Copyright 2001-2009 Internet2 + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -16,8 +16,8 @@ /** * @file xmltooling/io/GenericRequest.h - * - * Interface to generic protocol requests that transport XML messages. + * + * Interface to generic protocol requests that transport XML messages. */ #ifndef __xmltooling_genreq_h__ @@ -33,10 +33,10 @@ #endif namespace xmltooling { - + /** * Interface to generic protocol requests that transport XML messages. - * + * *
This interface need not be threadsafe.
*/
class XMLTOOL_API GenericRequest {
@@ -45,60 +45,60 @@ namespace xmltooling {
GenericRequest() {}
public:
virtual ~GenericRequest() {}
-
+
/**
* Returns the URL scheme of the request (http, https, ftp, ldap, etc.)
- *
+ *
* @return the URL scheme
*/
virtual const char* getScheme() const=0;
-
+
/**
* Returns true iff the request is over a confidential channel.
- *
+ *
* @return confidential channel indicator
*/
virtual bool isSecure() const=0;
-
+
/**
* Returns hostname of service that received request.
- *
+ *
* @return hostname of service
*/
virtual const char* getHostname() const=0;
/**
* Returns incoming port.
- *
- * @return incoming port
+ *
+ * @return incoming port
*/
virtual int getPort() const=0;
-
+
/**
* Returns the MIME type of the request, if known.
- *
+ *
* @return the MIME type, or an empty string
*/
virtual std::string getContentType() const=0;
/**
* Returns the length of the request body, if known.
- *
+ *
* @return the content length, or -1 if unknown
*/
virtual long getContentLength() const=0;
/**
* Returns the raw request body.
- *
+ *
* @return the request body, or NULL
*/
virtual const char* getRequestBody() const=0;
-
+
/**
* Returns a decoded named parameter value from the request.
* If a parameter has multiple values, only one will be returned.
- *
+ *
* @param name the name of the parameter to return
* @return a single parameter value or NULL
*/
@@ -107,11 +107,11 @@ namespace xmltooling {
/**
* Returns all of the decoded values of a named parameter from the request.
* All values found will be returned.
- *
+ *
* @param name the name of the parameter to return
* @param values a vector in which to return pointers to the decoded values
* @return the number of values returned
- */
+ */
virtual std::vector