shibsp/SPRequest.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/SPRequest.h
  19  *
  20  * Interface to server request being processed
  21  */
  22
  23 #ifndef __shibsp_req_h__
  24 #define __shibsp_req_h__
  25
  26 #include <shibsp/RequestMapper.h>
  27 #include <xmltooling/io/HTTPRequest.h>
  28 #include <xmltooling/io/HTTPResponse.h>
  29
  30 namespace shibsp {
  31
  32     class SHIBSP_API Application;
  33     class SHIBSP_API ServiceProvider;
  34     class SHIBSP_API Session;
  35
  36     /**
  37      * Interface to server request being processed
  38      *
  39      * <p>To supply information from the surrounding web server environment,
  40      * a shim must be supplied in the form of this interface to adapt the
  41      * library to different proprietary server APIs.
  42      *
  43      * <p>This interface need not be threadsafe.
  44      */
  45     class SHIBSP_API SPRequest : public virtual xmltooling::HTTPRequest, public virtual xmltooling::HTTPResponse
  46     {
  47     protected:
  48         SPRequest() {}
  49     public:
  50         virtual ~SPRequest() {}
  51
  52         /**
  53          * Returns the locked ServiceProvider processing the request.
  54          *
  55          * @return reference to ServiceProvider
  56          */
  57         virtual const ServiceProvider& getServiceProvider() const=0;
  58
  59         /**
  60          * Returns RequestMapper Settings associated with the request, guaranteed
  61          * to be valid for the request's duration.
  62          *
  63          * @return copy of settings
  64          */
  65         virtual RequestMapper::Settings getRequestSettings() const=0;
  66
  67         /**
  68          * Returns the Application governing the request.
  69          *
  70          * @return reference to Application
  71          */
  72         virtual const Application& getApplication() const=0;
  73
  74         /**
  75          * Returns a locked Session associated with the request.
  76          *
  77          * @return pointer to Session, or NULL
  78          */
  79         virtual Session* getSession() const=0;
  80
  81         /**
  82          * Returns the effective base Handler URL for a resource,
  83          * or the current request URL.
  84          *
  85          * @param resource  resource URL to compute handler for
  86          * @return  base location of handler
  87          */
  88         virtual const char* getHandlerURL(const char* resource=NULL) const=0;
  89
  90         /**
  91          * Get a cookie value supplied by the client.
  92          *
  93          * @param name  name of cookie
  94          * @return  cookie value or NULL
  95          */
  96         virtual const char* getCookie(const char* name) const=0;
  97
  98         /**
  99          * Returns a non-spoofable request header value, if possible.
 100          * Platforms that support environment export can redirect header
 101          * lookups by overriding this method.
 102          *
 103          * @param name  the name of the secure header to return
 104          * @return the header's value, or an empty string
 105          */
 106         virtual std::string getSecureHeader(const char* name) const {
 107             return getHeader(name);
 108         }
 109
 110         /**
 111          * Ensures no value exists for a request header.
 112          *
 113          * @param name  name of header to clear
 114          */
 115         virtual void clearHeader(const char* name)=0;
 116
 117         /**
 118          * Sets a value for a request header.
 119          *
 120          * @param name  name of header to set
 121          * @param value value to set
 122          */
 123         virtual void setHeader(const char* name, const char* value)=0;
 124
 125         /**
 126          * Establish REMOTE_USER identity in request.
 127          *
 128          * @param user  REMOTE_USER value to set or NULL to clear
 129          */
 130         virtual void setRemoteUser(const char* user)=0;
 131
 132         /** Portable logging levels. */
 133         enum SPLogLevel {
 134           SPDebug,
 135           SPInfo,
 136           SPWarn,
 137           SPError,
 138           SPCrit
 139         };
 140
 141         /**
 142          * Log to native server environment.
 143          *
 144          * @param level logging level
 145          * @param msg   message to log
 146          */
 147         virtual void log(SPLogLevel level, const std::string& msg) const=0;
 148
 149         /**
 150          * Test logging level.
 151          *
 152          * @param level logging level
 153          * @return true iff logging level is enabled
 154          */
 155         virtual bool isPriorityEnabled(SPLogLevel level) const=0;
 156
 157         /**
 158          * Indicates that processing was declined, meaning no action is required during this phase of processing.
 159          *
 160          * @return  a status code to pass back to the server-specific layer
 161          */
 162         virtual long returnDecline()=0;
 163
 164         /**
 165          * Indicates that processing was completed.
 166          *
 167          * @return  a status code to pass back to the server-specific layer
 168          */
 169         virtual long returnOK()=0;
 170     };
 171 };
 172
 173 #endif /* __shibsp_req_h__ */