xrootd
XrdHttpExtHandler.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // This file is part of XrdHTTP: A pragmatic implementation of the
3 // HTTP/WebDAV protocol for the Xrootd framework
4 //
5 // Copyright (c) 2017 by European Organization for Nuclear Research (CERN)
6 // Author: Fabrizio Furano <furano@cern.ch>
7 // File Date: May 2017
8 //------------------------------------------------------------------------------
9 // XRootD is free software: you can redistribute it and/or modify
10 // it under the terms of the GNU Lesser General Public License as published by
11 // the Free Software Foundation, either version 3 of the License, or
12 // (at your option) any later version.
13 //
14 // XRootD is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 // GNU General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public License
20 // along with XRootD. If not, see <http://www.gnu.org/licenses/>.
21 //------------------------------------------------------------------------------
22 
23 
24 
25 
26 
27 
28 
29 
30 
31 
32 
33 #ifndef __XRDHTTPEXTHANDLER_H__
34 #define __XRDHTTPEXTHANDLER_H__
35 
36 #include <map>
37 #include <string>
38 
39 class XrdLink;
40 class XrdSecEntity;
41 class XrdHttpReq;
42 class XrdHttpProtocol;
43 
44 // This class summarizes the content of a request, for consumption by an external plugin
46 private:
48 
49 public:
51 
52  std::string verb, resource;
53  std::map<std::string, std::string> &headers;
54 
56  long long length;
57 
58  // A view of the XrdSecEntity associated with the request.
59  const XrdSecEntity &GetSecEntity() const;
60 
62  int BuffgetData(int blen, char **data, bool wait);
63 
65  int SendSimpleResp(int code, const char *desc, const char *header_to_add, const char *body, long long bodylen);
66 
68  // API.
69  int StartChunkedResp(int code, const char *desc, const char *header_to_add);
70 
72  // indicates that this is the last chunk in the response.
73  int ChunkResp(const char *body, long long bodylen);
74 };
75 
76 
80 
81 public:
82 
84  // e.g. applying a prefix matching scheme or whatever
85  virtual bool MatchesPath(const char *verb, const char *path) = 0;
86 
90  virtual int ProcessReq(XrdHttpExtReq &) = 0;
91 
93  virtual int Init(const char *cfgfile) = 0;
94 
95  //------------------------------------------------------------------------------
97  //------------------------------------------------------------------------------
98 
100 
101  //------------------------------------------------------------------------------
103  //------------------------------------------------------------------------------
104 
105  virtual ~XrdHttpExtHandler() {}
106 };
107 
108 /******************************************************************************/
109 /* X r d H t t p G e t E x t H a n d l e r */
110 /******************************************************************************/
111 
112 //------------------------------------------------------------------------------
131 
132 //------------------------------------------------------------------------------
133 
134 class XrdSysError;
135 class XrdOucEnv;
136 
137 #define XrdHttpExtHandlerArgs XrdSysError *eDest, \
138  const char *confg, \
139  const char *parms, \
140  XrdOucEnv *myEnv
141 
143 
144 //------------------------------------------------------------------------------
150 //------------------------------------------------------------------------------
151 
157 #endif
XrdHttpExtHandler * XrdHttpGetExtHandler(XrdHttpExtHandlerArgs)
int SendSimpleResp(int code, const char *desc, const char *header_to_add, const char *body, long long bodylen)
Sends a basic response. If the length is < 0 then it is calculated internally.
virtual int Init(const char *cfgfile)=0
Initializes the external request handler.
const XrdSecEntity & GetSecEntity() const
int BuffgetData(int blen, char **data, bool wait)
Get a pointer to data read from the client, valid for up to blen bytes from the buffer. Returns the validity.
int StartChunkedResp(int code, const char *desc, const char *header_to_add)
Starts a chunked response; body of request is sent over multiple parts using the SendChunkResp.
Definition: XrdHttpReq.hh:77
virtual ~XrdHttpExtHandler()
Destructor.
Definition: XrdHttpExtHandler.hh:105
XrdHttpProtocol * prot
Definition: XrdHttpExtHandler.hh:47
std::map< std::string, std::string > & headers
Definition: XrdHttpExtHandler.hh:53
int ChunkResp(const char *body, long long bodylen)
Send a (potentially partial) body in a chunked response; invoking with NULL body. ...
Definition: XrdSysError.hh:89
virtual bool MatchesPath(const char *verb, const char *path)=0
Tells if the incoming path is recognized as one of the paths that have to be processed.
std::string clientgroups
Definition: XrdHttpExtHandler.hh:55
XrdHttpExtReq(XrdHttpReq *req, XrdHttpProtocol *pr)
Definition: XrdOucEnv.hh:41
Definition: XrdHttpExtHandler.hh:79
std::string verb
Definition: XrdHttpExtHandler.hh:52
long long length
Definition: XrdHttpExtHandler.hh:56
std::string clienthost
Definition: XrdHttpExtHandler.hh:55
Definition: XrdHttpProtocol.hh:76
virtual int ProcessReq(XrdHttpExtReq &)=0
std::string resource
Definition: XrdHttpExtHandler.hh:52
#define XrdHttpExtHandlerArgs
Definition: XrdHttpExtHandler.hh:137
Definition: XrdSecEntity.hh:63
Definition: XrdHttpExtHandler.hh:45
std::string clientdn
Definition: XrdHttpExtHandler.hh:55
XrdHttpExtHandler()
Constructor.
Definition: XrdHttpExtHandler.hh:99