icinga2/lib/remote/objectqueryhandler.hpp

/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */

#ifndef OBJECTQUERYHANDLER_H
#define OBJECTQUERYHANDLER_H

#include "remote/httphandler.hpp"

namespace icinga
{

class ObjectQueryHandler final : public HttpHandler
{
public:
	DECLARE_PTR_TYPEDEFS(ObjectQueryHandler);

	bool HandleRequest(
		const WaitGroup::Ptr& waitGroup,
		const HttpApiRequest& request,
		HttpApiResponse& response,
		boost::asio::yield_context& yc
	) override;

private:
	static Dictionary::Ptr SerializeObjectAttrs(const Object::Ptr& object, const String& attrPrefix,
		const Array::Ptr& attrs, bool isJoin, bool allAttrs);
};

}

#endif /* OBJECTQUERYHANDLER_H */
Replace Copyright header with a short version, part I CLion -> replace in path 2019-02-25 08:48:22 -05:00			`/* Icinga 2 \| (c) 2012 Icinga GmbH \| GPLv2+ */`
Implement HTTP support refs #9447 2015-06-22 05:11:21 -04:00
Rename statusqueryhandler to objectqueryhandler fixes #10209 2015-09-24 11:38:44 -04:00			`#ifndef OBJECTQUERYHANDLER_H`
			`#define OBJECTQUERYHANDLER_H`
Implement HTTP support refs #9447 2015-06-22 05:11:21 -04:00
			`#include "remote/httphandler.hpp"`

			`namespace icinga`
			`{`

Add the final keyword to classes 2018-01-04 00:11:04 -05:00			`class ObjectQueryHandler final : public HttpHandler`
Implement HTTP support refs #9447 2015-06-22 05:11:21 -04:00			`{`
			`public:`
Rename statusqueryhandler to objectqueryhandler fixes #10209 2015-09-24 11:38:44 -04:00			`DECLARE_PTR_TYPEDEFS(ObjectQueryHandler);`
Implement HTTP support refs #9447 2015-06-22 05:11:21 -04:00
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`bool HandleRequest(`
Use WaitGroup to wait for or abort HTTP requests The wait group gets passed to HttpServerConnection, then down to the HttpHandlers. For those handlers that modify the program state, the wait group is locked so ApiListener will wait on Stop() for the request to complete. If the request iterates over config objects, a further check on the state of the wait group is added to abort early and not delay program shutdown. In that case, 503 responses will be sent to the client. Additionally, in HttpServerConnection, no further requests than the one already started will be allowed once the wait group is joining. 2025-06-11 04:28:16 -04:00			`const WaitGroup::Ptr& waitGroup,`
Update names of HttpRequest and HttpResponse 2026-01-22 06:41:21 -05:00			`const HttpApiRequest& request,`
			`HttpApiResponse& response,`
Remove extra parameters from HTTP handler signature These parameters are no longer needed since they were only used by EventsHandler which was refactored in an earlier commit. 2025-07-23 03:44:26 -04:00			`boost::asio::yield_context& yc`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`) override;`
Change output format for object queries fixes #10551 2015-11-06 05:04:58 -05:00
			`private:`
			`static Dictionary::Ptr SerializeObjectAttrs(const Object::Ptr& object, const String& attrPrefix,`
Whitespace fix What does this change? * Remove use of spaces for formatting These could be found by using `grep -r -l -P '^\t+ +[^]' Removal of training whitespaces * A few lines longer than 120 chars 2017-12-19 09:50:05 -05:00			`const Array::Ptr& attrs, bool isJoin, bool allAttrs);`
Implement HTTP support refs #9447 2015-06-22 05:11:21 -04:00			`};`

			`}`

Rename statusqueryhandler to objectqueryhandler fixes #10209 2015-09-24 11:38:44 -04:00			`#endif /* OBJECTQUERYHANDLER_H */`