X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2Fbinding%2FMessageEncoder.h;h=96c30b3cb4173c9cfdd4a1ce0732c5b547c53a7d;hb=40fdf576ed07e3cf8f88d9bf0441e55ea4fc3d05;hp=dcbd86db59a5f2f932a63d9a25573762ddf26a02;hpb=2d05f4d1935e7b79e70f2775a14c10964a04164e;p=shibboleth%2Fcpp-opensaml.git diff --git a/saml/binding/MessageEncoder.h b/saml/binding/MessageEncoder.h index dcbd86d..96c30b3 100644 --- a/saml/binding/MessageEncoder.h +++ b/saml/binding/MessageEncoder.h @@ -1,5 +1,5 @@ /* - * Copyright 2001-2007 Internet2 + * Copyright 2001-2010 Internet2 * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,10 +25,11 @@ #include -#include -#include -#include -#include +namespace xmltooling { + class XMLTOOL_API Credential; + class XMLTOOL_API GenericResponse; + class XMLTOOL_API XMLObject; +}; namespace opensaml { @@ -47,25 +48,35 @@ namespace opensaml { { MAKE_NONCOPYABLE(MessageEncoder); public: - virtual ~MessageEncoder() {} + virtual ~MessageEncoder(); /** * Indicates whether the encoding format requires that messages be as compact as possible. * * @return true iff the encoding has size constraints */ - virtual bool isCompact() const { - return false; - } + virtual bool isCompact() const; /** * Indicates whether a web browser or similar user agent will receive the message. * * @return true iff the message will be handled by a user agent */ - virtual bool isUserAgentPresent() const { - return true; - } + virtual bool isUserAgentPresent() const; + + /** + * Returns identifier for the protocol family associated with the encoder. + * + * @return a protocol family identifier, or nullptr + */ + virtual const XMLCh* getProtocolFamily() const; + + /** + * Returns a shorthand name for the binding/encoding supported by the encoder. + * + * @return a short name for the binding/encoding, or nullptr + */ + virtual const char* getShortName() const; /** * Interface to caller-supplied artifact generation mechanism. @@ -80,9 +91,9 @@ namespace opensaml { class SAML_API ArtifactGenerator { MAKE_NONCOPYABLE(ArtifactGenerator); protected: - ArtifactGenerator() {} + ArtifactGenerator(); public: - virtual ~ArtifactGenerator() {} + virtual ~ArtifactGenerator(); /** * Generate a SAML 1.x artifact suitable for consumption by the relying party. @@ -127,16 +138,16 @@ namespace opensaml { xmltooling::GenericResponse& genericResponse, xmltooling::XMLObject* xmlObject, const char* destination, - const saml2md::EntityDescriptor* recipient=NULL, - const char* relayState=NULL, - const ArtifactGenerator* artifactGenerator=NULL, - const xmltooling::Credential* credential=NULL, - const XMLCh* signatureAlg=NULL, - const XMLCh* digestAlg=NULL + const saml2md::EntityDescriptor* recipient=nullptr, + const char* relayState=nullptr, + const ArtifactGenerator* artifactGenerator=nullptr, + const xmltooling::Credential* credential=nullptr, + const XMLCh* signatureAlg=nullptr, + const XMLCh* digestAlg=nullptr ) const=0; protected: - MessageEncoder() {} + MessageEncoder(); }; /**