saml/signature/SignableObject.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file saml/signature/SignableObject.h
  19  *
  20  * Base class for SAML objects that can be signed.
  21  */
  22
  23 #ifndef __saml_signable_h__
  24 #define __saml_signable_h__
  25
  26 #include <saml/base.h>
  27 #include <xmltooling/XMLObject.h>
  28
  29 namespace xmlsignature {
  30     class XMLTOOL_API Signature;
  31 };
  32
  33 namespace opensaml {
  34
  35     /**
  36      * Base class for SAML objects that can be signed.
  37      */
  38     class SAML_API SignableObject : public virtual xmltooling::XMLObject
  39     {
  40     public:
  41         virtual ~SignableObject();
  42
  43         /**
  44          * Returns the enveloped Signature from the object.
  45          *
  46          * @return the enveloped Signature, or NULL
  47          */
  48         virtual xmlsignature::Signature* getSignature() const=0;
  49
  50         /**
  51          * Sets an enveloped Signature in the object.
  52          *
  53          * @param sig the enveloped Signature, or NULL
  54          */
  55         virtual void setSignature(xmlsignature::Signature* sig)=0;
  56
  57     protected:
  58         SignableObject();
  59     };
  60
  61 };
  62
  63 #endif /* __saml_signable_h__ */