1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* Copyright 2001-2007 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file shibsp/RequestMapper.h
*
* Interface to a request mapping plugin
*/
#ifndef __shibsp_reqmap_h__
#define __shibsp_reqmap_h__
#include <shibsp/base.h>
#include <xmltooling/Lockable.h>
#include <xmltooling/io/HTTPRequest.h>
namespace shibsp {
class SHIBSP_API AccessControl;
class SHIBSP_API PropertySet;
/**
* Interface to a request mapping plugin
*
* Request mapping plugins return configuration settings that apply to resource requests.
* They can be implemented through cross-platform or platform-specific mechanisms.
*/
class SHIBSP_API RequestMapper : public virtual xmltooling::Lockable
{
MAKE_NONCOPYABLE(RequestMapper);
protected:
RequestMapper() {}
public:
virtual ~RequestMapper() {}
/** Combination of configuration settings and effective access control. */
typedef std::pair<const PropertySet*,AccessControl*> Settings;
/**
* Map request to settings.
*
* @param request SP request
* @return configuration settings and effective AccessControl plugin, if any
*/
virtual Settings getSettings(const xmltooling::HTTPRequest& request) const=0;
};
/**
* Registers RequestMapper classes into the runtime.
*/
void SHIBSP_API registerRequestMappers();
/** XML-based RequestMapper implementation. */
#define XML_REQUEST_MAPPER "XML"
/** Hybrid of XML and platform-specific configuration. */
#define NATIVE_REQUEST_MAPPER "Native"
};
#endif /* __shibsp_reqmap_h__ */
|
