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          * @param touch true iff the last-used timestamp should be updated and any timeout policy enforced
  78          * @return pointer to Session, or NULL
  79          */
  80         virtual Session* getSession(bool checkTimeout=true) const=0;
  81
  82         /**
  83          * Returns the effective base Handler URL for a resource,
  84          * or the current request URL.
  85          *
  86          * @param resource  resource URL to compute handler for
  87          * @return  base location of handler
  88          */
  89         virtual const char* getHandlerURL(const char* resource=NULL) const=0;
  90
  91         /**
  92          * Get a cookie value supplied by the client.
  93          *
  94          * @param name  name of cookie
  95          * @return  cookie value or NULL
  96          */
  97         virtual const char* getCookie(const char* name) const=0;
  98
  99         /**
 100          * Returns a non-spoofable request header value, if possible.
 101          * Platforms that support environment export can redirect header
 102          * lookups by overriding this method.
 103          *
 104          * @param name  the name of the secure header to return
 105          * @return the header's value, or an empty string
 106          */
 107         virtual std::string getSecureHeader(const char* name) const {
 108             return getHeader(name);
 109         }
 110
 111         /**
 112          * Ensures no value exists for a request header.
 113          *
 114          * @param name  name of header to clear
 115          */
 116         virtual void clearHeader(const char* name)=0;
 117
 118         /**
 119          * Sets a value for a request header.
 120          *
 121          * @param name  name of header to set
 122          * @param value value to set
 123          */
 124         virtual void setHeader(const char* name, const char* value)=0;
 125
 126         /**
 127          * Establish REMOTE_USER identity in request.
 128          *
 129          * @param user  REMOTE_USER value to set or NULL to clear
 130          */
 131         virtual void setRemoteUser(const char* user)=0;
 132
 133         /** Portable logging levels. */
 134         enum SPLogLevel {
 135           SPDebug,
 136           SPInfo,
 137           SPWarn,
 138           SPError,
 139           SPCrit
 140         };
 141
 142         /**
 143          * Log to native server environment.
 144          *
 145          * @param level logging level
 146          * @param msg   message to log
 147          */
 148         virtual void log(SPLogLevel level, const std::string& msg) const=0;
 149
 150         /**
 151          * Test logging level.
 152          *
 153          * @param level logging level
 154          * @return true iff logging level is enabled
 155          */
 156         virtual bool isPriorityEnabled(SPLogLevel level) const=0;
 157
 158         /**
 159          * Indicates that processing was declined, meaning no action is required during this phase of processing.
 160          *
 161          * @return  a status code to pass back to the server-specific layer
 162          */
 163         virtual long returnDecline()=0;
 164
 165         /**
 166          * Indicates that processing was completed.
 167          *
 168          * @return  a status code to pass back to the server-specific layer
 169          */
 170         virtual long returnOK()=0;
 171     };
 172 };
 173
 174 #endif /* __shibsp_req_h__ */