XrdOfsFSctl_PI.hh

Go to the documentation of this file.

#ifndef __XRDOFSFSCTL_PI_H__
#define __XRDOFSFSCTL_PI_H__
/******************************************************************************/
/*                                                                            */
/*                     X r d O f s F S c t l _ P I . h h                      */
/*                                                                            */
/* (c) 2020 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
 
class XrdAccAuthorize;
class XrdCmsClient;
class XrdOss;
class XrdOucEnv;
class XrdOucErrInfo;
class XrdSecEntity;
class XrdSfsFile;
class XrdSfsFileSystem;
class XrdSfsFSctl;
class XrdSysError;
  
/******************************************************************************/
/*                           X r d O f s F S C t l                            */
/******************************************************************************/
  
class XrdOfsFSctl_PI
{
public:
friend class XrdOfsConfigPI;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
struct Plugins
      {XrdAccAuthorize  *autPI;    
       XrdCmsClient     *cmsPI;    
       XrdOss           *ossPI;    
       XrdSfsFileSystem *sfsPI;    
      };
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual bool           Configure(const char    *CfgFN,
                                 const char    *Parms,
                                 XrdOucEnv     *envP,
                                 const Plugins &plugs) {return true;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual int            FSctl(const int               cmd,
                                   int               alen,
                             const char             *args,
                                   XrdSfsFile       &file,
                                   XrdOucErrInfo    &eInfo,
                             const XrdSecEntity     *client = 0) = 0;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
virtual int            FSctl(const int               cmd,
                                   XrdSfsFSctl      &args,
                                   XrdOucErrInfo    &eInfo,
                             const XrdSecEntity     *client = 0) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
             XrdOfsFSctl_PI() : prvPI(0), eDest(0) {}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual     ~XrdOfsFSctl_PI() {}
 
protected:
 
XrdOfsFSctl_PI  *prvPI; // Stacked CTL plugin behind this one for forwarding
                        // If none, then the pointer is zero.
XrdSysError     *eDest; // Message logging object to be used for messages.
};
 
/******************************************************************************/
/*                    X r d O f s F S c t l   P l u g i n                     */
/******************************************************************************/
  
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#endif