XSECEnv.hpp

Go to the documentation of this file.

/*
 * Copyright 2003-2005 The Apache Software Foundation.
 *
 * Licensed 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.
 */

/*
 * XSEC
 *
 * XSECEnv := Configuration class - used by the other classes to retrieve
 *            information on the environment they are working under
 *
 * $Id: XSECEnv.hpp,v 1.9 2005/06/04 11:30:26 blautenb Exp $
 *
 */

#ifndef XSECENV_INCLUDE
#define XSECENV_INCLUDE

// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/utils/XSECSafeBufferFormatter.hpp>

#include <vector>

// Xerces Includes

#include <xercesc/dom/DOM.hpp>

class XSECURIResolver;

/*\@{*/

class DSIG_EXPORT XSECEnv {

public:
    
    
    XSECEnv(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc);
    XSECEnv(const XSECEnv & theOther);
    virtual ~XSECEnv();

    

    void setDSIGNSPrefix(const XMLCh * prefix);

    void setECNSPrefix(const XMLCh * prefix);

    void setXPFNSPrefix(const XMLCh * prefix);

    void setXENCNSPrefix(const XMLCh * prefix);

    void setXKMSNSPrefix(const XMLCh * prefix);

    const XMLCh * getDSIGNSPrefix() const {return mp_prefixNS;}

    const XMLCh * getECNSPrefix() const {return mp_ecPrefixNS;}

    const XMLCh * getXPFNSPrefix() const {return mp_xpfPrefixNS;}

    const XMLCh * getXENCNSPrefix(void) const {return mp_xencPrefixNS;}

    const XMLCh * getXKMSNSPrefix(void) const {return mp_xkmsPrefixNS;}
    


    void setPrettyPrintFlag(bool flag) {m_prettyPrintFlag = flag;}

    bool getPrettyPrintFlag(void) const {return m_prettyPrintFlag;}

    void doPrettyPrint(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * node) const;

    

    XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * getParentDocument() const
        {return mp_doc;}

    void setParentDocument(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * doc)
        {mp_doc = doc;}



    void setURIResolver(XSECURIResolver * resolver);

    XSECURIResolver * getURIResolver(void) const;




    void setIdByAttributeName(bool flag);

    bool getIdByAttributeName(void) const;

    void registerIdAttributeName(const XMLCh * name);

    bool deregisterIdAttributeName(const XMLCh * name);

    bool isRegisteredIdAttributeName(const XMLCh * name) const;

    void registerIdAttributeNameNS(const XMLCh * ns, const XMLCh * name);

    bool deregisterIdAttributeNameNS(const XMLCh *ns, const XMLCh * name);

    bool isRegisteredIdAttributeNameNS(const XMLCh * ns, const XMLCh * name) const;

    int getIdAttributeNameListSize() const;

    /*
     * \brief Get an indexed attribute name to use as an Id
     *
     * Returns the item at index point in the list
     *
     * @note This is an internal function and should not be called directly
     *
     * @param index Pointer into the list
     * @returns The indicated element or NULL if it does not exist.
     */

    const XMLCh * getIdAttributeNameListItem(int index) const;

    /*
     * \brief Get an indexed attribute Namespace to use as an Id
     *
     * Returns the item at index point in the list
     *
     * @note This is an internal function and should not be called directly
     *
     * @param index Pointer into the list
     * @returns The indicated element or NULL if it does not exist.
     */

    const XMLCh * getIdAttributeNameListItemNS(int index) const;

    /*
     * \brief Determine whether the indexed item is namespace aware
     *
     * Returns the item at index point in the list
     *
     * @note This is an internal function and should not be called directly
     *
     * @param index Pointer into the list
     * @returns The indicated element or NULL if it does not exist.
     */

    bool getIdAttributeNameListItemIsNS(int index) const;

    

    XSECSafeBufferFormatter * getSBFormatter(void) const {return mp_formatter;}


private:

    struct IdAttributeStruct;
    typedef struct IdAttributeStruct IdAttributeType;


#if defined(XSEC_NO_NAMESPACES)
    typedef vector<IdAttributeType *>       IdNameVectorType;
#else
    typedef std::vector<IdAttributeType *>  IdNameVectorType;
#endif

    // Internal functions

    XSECSafeBufferFormatter     * mp_formatter;
    XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument                  
                                * mp_doc;
    // For creating functions
    XMLCh                       * mp_prefixNS;
    XMLCh                       * mp_ecPrefixNS;
    XMLCh                       * mp_xpfPrefixNS;
    XMLCh                       * mp_xencPrefixNS;
    XMLCh                       * mp_xkmsPrefixNS;

    // Resolvers
    XSECURIResolver             * mp_URIResolver;

    // Flags
    bool                        m_prettyPrintFlag;
    bool                        m_idByAttributeNameFlag;

    // Id handling
    IdNameVectorType            m_idAttributeNameList;  

    XSECEnv();

    /*\@}*/
};

#endif /* XSECENV_INCLUDE */

---