xrootd
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
XrdOfsFSctl_PI.hh
Go to the documentation of this file.
1 #ifndef __XRDOFSFSCTL_PI_H__
2 #define __XRDOFSFSCTL_PI_H__
3 /******************************************************************************/
4 /* */
5 /* X r d O f s F S c t l _ P I . h h */
6 /* */
7 /* (c) 2020 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
35 
36 class XrdAccAuthorize;
37 class XrdCmsClient;
38 class XrdOss;
39 class XrdOucEnv;
40 class XrdOucErrInfo;
41 class XrdSecEntity;
42 class XrdSfsFile;
43 class XrdSfsFileSystem;
44 class XrdSfsFSctl;
45 class XrdSysError;
46 
47 /******************************************************************************/
48 /* X r d O f s F S C t l */
49 /******************************************************************************/
50 
52 {
53 public:
54 friend class XrdOfsConfigPI;
55 
56 //-----------------------------------------------------------------------------
58 //-----------------------------------------------------------------------------
59 
60 struct Plugins
64  XrdSfsFileSystem *sfsPI;
65  };
66 
67 //-----------------------------------------------------------------------------
77 //-----------------------------------------------------------------------------
78 
79 virtual bool Configure(const char *CfgFN,
80  const char *Parms,
81  XrdOucEnv *envP,
82  const Plugins &plugs) {return true;}
83 
84 //-----------------------------------------------------------------------------
100 //-----------------------------------------------------------------------------
101 
102 virtual int FSctl(const int cmd,
103  int alen,
104  const char *args,
105  XrdSfsFile &file,
106  XrdOucErrInfo &eInfo,
107  const XrdSecEntity *client = 0) = 0;
108 
109 //-----------------------------------------------------------------------------
125 //-----------------------------------------------------------------------------
126 
127 virtual int FSctl(const int cmd,
128  XrdSfsFSctl &args,
129  XrdOucErrInfo &eInfo,
130  const XrdSecEntity *client = 0) = 0;
131 
132 //------------------------------------------------------------------------------
134 //------------------------------------------------------------------------------
135 
136  XrdOfsFSctl_PI() : prvPI(0), eDest(0) {}
137 
138 //------------------------------------------------------------------------------
140 //------------------------------------------------------------------------------
141 
142 virtual ~XrdOfsFSctl_PI() {}
143 
144 protected:
145 
146 XrdOfsFSctl_PI *prvPI; // Stacked CTL plugin behind this one for forwarding
147  // If none, then the pointer is zero.
148 XrdSysError *eDest; // Message logging object to be used for messages.
149 };
150 
151 /******************************************************************************/
152 /* X r d O f s F S c t l P l u g i n */
153 /******************************************************************************/
154 
155 //------------------------------------------------------------------------------
159 //------------------------------------------------------------------------------
160 
166 //------------------------------------------------------------------------------
172 //------------------------------------------------------------------------------
173 
179 #endif
XrdCmsClient * cmsPI
-&gt; Cms client object generator plugin
Definition: XrdOfsFSctl_PI.hh:62
XrdAccAuthorize * autPI
-&gt; Authorization plugin
Definition: XrdOfsFSctl_PI.hh:61
virtual bool Configure(const char *CfgFN, const char *Parms, XrdOucEnv *envP, const Plugins &plugs)
Definition: XrdOfsFSctl_PI.hh:79
virtual int FSctl(const int cmd, int alen, const char *args, XrdSfsFile &file, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
Definition: XrdCmsClient.hh:115
Definition: XrdAccAuthorize.hh:65
Definition: XrdSysError.hh:89
XrdSfsFileSystem * sfsPI
-&gt; Sfs plugin (a.k.a. ofs)
Definition: XrdOfsFSctl_PI.hh:64
The Plugins struct is used to pass plugin pointers to configure.
Definition: XrdOfsFSctl_PI.hh:60
&lt; SFS_FSCTL_PLUGIN/PLUGIO parms
Definition: XrdSfsInterface.hh:159
XrdOfsFSctl_PI()
Constructor.
Definition: XrdOfsFSctl_PI.hh:136
Definition: XrdOucErrInfo.hh:100
Definition: XrdOfsConfigPI.hh:60
Definition: XrdOucEnv.hh:41
Definition: XrdOfsFSctl_PI.hh:51
XrdOfsFSctl_PI * prvPI
Definition: XrdOfsFSctl_PI.hh:146
XrdSysError * eDest
Definition: XrdOfsFSctl_PI.hh:148
Definition: XrdOss.hh:497
XrdOss * ossPI
-&gt; Oss plugin
Definition: XrdOfsFSctl_PI.hh:63
Definition: XrdSecEntity.hh:63
Definition: XrdSfsInterface.hh:364
virtual ~XrdOfsFSctl_PI()
Destructor.
Definition: XrdOfsFSctl_PI.hh:142