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
39class XrdLink;
40class XrdSecEntity;
41class XrdHttpReq;
42class XrdHttpProtocol;
43
44// This class summarizes the content of a request, for consumption by an external plugin
46private:
48
49public:
51
52 std::string verb, resource;
53 std::map<std::string, std::string> &headers;
54
56 long long length;
57
58 // Get full client identifier
59 void GetClientID(std::string &clid);
60
61 // A view of the XrdSecEntity associated with the request.
62 const XrdSecEntity &GetSecEntity() const;
63
65 int BuffgetData(int blen, char **data, bool wait);
66
68 int SendSimpleResp(int code, const char *desc, const char *header_to_add, const char *body, long long bodylen);
69
71 // API.
72 int StartChunkedResp(int code, const char *desc, const char *header_to_add);
73
75 // indicates that this is the last chunk in the response.
76 int ChunkResp(const char *body, long long bodylen);
77};
78
79
83
84public:
85
87 // e.g. applying a prefix matching scheme or whatever
88 virtual bool MatchesPath(const char *verb, const char *path) = 0;
89
93 virtual int ProcessReq(XrdHttpExtReq &) = 0;
94
96 virtual int Init(const char *cfgfile) = 0;
97
98 //------------------------------------------------------------------------------
100 //------------------------------------------------------------------------------
101
103
104 //------------------------------------------------------------------------------
106 //------------------------------------------------------------------------------
107
109};
110
111/******************************************************************************/
112/* X r d H t t p G e t E x t H a n d l e r */
113/******************************************************************************/
114
115//------------------------------------------------------------------------------
134
135//------------------------------------------------------------------------------
136
137class XrdSysError;
138class XrdOucEnv;
139
140#define XrdHttpExtHandlerArgs XrdSysError *eDest, \
141 const char *confg, \
142 const char *parms, \
143 XrdOucEnv *myEnv
144
146
147//------------------------------------------------------------------------------
153//------------------------------------------------------------------------------
154
160#endif
XrdHttpExtHandler * XrdHttpGetExtHandler(XrdHttpExtHandlerArgs)
#define XrdHttpExtHandlerArgs
Definition: XrdHttpExtHandler.hh:140
Definition: XrdHttpExtHandler.hh:82
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.
XrdHttpExtHandler()
Constructor.
Definition: XrdHttpExtHandler.hh:102
virtual int ProcessReq(XrdHttpExtReq &)=0
virtual ~XrdHttpExtHandler()
Destructor.
Definition: XrdHttpExtHandler.hh:108
virtual int Init(const char *cfgfile)=0
Initializes the external request handler.
Definition: XrdHttpExtHandler.hh:45
std::string clientdn
Definition: XrdHttpExtHandler.hh:55
std::string clienthost
Definition: XrdHttpExtHandler.hh:55
int ChunkResp(const char *body, long long bodylen)
Send a (potentially partial) body in a chunked response; invoking with NULL body.
XrdHttpExtReq(XrdHttpReq *req, XrdHttpProtocol *pr)
void GetClientID(std::string &clid)
std::map< std::string, std::string > & headers
Definition: XrdHttpExtHandler.hh:53
std::string clientgroups
Definition: XrdHttpExtHandler.hh:55
std::string resource
Definition: XrdHttpExtHandler.hh:52
std::string verb
Definition: XrdHttpExtHandler.hh:52
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.
long long length
Definition: XrdHttpExtHandler.hh:56
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....
const XrdSecEntity & GetSecEntity() const
XrdHttpProtocol * prot
Definition: XrdHttpExtHandler.hh:47
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.
Definition: XrdHttpProtocol.hh:77
Definition: XrdHttpReq.hh:78
Definition: XrdOucEnv.hh:42
Definition: XrdSecEntity.hh:64
Definition: XrdSysError.hh:90