shibsp/TransactionLog.h

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