2 * Copyright 2001-2009 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/Handler.h
20 * Pluggable runtime functionality that implement protocols and services.
23 #ifndef __shibsp_handler_h__
24 #define __shibsp_handler_h__
26 #include <shibsp/SPRequest.h>
27 #include <shibsp/util/PropertySet.h>
32 class SAML_API SPSSODescriptor;
37 namespace xmltooling {
38 class XMLTOOL_API HTTPRequest;
39 class XMLTOOL_API HTTPResponse;
45 * Pluggable runtime functionality that implement protocols and services
47 class SHIBSP_API Handler : public virtual PropertySet
49 MAKE_NONCOPYABLE(Handler);
54 * Log using handler's specific logging object.
56 * @param level logging level
57 * @param msg message to log
59 virtual void log(SPRequest::SPLogLevel level, const std::string& msg) const;
62 * Implements various mechanisms to preserve RelayState,
63 * such as cookies or StorageService-backed keys.
65 * <p>If a supported mechanism can be identified, the input parameter will be
66 * replaced with a suitable state key.
68 * @param application the associated Application
69 * @param response outgoing HTTP response
70 * @param relayState RelayState token to supply with message
72 virtual void preserveRelayState(
73 const Application& application, xmltooling::HTTPResponse& response, std::string& relayState
77 * Implements various mechanisms to recover RelayState,
78 * such as cookies or StorageService-backed keys.
80 * <p>If a supported mechanism can be identified, the input parameter will be
81 * replaced with the recovered state information.
83 * @param application the associated Application
84 * @param request incoming HTTP request
85 * @param response outgoing HTTP response
86 * @param relayState RelayState token supplied with message
87 * @param clear true iff the token state should be cleared
89 virtual void recoverRelayState(
90 const Application& application,
91 const xmltooling::HTTPRequest& request,
92 xmltooling::HTTPResponse& response,
93 std::string& relayState,
101 * Executes handler functionality as an incoming request.
103 * <p>Handlers can be run either directly by incoming web requests
104 * or indirectly/implicitly during other SP processing.
106 * @param request SP request context
107 * @param isHandler true iff executing in the context of a direct handler invocation
108 * @return a pair containing a "request completed" indicator and a server-specific response code
110 virtual std::pair<bool,long> run(SPRequest& request, bool isHandler=true) const=0;
114 * Generates and/or modifies metadata reflecting the Handler.
116 * <p>The default implementation does nothing.
118 * @param role metadata role to decorate
119 * @param handlerURL base location of handler's endpoint
121 virtual void generateMetadata(opensaml::saml2md::SPSSODescriptor& role, const char* handlerURL) const {
125 * Returns the "type" of the Handler plugin.
127 * @return a Handler type
129 virtual const char* getType() const;
133 /** Registers Handler implementations. */
134 void SHIBSP_API registerHandlers();
136 /** Handler for metadata generation. */
137 #define METADATA_GENERATOR_HANDLER "MetadataGenerator"
139 /** Handler for status information. */
140 #define STATUS_HANDLER "Status"
142 /** Handler for session diagnostic information. */
143 #define SESSION_HANDLER "Session"
146 #endif /* __shibsp_handler_h__ */