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