shibsp/handler/LogoutInitiator.h

   1 /*
   2  *  Copyright 2010 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/handler/LogoutInitiator.h
  19  *
  20  * Pluggable runtime functionality that handles initiating logout.
  21  */
  22
  23 #ifndef __shibsp_logoutinitiator_h__
  24 #define __shibsp_logoutinitiator_h__
  25
  26 #include <shibsp/handler/LogoutHandler.h>
  27
  28 namespace shibsp {
  29
  30     /**
  31      * Pluggable runtime functionality that handles initiating logout.
  32      */
  33     class SHIBSP_API LogoutInitiator : public LogoutHandler
  34     {
  35     protected:
  36         LogoutInitiator();
  37     public:
  38         virtual ~LogoutInitiator();
  39
  40 #ifndef SHIBSP_LITE
  41         const char* getType() const;
  42 #endif
  43     };
  44
  45     /** Registers LogoutInitiator implementations. */
  46     void SHIBSP_API registerLogoutInitiators();
  47
  48     /** LogoutInitiator that iterates through a set of protocol-specific versions. */
  49     #define CHAINING_LOGOUT_INITIATOR "Chaining"
  50
  51     /** LogoutInitiator that supports SAML 2.0 LogoutRequests. */
  52     #define SAML2_LOGOUT_INITIATOR "SAML2"
  53
  54     /** LogoutInitiator that supports local-only logout. */
  55     #define LOCAL_LOGOUT_INITIATOR "Local"
  56 };
  57
  58 #endif /* __shibsp_logoutinitiator_h__ */