First set of logout base classes and non-building draft of SP-initiated logout.
[shibboleth/sp.git] / shibsp / attribute / filtering / BasicFilteringContext.h
1 /*
2  *  Copyright 2001-2007 Internet2
3  * 
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
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /**
18  * @file shibsp/attribute/filtering/BasicFilteringContext.h
19  * 
20  * A trivial FilteringContext implementation.
21  */
22
23 #ifndef __shibsp_basicfiltctx_h__
24 #define __shibsp_basicfiltctx_h__
25
26 #include <shibsp/attribute/filtering/FilteringContext.h>
27
28 namespace shibsp {
29
30     class SHIBSP_API BasicFilteringContext : public FilteringContext
31     {
32     public:
33         /**
34          * Constructor.
35          *
36          * @param app                   reference to Application
37          * @param attributes            attributes being filtered
38          * @param role                  metadata role of Attribute issuer, if any
39          * @param authncontext_class    method/category of authentication event, if known
40          * @param authncontext_decl     specifics of authentication event, if known
41          */
42         BasicFilteringContext(
43             const Application& app,
44             const std::multimap<std::string,Attribute*>& attributes,
45             const opensaml::saml2md::RoleDescriptor* role=NULL,
46             const XMLCh* authncontext_class=NULL,
47             const XMLCh* authncontext_decl=NULL
48             ) : m_app(app), m_attributes(attributes), m_role(role), m_issuer(NULL), m_class(authncontext_class), m_decl(authncontext_decl) {
49             if (role)
50                 m_issuer = dynamic_cast<opensaml::saml2md::EntityDescriptor*>(role->getParent())->getEntityID();
51         }
52
53         virtual ~BasicFilteringContext() {}
54
55         const Application& getApplication() const {
56             return m_app;
57         }
58         const XMLCh* getAuthnContextClassRef() const {
59             return m_class;
60         }
61         const XMLCh* getAuthnContextDeclRef() const {
62             return m_decl;
63         }
64         const XMLCh* getAttributeRequester() const {
65             return m_app.getXMLString("entityID").second;
66         }
67         const XMLCh* getAttributeIssuer() const {
68             return m_issuer;
69         }
70         const opensaml::saml2md::RoleDescriptor* getAttributeRequesterMetadata() const {
71             return NULL;
72         }
73         const opensaml::saml2md::RoleDescriptor* getAttributeIssuerMetadata() const {
74             return m_role;
75         }
76         const std::multimap<std::string,Attribute*>& getAttributes() const {
77             return m_attributes;
78         }
79
80     private:
81         const Application& m_app;
82         const std::multimap<std::string,Attribute*>& m_attributes;
83         const opensaml::saml2md::RoleDescriptor* m_role;
84         const XMLCh* m_issuer;
85         const XMLCh* m_class;
86         const XMLCh* m_decl;
87     };
88 };
89
90 #endif /* __shibsp_basicfiltctx_h__ */