shibsp/TransactionLog.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/TransactionLog.h
  19  *
  20  * Interface to a synchronized logging object.
  21  */
  22
  23 #ifndef __shibsp_txlog_h__
  24 #define __shibsp_txlog_h__
  25
  26 #include <shibsp/base.h>
  27 #include <xmltooling/logging.h>
  28 #include <xmltooling/Lockable.h>
  29 #include <xmltooling/util/Threads.h>
  30
  31 namespace shibsp {
  32
  33     /**
  34      * Interface to a synchronized logging object.
  35      *
  36      * <p>This is platform/logging specific, but we can at least hide the details here.
  37      */
  38     class SHIBSP_API TransactionLog : public virtual xmltooling::Lockable
  39     {
  40         MAKE_NONCOPYABLE(TransactionLog);
  41     public:
  42         TransactionLog()
  43             : log(xmltooling::logging::Category::getInstance(SHIBSP_TX_LOGCAT)), m_lock(xmltooling::Mutex::create()) {
  44         }
  45
  46         virtual ~TransactionLog() {
  47             delete m_lock;
  48         }
  49
  50         xmltooling::Lockable* lock() {
  51             m_lock->lock();
  52             return this;
  53         }
  54
  55         void unlock() {
  56             m_lock->unlock();
  57         }
  58
  59         /** Logging object. */
  60         xmltooling::logging::Category& log;
  61
  62     private:
  63         xmltooling::Mutex* m_lock;
  64     };
  65 };
  66
  67 #endif /* __shibsp_txlog_h__ */