XKMSLocateResult.hpp

Go to the documentation of this file.

/*
 * Copyright 2004-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
 *
 * XKMSLocateResult := Interface for LocateResult Messages
 *
 * $Id: XKMSLocateResult.hpp,v 1.4 2005/06/04 11:30:26 blautenb Exp $
 *
 */

#ifndef XKMSLOCATERESULT_INCLUDE
#define XKMSLOCATERESULT_INCLUDE

// XSEC Includes

#include <xsec/framework/XSECDefs.hpp>
#include <xsec/xkms/XKMSResultType.hpp>

class XKMSQueryKeyBinding;
class XKMSUnverifiedKeyBinding;

class XKMSLocateResult : public XKMSResultType {


protected:

    XKMSLocateResult() {};

public:

    virtual ~XKMSLocateResult() {};


    virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * getElement(void) const = 0;



    virtual int getUnverifiedKeyBindingSize(void) const = 0;

    /*
     * \brief Obtain an UnverifiedKeyBinding item
     *
     * @param item Index of the item to return (0 = first element)
     * @returns the UnverifiedKeyBinding referenced by "item"
     */

    virtual XKMSUnverifiedKeyBinding * getUnverifiedKeyBindingItem(int item) const = 0;

    /*
     * \brief Append a new UnverifiedKeyBinding element
     *
     * Allows callers to append a new UnverifiedKeyBinding item.
     * The item is initially empty of KeyInfo elements - these must be added
     * by the caller.
     *
     * @returns the newly created UnverifiedKeyBinding object (already inserted
     * in the LocateResult
     */

    virtual XKMSUnverifiedKeyBinding * appendUnverifiedKeyBindingItem(void ) = 0;


private:

    // Unimplemented
    XKMSLocateResult(const XKMSLocateResult &);
    XKMSLocateResult & operator = (const XKMSLocateResult &);

};

#endif /* XKMSLOCATERESULT_INCLUDE */

---