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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file saml/signature/SignableObject.h
24 * Base class for SAML objects that can be signed.
27 #ifndef __saml_signable_h__
28 #define __saml_signable_h__
30 #include <saml/base.h>
31 #include <xmltooling/XMLObject.h>
33 namespace xmlsignature {
34 class XMLTOOL_API Signature;
40 * Base class for SAML objects that can be signed.
42 class SAML_API SignableObject : public virtual xmltooling::XMLObject
45 virtual ~SignableObject();
48 * Returns the enveloped Signature from the object.
50 * @return the enveloped Signature, or nullptr
52 virtual xmlsignature::Signature* getSignature() const=0;
55 * Sets an enveloped Signature in the object.
57 * @param sig the enveloped Signature, or nullptr
59 virtual void setSignature(xmlsignature::Signature* sig)=0;
65 * Search the object for non-visible namespaces, and pin them
66 * on the root of the object where necessary, adding them to
67 * the inclusive prefix list for signing purposes.
69 void declareNonVisibleNamespaces() const;
74 #endif /* __saml_signable_h__ */