2 * Copyright 2010 Internet2
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
18 * @file shibsp/binding/ProtocolProvider.h
\r
20 * Interface to protocol, binding, and default endpoint information.
\r
23 #ifndef __shibsp_protprov_h__
\r
24 #define __shibsp_protprov_h__
\r
26 #include <shibsp/base.h>
\r
29 #include <xmltooling/Lockable.h>
\r
33 class SHIBSP_API PropertySet;
\r
36 * Interface to protocol, binding, and default endpoint information.
\r
38 class SHIBSP_API ProtocolProvider : public virtual xmltooling::Lockable
\r
40 MAKE_NONCOPYABLE(ProtocolProvider);
\r
44 virtual ~ProtocolProvider();
\r
47 * Returns information about a service supported by a protocol, as a PropertySet.
\r
49 * @param protocol the name of a protocol
\r
50 * @param service the name of a service
\r
51 * @return a PropertySet associated with a service
\r
53 virtual const PropertySet* getService(const char* protocol, const char* service) const=0;
\r
56 * Returns an ordered array of protocol bindings available for a specified service.
\r
58 * @param protocol the name of a protocol
\r
59 * @param service name of the protocol service
\r
60 * @return the array of bindings, each represented as a PropertySet
\r
62 virtual const std::vector<const PropertySet*>& getBindings(const char* protocol, const char* service) const=0;
\r
66 * Registers ProtocolProvider classes into the runtime.
\r
68 void SHIBSP_API registerProtocolProviders();
\r
70 /** ProtocolProvider based on an XML configuration format. */
\r
71 #define XML_PROTOCOL_PROVIDER "XML"
\r
74 #endif /* __shibsp_protprov_h__ */
\r