1 /**
2  * Licensed to the University Corporation for Advanced Internet
3  * Development, Inc. (UCAID) under one or more contributor license
4  * agreements. See the NOTICE file distributed with this work for
5  * additional information regarding copyright ownership.
6  *
7  * UCAID licenses this file to you under the Apache License,
8  * Version 2.0 (the "License"); you may not use this file except
9  * in compliance with the License. You may obtain a copy of the
10  * License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing,
15  * software distributed under the License is distributed on an
16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17  * either express or implied. See the License for the specific
18  * language governing permissions and limitations under the License.
19  */
20 
21 /**
22  * @file saml/saml2/binding/SAML2MessageDecoder.h
23  *
24  * Base class for SAML 2.0 MessageDecoders.
25  */
26 
27 #ifndef __saml2_msgencoder_h__
28 #define __saml2_msgencoder_h__
29 
30 #include <saml/binding/MessageEncoder.h>
31 #include <saml/saml2/core/Protocols.h>
32 
33 namespace xmltooling {
34     class HTTPResponse;
35 }
36 
37 namespace opensaml {
38     namespace saml2p {
39 
40         /**
41          *  Base class for SAML 2.0 MessageEncoders.
42          */
43         class SAML_API SAML2MessageEncoder : public MessageEncoder
44         {
45         protected:
46             SAML2MessageEncoder();
47             virtual ~SAML2MessageEncoder();
48 
49             /**
50              * If the message is a request and relay state is provided, the request ID is preserved in a correlation cookie.
51              *
52              * @param response HTTP response
53              * @param message the SAML message
54              * @param relayState the RelayState token
55              */
56             void preserveCorrelationID(
57                 xmltooling::HTTPResponse& response, const RequestAbstractType& message, const char* relayState
58                 ) const;
59 
60         public:
61             const XMLCh* getProtocolFamily() const;
62         };
63     };
64 };
65 
66 #endif /* __saml2_msgencoder_h__ */
67