2019-09-09 15:43:51 +03:00
/* -------------------------------------------------------------------------- */
2022-04-07 20:49:58 +03:00
/* Copyright 2002-2022, OpenNebula Project, OpenNebula Systems */
2019-09-09 15:43:51 +03:00
/* */
/* 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. */
/* -------------------------------------------------------------------------- */
# ifndef HOOK_STATE_HOST_H_
# define HOOK_STATE_HOST_H_
# include "HookImplementation.h"
# include "Host.h"
class HookStateHost : public HookImplementation
{
public :
/**
* @ return true if an state hook needs to be trigger for this Host
*/
static bool trigger ( Host * host ) ;
/**
* Function to build a XML message for a state hook
*/
2020-07-05 23:01:32 +03:00
static std : : string format_message ( Host * host ) ;
2019-09-09 15:43:51 +03:00
private :
friend class Hook ;
// *************************************************************************
// Constructor/Destructor
// *************************************************************************
HookStateHost ( ) : state ( Host : : INIT ) { } ;
virtual ~ HookStateHost ( ) = default ;
/**
* Check if type dependent attributes are well defined .
* @ param tmpl pointer to the Hook template
* @ param error_str string with error information
* @ return 0 on success
*/
int parse_template ( Template * tmpl , std : : string & error_str ) ;
/**
* Rebuilds the object from a template
* @ param tmpl The template
*
* @ return 0 on success , - 1 otherwise
*/
int from_template ( const Template * tmpl , std : : string & error ) ;
/* Checks the mandatory template attributes
* @ param tmpl The hook template
* @ param error string describing the error if any
* @ return 0 on success
*/
int post_update_template ( Template * tmpl , std : : string & error ) ;
// -------------------------------------------------------------------------
// Hook API Attributes
// -------------------------------------------------------------------------
/**
* States hook_state state which trigger the hook
*/
Host : : HostState state ;
} ;
# endif