2 * Copyright 2001-2007 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/util/PropertySet.h>
28 # include <saml/saml2/metadata/Metadata.h>
33 class SHIBSP_API SPRequest;
36 * Pluggable runtime functionality that implement protocols and services
38 class SHIBSP_API Handler : public virtual PropertySet
40 MAKE_NONCOPYABLE(Handler);
47 * Executes handler functionality as an incoming request.
49 * <p>Handlers can be run either directly by incoming web requests
50 * or indirectly/implicitly during other SP processing.
52 * @param request SP request context
53 * @param isHandler true iff executing in the context of a direct handler invocation
54 * @return a pair containing a "request completed" indicator and a server-specific response code
56 virtual std::pair<bool,long> run(SPRequest& request, bool isHandler=true) const=0;
60 * Generates and/or modifies metadata reflecting the Handler.
62 * <p>The default implementation does nothing.
64 * @param role metadata role to decorate
65 * @param handlerURL base location of handler's endpoint
67 virtual void generateMetadata(opensaml::saml2md::SPSSODescriptor& role, const char* handlerURL) const {
71 * Returns the "type" of the Handler plugin.
73 * @return a Handler type
75 virtual const char* getType() const {
76 return getString("type").second;
81 /** Registers Handler implementations. */
82 void SHIBSP_API registerHandlers();
84 /** Handler for metadata generation. */
85 #define METADATA_GENERATOR_HANDLER "MetadataGenerator"
87 /** Handler for status information. */
88 #define STATUS_HANDLER "Status"
90 /** Handler for session diagnostic information. */
91 #define SESSION_HANDLER "Session"
94 #endif /* __shibsp_handler_h__ */