2 * Copyright 2001-2010 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file shibsp/handler/LogoutHandler.h
20 * Base class for logout-related handlers.
23 #ifndef __shibsp_logout_h__
24 #define __shibsp_logout_h__
26 #include <shibsp/handler/RemotedHandler.h>
30 #if defined (_MSC_VER)
31 #pragma warning( push )
32 #pragma warning( disable : 4251 )
36 * Base class for logout-related handlers.
38 class SHIBSP_API LogoutHandler : public RemotedHandler
41 virtual ~LogoutHandler();
44 * The base method will iteratively attempt front-channel notification
45 * of logout of the current session, and after the final round trip will
46 * perform back-channel notification. Nothing will be done unless the
47 * handler detects that it is the "top" level logout handler.
48 * If the method returns false, then the specialized class should perform
49 * its work assuming that the notifications are completed.
51 * Note that the current session is NOT removed from the cache.
53 * @param request SP request context
54 * @param isHandler true iff executing in the context of a direct handler invocation
55 * @return a pair containing a "request completed" indicator and a server-specific response code
57 std::pair<bool,long> run(SPRequest& request, bool isHandler=true) const;
60 * A remoted procedure that will perform any necessary back-channel
61 * notifications. The input structure must contain an "application_id" member,
62 * and a "sessions" list containing the session keys, along with an integer
63 * member called "notify" with a value of 1.
65 * @param in incoming DDF message
66 * @param out stream to write outgoing DDF message to
68 void receive(DDF& in, std::ostream& out);
73 /** Flag indicating whether the subclass is acting as a LogoutInitiator. */
76 /** Array of query string parameters to preserve across front-channel notifications, if present. */
77 std::vector<std::string> m_preserve;
80 * Perform front-channel logout notifications for an Application.
82 * @param application the Application to notify
83 * @param request last request from browser
84 * @param response response to use for next notification
85 * @param params map of query string parameters to preserve across this notification
86 * @return indicator of a completed response along with the status code to return from the handler
88 std::pair<bool,long> notifyFrontChannel(
89 const Application& application,
90 const xmltooling::HTTPRequest& request,
91 xmltooling::HTTPResponse& response,
92 const std::map<std::string,std::string>* params=nullptr
96 * Perform back-channel logout notifications for an Application.
98 * @param application the Application to notify
99 * @param requestURL requestURL that resulted in method call
100 * @param sessions array of session keys being logged out
101 * @param local true iff the logout operation is local to the SP, false iff global
102 * @return true iff all notifications succeeded
104 bool notifyBackChannel(
105 const Application& application, const char* requestURL, const std::vector<std::string>& sessions, bool local
110 * Sends a response template to the user agent informing it of the results of a logout attempt.
112 * @param application the Application to use in determining the logout template
113 * @param request the HTTP client request to supply to the template
114 * @param response the HTTP response to use
115 * @param local true iff the logout operation was local to the SP, false iff global
116 * @param status optional logoutStatus key value to add to template
118 std::pair<bool,long> sendLogoutPage(
119 const Application& application,
120 const xmltooling::HTTPRequest& request,
121 xmltooling::HTTPResponse& response,
123 const char* status=nullptr
127 * Sends a response template to the user agent informing it of the results of a logout attempt.
129 * @param application the Application to use in determining the logout template
130 * @param request the HTTP client request to supply to the template
131 * @param response the HTTP response to use
132 * @param type designates the prefix of logout template name to use
134 std::pair<bool,long> sendLogoutPage(
135 const Application& application,
136 const xmltooling::HTTPRequest& request,
137 xmltooling::HTTPResponse& response,
142 #if defined (_MSC_VER)
143 #pragma warning( pop )
147 #endif /* __shibsp_logout_h__ */