procedure.h

/*************************************************************************
 * libjson-rpc-cpp
 *************************************************************************
 * @file    procedure.h
 * @date    31.12.2012
 * @author  Peter Spiess-Knafl <dev@spiessknafl.at>
 * @license See attached LICENSE.txt
 ************************************************************************/

#ifndef JSONRPC_CPP_PROCEDURE_H_
#define JSONRPC_CPP_PROCEDURE_H_

#include <map>
#include <string>

#include "jsonparser.h"
#include "specification.h"

namespace jsonrpc {
  typedef std::map<std::string, jsontype_t> parameterNameList_t;
  typedef std::vector<jsontype_t> parameterPositionList_t;

  typedef enum { PARAMS_BY_NAME, PARAMS_BY_POSITION, PARAMS_BY_POSITION_WITH_OPTIONAL } parameterDeclaration_t;

  class Procedure {
  public:
    Procedure();

    /**
     * @brief Constructor for notificaiton with parameters as va_list. The last parameter must be NULL.
     * If no parameters are passed, parameters either do not exist, or cannot be checked for type compliance by the library.
     * @param name
     */
    Procedure(const std::string &name, parameterDeclaration_t paramType, ...);

    /**
     * @brief Constructor for method with parameters as va_list. The last parameter must be NULL.
     * If no parameters are passed, parameters either do not exist, or cannot be checked for type compliance by the library.
     * @param name
     * @param returntype
     */
    Procedure(const std::string &name, parameterDeclaration_t paramType, jsontype_t returntype, ...);

    /**
     * This method is validating the incoming parameters for each procedure.
     * @param parameters - should contain the parameter-object of an valid json-rpc 2.0 request
     * @see http://groups.google.com/group/json-rpc/web/json-rpc-2-0
     * @return true on successful validation false otherwise.
     *
     * If the valid parameters are of Type JSON_ARRAY or JSON_OBJECT, they can only be checked for name and not for their structure.
     */
    bool ValdiateParameters(const Json::Value &parameters) const;

    // Various get methods.
    const parameterNameList_t &GetParameters() const;
    procedure_t GetProcedureType() const;
    const std::string &GetProcedureName() const;
    jsontype_t GetReturnType() const;
    parameterDeclaration_t GetParameterDeclarationType() const;

    // Various set methods.
    void SetProcedureName(const std::string &name);
    void SetProcedureType(procedure_t type);
    void SetReturnType(jsontype_t type);
    void SetParameterDeclarationType(parameterDeclaration_t type);

    /**
     * @brief AddParameter
     * @param name describes the name of the parameter. In case of an positional parameters, this value can be anything.
     * @param type describes the defined type for this parameter.
     */
    void AddParameter(const std::string &name, jsontype_t type);

    bool ValidateNamedParameters(const Json::Value &parameters) const;
    bool ValidatePositionalParameters(const Json::Value &parameters) const;
    bool ValidateOptionalPositionalParameters(const Json::Value &parameters) const;

  private:
    /**
     * Each Procedure should have a name.
     */
    std::string procedureName;

    /**
     * This map represents all necessary Parameters of each Procedure.
     * The string represents the name of each parameter and JsonType the type it should have.
     */
    parameterNameList_t parametersName;

    /**
     * This vector holds all parametertypes by position.
     */
    parameterPositionList_t parametersPosition;

    /**
     * @brief defines whether the procedure is a method or a notification
     */
    procedure_t procedureType;

    /**
     * @brief this field is only valid if procedure is of type method (not notification).
     */
    jsontype_t returntype;

    /**
     * @brief paramDeclaration this field defines if procedure uses named or positional parameters.
     */
    parameterDeclaration_t paramDeclaration;

    bool ValidateSingleParameter(jsontype_t expectedType, const Json::Value &value) const;
  };
} /* namespace jsonrpc */
#endif /* JSONRPC_CPP_PROCEDURE_H_ */