diff options
Diffstat (limited to 'src/components/application_manager/test/mock/include/application_manager/commands/command_impl.h')
-rw-r--r-- | src/components/application_manager/test/mock/include/application_manager/commands/command_impl.h | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/src/components/application_manager/test/mock/include/application_manager/commands/command_impl.h b/src/components/application_manager/test/mock/include/application_manager/commands/command_impl.h new file mode 100644 index 0000000000..06637d7d84 --- /dev/null +++ b/src/components/application_manager/test/mock/include/application_manager/commands/command_impl.h @@ -0,0 +1,123 @@ +/** + Copyright (c) 2014, Ford Motor Company + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + + Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following + disclaimer in the documentation and/or other materials provided with the + distribution. + + Neither the name of the Ford Motor Company nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_IMPL_H_ +#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_IMPL_H_ + +#include "application_manager/commands/command.h" +#include "utils/logger.h" + +namespace application_manager { + +/** + * @brief Contains command parameters permissions (if any) defined in policy + * table + */ +struct CommandParametersPermissions { + std::vector<std::string> allowed_params; + std::vector<std::string> disallowed_params; + std::vector<std::string> undefined_params; +}; + +namespace commands { + +/** + * @brief Class is intended to encapsulate RPC as an object + **/ +class CommandImpl : public Command { + public: + /** + * @brief CommandImpl class constructor + * + * @param message Incoming SmartObject message + **/ + explicit CommandImpl(const MessageSharedPtr& message); + + /** + * @brief CommandImpl class destructor + * + **/ + virtual ~CommandImpl(); + + /** + * @brief Checks command permissions according to policy table + */ + virtual bool CheckPermissions(); + + /** + * @brief Init required by command resources + **/ + virtual bool Init(); + + /** + * @brief Cleanup all resources used by command + **/ + virtual bool CleanUp(); + + /** + * @brief Execute corresponding command by calling the action on reciever + **/ + virtual void Run(); + + /** + * @brief Retrieves request default timeout. + * If request has a custom timeout, request_timeout_ should be reassign to it + * + * @return Request default timeout + */ + virtual uint32_t default_timeout() const; + + /* + * @brief Retrieves correlation ID + */ + virtual uint32_t correlation_id() const; + + // members + static const int32_t hmi_protocol_type_; + static const int32_t mobile_protocol_type_; + static const int32_t protocol_version_; + + protected: + MessageSharedPtr message_; + uint32_t default_timeout_; + +#ifdef ENABLE_LOG + static log4cxx::LoggerPtr logger_; +#endif // ENABLE_LOG + + private: + DISALLOW_COPY_AND_ASSIGN(CommandImpl); +}; + +} // namespace commands +} // namespace application_manager +#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_IMPL_H_ |