-/*\r
- * Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file saml/signature/SignableObject.h\r
- * \r
- * Base class for SAML objects that can be signed. \r
- */\r
-\r
-#ifndef __saml_signable_h__\r
-#define __saml_signable_h__\r
-\r
-#include <saml/base.h>\r
-#include <saml/signature/ContentReference.h>\r
-#include <xmltooling/XMLObject.h>\r
-\r
-namespace opensaml {\r
-\r
- /**\r
- * Base class for SAML objects that can be signed.\r
- */\r
- class SAML_API SignableObject : public virtual xmltooling::XMLObject\r
- {\r
- public:\r
- virtual ~SignableObject() {}\r
-\r
- /**\r
- * Gets a new ContentReference object bound to this object.\r
- * It's lifetime must not outlast this object, so it should\r
- * generally be set into a Signature owned by the object.\r
- * \r
- * @return a new ContentReference\r
- */\r
- virtual ContentReference* getContentReference() const {\r
- return new ContentReference(*this);\r
- }\r
- \r
- protected:\r
- SignableObject() {}\r
- };\r
-\r
-};\r
-\r
-#endif /* __saml_signable_h__ */\r
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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 saml/signature/SignableObject.h
+ *
+ * Base class for SAML objects that can be signed.
+ */
+
+#ifndef __saml_signable_h__
+#define __saml_signable_h__
+
+#include <saml/base.h>
+#include <xmltooling/XMLObject.h>
+
+namespace xmlsignature {
+ class XMLTOOL_API Signature;
+};
+
+namespace opensaml {
+
+ /**
+ * Base class for SAML objects that can be signed.
+ */
+ class SAML_API SignableObject : public virtual xmltooling::XMLObject
+ {
+ public:
+ virtual ~SignableObject();
+
+ /**
+ * Returns the enveloped Signature from the object.
+ *
+ * @return the enveloped Signature, or nullptr
+ */
+ virtual xmlsignature::Signature* getSignature() const=0;
+
+ /**
+ * Sets an enveloped Signature in the object.
+ *
+ * @param sig the enveloped Signature, or nullptr
+ */
+ virtual void setSignature(xmlsignature::Signature* sig)=0;
+
+ protected:
+ SignableObject();
+
+ /**
+ * Search the object for non-visible namespaces, and pin them
+ * on the root of the object where necessary, adding them to
+ * the inclusive prefix list for signing purposes.
+ */
+ void declareNonVisibleNamespaces() const;
+ };
+
+};
+
+#endif /* __saml_signable_h__ */