OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESFileContainer.cc
Go to the documentation of this file.
1 // BESFileContainer.cc
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library 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 GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #include "BESFileContainer.h"
34 #include "TheBESKeys.h"
35 #include "BESUncompressManager.h"
36 #include "BESCache.h"
37 #include "BESForbiddenError.h"
38 
45 BESFileContainer::BESFileContainer( const string &sym_name,
46  const string &real_name,
47  const string &type )
48  : BESContainer( sym_name, real_name, type )
49 {
50  string::size_type dotdot = real_name.find( ".." ) ;
51  if( dotdot != string::npos )
52  {
53  string s = (string)"'../' not allowed in container real name "
54  + real_name ;
55  throw BESForbiddenError( s, __FILE__, __LINE__ ) ;
56  }
57 }
58 
63 BESFileContainer::BESFileContainer( const BESFileContainer &copy_from )
64  : BESContainer( copy_from )
65 {
66 }
67 
68 void
70 {
71  BESContainer::_duplicate( copy_to ) ;
72 }
73 
80 {
81  BESContainer *container = new BESFileContainer ;
82  BESContainer::_duplicate( *container ) ;
83  return container ;
84 }
85 
91 string
93 {
94  // This is easy ... create the cache using the different keys
95  BESKeys *keys = TheBESKeys::TheKeys() ;
96  BESCache cache( *keys, "BES.CacheDir", "BES.CachePrefix", "BES.CacheSize" );
97 
99  _target, cache ) ;
100  if( _cached )
101  return _target ;
102  return get_real_name() ;
103 }
104 
112 bool
114 {
115  // If the file is cached then we will need to release the lock on the
116  // target
117  return true ;
118 }
119 
127 void
128 BESFileContainer::dump( ostream &strm ) const
129 {
130  strm << BESIndent::LMarg << "BESFileContainer::dump - ("
131  << (void *)this << ")" << endl ;
133  BESContainer::dump( strm ) ;
135 }
136 
static BESUncompressManager * TheManager()
virtual string access()
returns the name of a file to access for this container, uncompressing if neccessary.
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BESContainer.cc:71
Implementation of a caching mechanism.
Definition: BESCache.h:57
Holds real data, container type and constraint for symbolic name read from persistence.
static void Indent()
Definition: BESIndent.cc:38
mapping of key/value pairs defining different behaviors of an application.
Definition: BESKeys.h:84
virtual bool uncompress(const string &src, string &target, BESCache &cache)
find the method that can uncompress the specified src and pass control to that method.
static ostream & LMarg(ostream &strm)
Definition: BESIndent.cc:73
virtual void dump(ostream &strm) const
Displays debug information about this object.
virtual void _duplicate(BESContainer &copy_to)
void _duplicate(BESContainer &copy_to)
duplicate this instance into the passed container
Definition: BESContainer.cc:54
error thrown if the BES is not allowed to access the resource requested
string get_real_name() const
retreive the real name for this container, such as a file name.
Definition: BESContainer.h:141
A container is something that holds data.
Definition: BESContainer.h:60
static void UnIndent()
Definition: BESIndent.cc:44
virtual bool release()
release the file
static BESKeys * TheKeys()
Definition: TheBESKeys.cc:46
virtual BESContainer * ptr_duplicate()
duplicate this instances of BESFileContainer