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/ServiceProvider.h
20 * Interface to a Shibboleth ServiceProvider instance.
23 #ifndef __shibsp_sp_h__
24 #define __shibsp_sp_h__
26 #include <shibsp/util/PropertySet.h>
27 #include <saml/binding/SecurityPolicyRule.h>
28 #include <xmltooling/signature/CredentialResolver.h>
29 #include <xmltooling/util/StorageService.h>
33 class SHIBSP_API Application;
34 class SHIBSP_API Handler;
35 class SHIBSP_API ListenerService;
36 class SHIBSP_API RequestMapper;
37 class SHIBSP_API SessionCache;
38 class SHIBSP_API SPRequest;
39 class SHIBSP_API TemplateParameters;
40 class SHIBSP_API TransactionLog;
43 * Interface to a Shibboleth ServiceProvider instance.
45 * <p>A ServiceProvider exposes configuration and infrastructure services required
46 * by the SP implementation, allowing a flexible configuration format.
48 class SHIBSP_API ServiceProvider : public virtual xmltooling::Lockable, public virtual PropertySet
50 MAKE_NONCOPYABLE(ServiceProvider);
54 virtual ~ServiceProvider() {}
57 * Loads a configuration and prepares the instance for use.
59 * <p>Implemented as a separate method so that services can rely on
60 * other services while they initialize by accessing the ServiceProvider
61 * from the SPConfig singleton.
63 virtual void init()=0;
66 * Returns a TransactionLog instance.
68 * @return a TransactionLog instance
70 virtual TransactionLog* getTransactionLog() const=0;
73 * Returns a StorageService instance based on an ID.
75 * @param id a NULL-terminated key identifying the StorageService to the configuration
76 * @return a StorageService if available, or NULL
78 virtual xmltooling::StorageService* getStorageService(const char* id) const=0;
81 * Returns a SessionCache instance.
83 * @param required true iff an exception should be thrown if no SessionCache is available
84 * @return a SessionCache
86 virtual SessionCache* getSessionCache(bool required=true) const=0;
89 * Returns a ListenerService instance.
91 * @param required true iff an exception should be thrown if no ListenerService is available
92 * @return a ListenerService
94 virtual ListenerService* getListenerService(bool required=true) const=0;
97 * Returns a CredentialResolver instance mapped to a key.
99 * @param id a NULL-terminated key identifying the CredentialResolver to the configuration
100 * @return a CredentialResolver if available, or NULL
102 virtual xmlsignature::CredentialResolver* getCredentialResolver(const char* id) const=0;
105 * Returns the security policy rules in effect for a Handler instance.
107 * @param handler identifies the Handler for which to return the policy rules
108 * @return array of policy rules
110 virtual std::vector<const opensaml::SecurityPolicyRule*>& getPolicyRules(const Handler& handler) const=0;
113 * Returns a RequestMapper instance.
115 * @param required true iff an exception should be thrown if no RequestMapper is available
116 * @param a RequestMapper
118 virtual RequestMapper* getRequestMapper(bool required=true) const=0;
121 * Returns an Application instance matching the specified ID.
123 * @param applicationId the ID of the application
124 * @return pointer to the application, or NULL
126 virtual const Application* getApplication(const char* applicationId) const=0;
129 * Enforces requirements for an authenticated session.
131 * <p>If the return value's first member is true, then request processing should terminate
132 * with the second member as a status value. If false, processing can continue.
134 * @param request SP request interface
135 * @param handler true iff a request to a registered Handler location can be directly executed
136 * @return a pair containing a "request completed" indicator and a server-specific response code
138 virtual std::pair<bool,long> doAuthentication(SPRequest& request, bool handler=false) const;
141 * Enforces authorization requirements based on the authenticated session.
143 * <p>If the return value's first member is true, then request processing should terminate
144 * with the second member as a status value. If false, processing can continue.
146 * @param request SP request interface
147 * @return a pair containing a "request completed" indicator and a server-specific response code
149 virtual std::pair<bool,long> doAuthorization(SPRequest& request) const;
152 * Publishes session contents to the request in the form of headers or environment variables.
154 * <p>If the return value's first member is true, then request processing should terminate
155 * with the second member as a status value. If false, processing can continue.
157 * @param request SP request interface
158 * @param requireSession set to true iff an error should result if no session exists
159 * @return a pair containing a "request completed" indicator and a server-specific response code
161 virtual std::pair<bool,long> doExport(SPRequest& request, bool requireSession=true) const;
164 * Services requests for registered Handler locations.
166 * <p>If the return value's first member is true, then request processing should terminate
167 * with the second member as a status value. If false, processing can continue.
169 * @param request SP request interface
170 * @return a pair containing a "request completed" indicator and a server-specific response code
172 virtual std::pair<bool,long> doHandler(SPRequest& request) const;
176 * Registers ServiceProvider classes into the runtime.
178 void SHIBSP_API registerServiceProviders();
180 /** SP based on integrated XML and native server configuration. */
181 #define XML_SERVICE_PROVIDER "XML"
184 #endif /* __shibsp_sp_h__ */