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

#ifndef XKMSREGISTERRESULT_INCLUDE
#define XKMSREGISTERRESULT_INCLUDE

// XSEC Includes

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

class XKMSKeyBinding;
class XKMSUnverifiedKeyBinding;

class XKMSRegisterResult : public XKMSResultType {


protected:

    XKMSRegisterResult() {};

public:

    virtual ~XKMSRegisterResult() {};


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



    virtual int getKeyBindingSize(void) const = 0;

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

    virtual XKMSKeyBinding * getKeyBindingItem(int item) const = 0;

    /*
     * \brief Append a new KeyBinding element
     *
     * Allows callers to append a new KeyBinding item.
     * The item is initially empty of KeyInfo elements - these must be added
     * by the caller.
     *
     * @param status The status (Valid, Invalid or Indeterminate) of this
     * key
     * @returns the newly created KeyBinding object (already inserted
     * in the RegisterResult
     */

    virtual XKMSKeyBinding * appendKeyBindingItem(XKMSStatus::StatusValue status) = 0;


private:

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

};

#endif /* XKMSREGISTERRESULT_INCLUDE */

---