saml/signature/SignableObject.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \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
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\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
  15  */\r
  16 \r
  17 /**\r
  18  * @file saml/signature/SignableObject.h\r
  19  * \r
  20  * Base class for SAML objects that can be signed. \r
  21  */\r
  22 \r
  23 #ifndef __saml_signable_h__\r
  24 #define __saml_signable_h__\r
  25 \r
  26 #include <saml/base.h>\r
  27 #include <saml/signature/ContentReference.h>\r
  28 #include <xmltooling/XMLObject.h>\r
  29 \r
  30 namespace opensaml {\r
  31 \r
  32     /**\r
  33      * Base class for SAML objects that can be signed.\r
  34      */\r
  35     class SAML_API SignableObject : public virtual xmltooling::XMLObject\r
  36     {\r
  37     public:\r
  38         virtual ~SignableObject() {}\r
  39 \r
  40         /**\r
  41          * Gets a new ContentReference object bound to this object.\r
  42          * It's lifetime must not outlast this object, so it should\r
  43          * generally be set into a Signature owned by the object.\r
  44          * \r
  45          * @return  a new ContentReference\r
  46          */\r
  47         virtual ContentReference* getContentReference() const {\r
  48             return new ContentReference(*this);\r
  49         }\r
  50         \r
  51     protected:\r
  52         SignableObject() {}\r
  53     };\r
  54 \r
  55 };\r
  56 \r
  57 #endif /* __saml_signable_h__ */\r