2 * Copyright 2001-2006 Internet2
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
18 * @file SignableObject.h
\r
20 * Base class for SAML objects that can be signed.
\r
23 #ifndef __saml_signable_h__
\r
24 #define __saml_signable_h__
\r
26 #include <saml/base.h>
\r
27 #include <saml/signature/ContentReference.h>
\r
28 #include <xmltooling/XMLObject.h>
\r
30 namespace opensaml {
\r
33 * Base class for SAML objects that can be signed.
\r
35 class SAML_API SignableObject : public virtual xmltooling::XMLObject
\r
38 virtual ~SignableObject() {}
\r
41 * Returns the XML ID for the object being signed, for input to the
\r
42 * reference creation process.
\r
44 * @return XML ID or NULL if not set yet
\r
46 virtual const XMLCh* getId() const=0;
\r
49 * Gets a new ContentReference object bound to this object.
\r
50 * It's lifetime must not outlast this object, so it should
\r
51 * generally be set into a Signature owned by the object.
\r
53 * @return a new ContentReference
\r
55 virtual ContentReference* getContentReference() const {
\r
56 return new ContentReference(*this);
\r
65 #endif /* __saml_signable_h__ */
\r