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/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>
28 #include <xmltooling/Lockable.h>
30 namespace xmltooling {
31 class XMLTOOL_API SOAPTransport;
32 class XMLTOOL_API StorageService;
37 class SAML_API SecurityPolicyRule;
43 class SHIBSP_API Application;
44 class SHIBSP_API Handler;
45 class SHIBSP_API ListenerService;
46 class SHIBSP_API RequestMapper;
47 class SHIBSP_API SessionCache;
48 class SHIBSP_API SPRequest;
49 class SHIBSP_API TemplateParameters;
51 class SHIBSP_API TransactionLog;
55 * Interface to a Shibboleth ServiceProvider instance.
57 * <p>A ServiceProvider exposes configuration and infrastructure services required
58 * by the SP implementation, allowing a flexible configuration format.
60 class SHIBSP_API ServiceProvider : public virtual xmltooling::Lockable, public virtual PropertySet
62 MAKE_NONCOPYABLE(ServiceProvider);
66 virtual ~ServiceProvider();
69 * Loads a configuration and prepares the instance for use.
71 * <p>Implemented as a separate method so that services can rely on
72 * other services while they initialize by accessing the ServiceProvider
73 * from the SPConfig singleton.
75 virtual void init()=0;
79 * Returns a TransactionLog instance.
81 * @return a TransactionLog instance
83 virtual TransactionLog* getTransactionLog() const=0;
86 * Returns a StorageService instance based on an ID.
88 * @param id a NULL-terminated key identifying the StorageService to the configuration
89 * @return a StorageService if available, or NULL
91 virtual xmltooling::StorageService* getStorageService(const char* id) const=0;
95 * Returns a SessionCache instance.
97 * @param required true iff an exception should be thrown if no SessionCache is available
98 * @return a SessionCache
100 virtual SessionCache* getSessionCache(bool required=true) const=0;
103 * Returns a ListenerService instance.
105 * @param required true iff an exception should be thrown if no ListenerService is available
106 * @return a ListenerService
108 virtual ListenerService* getListenerService(bool required=true) const=0;
112 * Returns the security policy settings for an identified policy.
114 * @param id identifies the policy to return
115 * @return a PropertySet
117 virtual const PropertySet* getPolicySettings(const char* id) const=0;
120 * Returns the security policy rules for an identified policy.
122 * @param id identifies the policy to return
123 * @return an array of policy rules
125 virtual const std::vector<const opensaml::SecurityPolicyRule*>& getPolicyRules(const char* id) const=0;
128 * Sets implementation-specific transport options.
130 * @param transport a SOAPTransport object
131 * @return true iff all options were successfully set
133 virtual bool setTransportOptions(xmltooling::SOAPTransport& transport) const=0;
137 * Returns a RequestMapper instance.
139 * @param required true iff an exception should be thrown if no RequestMapper is available
140 * @return a RequestMapper
142 virtual RequestMapper* getRequestMapper(bool required=true) const=0;
145 * Returns an Application instance matching the specified ID.
147 * @param applicationId the ID of the application
148 * @return pointer to the application, or NULL
150 virtual const Application* getApplication(const char* applicationId) const=0;
153 * Enforces requirements for an authenticated session.
155 * <p>If the return value's first member is true, then request processing should terminate
156 * with the second member as a status value. If false, processing can continue.
158 * @param request SP request interface
159 * @param handler true iff a request to a registered Handler location can be directly executed
160 * @return a pair containing a "request completed" indicator and a server-specific response code
162 virtual std::pair<bool,long> doAuthentication(SPRequest& request, bool handler=false) const;
165 * Enforces authorization requirements based on the authenticated session.
167 * <p>If the return value's first member is true, then request processing should terminate
168 * with the second member as a status value. If false, processing can continue.
170 * @param request SP request interface
171 * @return a pair containing a "request completed" indicator and a server-specific response code
173 virtual std::pair<bool,long> doAuthorization(SPRequest& request) const;
176 * Publishes session contents to the request in the form of headers or environment variables.
178 * <p>If the return value's first member is true, then request processing should terminate
179 * with the second member as a status value. If false, processing can continue.
181 * @param request SP request interface
182 * @param requireSession set to true iff an error should result if no session exists
183 * @return a pair containing a "request completed" indicator and a server-specific response code
185 virtual std::pair<bool,long> doExport(SPRequest& request, bool requireSession=true) const;
188 * Services requests for registered Handler locations.
190 * <p>If the return value's first member is true, then request processing should terminate
191 * with the second member as a status value. If false, processing can continue.
193 * @param request SP request interface
194 * @return a pair containing a "request completed" indicator and a server-specific response code
196 virtual std::pair<bool,long> doHandler(SPRequest& request) const;
200 * Registers ServiceProvider classes into the runtime.
202 void SHIBSP_API registerServiceProviders();
204 /** SP based on integrated XML and native server configuration. */
205 #define XML_SERVICE_PROVIDER "XML"
208 #endif /* __shibsp_sp_h__ */