mrs::endpoint::DbObjectEndpoint Class Reference

#include <db_object_endpoint.h>

Inheritance diagram for mrs::endpoint::DbObjectEndpoint:

Public Types
using	Parent = OptionEndpoint
using	DbObject = mrs::database::entry::DbObject
using	DbObjectPtr = std::shared_ptr< DbObject >
using	HandlerFactoryPtr = std::shared_ptr< mrs::interface::HandlerFactory >
using	DataType = DbObject
Public Types inherited from mrs::endpoint::OptionEndpoint
using	HandlerFactoryPtr = std::shared_ptr< mrs::interface::HandlerFactory >
using	Handler = mrs::interface::RestHandler
using	HandlerPtr = std::shared_ptr< Handler >
Public Types inherited from mrs::interface::EndpointBase
using	EnabledType = mrs::database::entry::EnabledType
using	EndpointBasePtr = std::shared_ptr< EndpointBase >
using	UniversalId = mrs::database::entry::UniversalId
using	Children = std::vector< EndpointBasePtr >
using	EndpointConfiguration = mrs::interface::EndpointConfiguration
using	EndpointConfigurationPtr = std::shared_ptr< EndpointConfiguration >
using	Handler = mrs::interface::RestHandler
using	HandlerPtr = std::shared_ptr< Handler >
using	Uri = ::http::base::Uri
using	OptionalIndexNames = std::optional< std::vector< std::string > >

Public Member Functions
	DbObjectEndpoint (const DbObject &entry, EndpointConfigurationPtr configuration, HandlerFactoryPtr factory)
UniversalId	get_id () const override
UniversalId	get_parent_id () const override
std::optional< std::string >	get_options () const override
const DbObjectPtr	get () const
void	set (const DbObject &entry, EndpointBasePtr parent)
bool	is_index () const
Public Member Functions inherited from mrs::endpoint::OptionEndpoint
	OptionEndpoint (UniversalId service_id, EndpointConfigurationPtr configuration, HandlerFactoryPtr factory)
OptionalIndexNames	get_index_files () override
Public Member Functions inherited from mrs::interface::EndpointBase
	EndpointBase (EndpointConfigurationPtr configuration)
virtual	~EndpointBase ()=default
virtual bool	required_authentication () const
virtual std::string	get_url_path () const
virtual Uri	get_url () const
virtual void	activate_private ()
virtual EnabledType	get_enabled_level () const
void	set_parent (EndpointBasePtr parent)
void	change_parent (EndpointBasePtr parent_new)
EndpointConfigurationPtr	get_configuration () const
const EndpointBasePtr	get_parent_ptr () const
EndpointBasePtr	get_parent_ptr ()
void	add_child_endpoint (EndpointBasePtr child_ptr)
void	remove_child_endpoint (const UniversalId &child_id)
Children	get_children ()

Private Member Functions
void	update () override
void	activate_public () override
void	deactivate () override
EnabledType	get_this_node_enabled_level () const override
bool	does_this_node_require_authentication () const override
std::string	get_my_url_path_part () const override
std::string	get_my_url_part () const override

Private Attributes
bool	is_index_ {false}
DbObjectPtr	entry_
std::vector< HandlerPtr >	url_handlers_

Additional Inherited Members
Protected Member Functions inherited from mrs::endpoint::OptionEndpoint
void	update () override
Protected Member Functions inherited from mrs::interface::EndpointBase
void	log_update ()
virtual std::string	get_extra_update_data ()
EndpointBasePtr	get_child_by_id (const UniversalId &id) const
void	changed ()
Static Protected Member Functions inherited from mrs::interface::EndpointBase
static const char *	get_state_name (EnabledType et)
Protected Attributes inherited from mrs::endpoint::OptionEndpoint
UniversalId	service_id_
std::vector< HandlerPtr >	handlers_
HandlerFactoryPtr	factory_
std::optional< std::vector< std::string > >	directory_indexes_
Protected Attributes inherited from mrs::interface::EndpointBase
std::optional< EnabledType >	last_state_
std::shared_mutex	endpoints_access_
std::map< UniversalId, EndpointBasePtr >	endpoints_
std::weak_ptr< EndpointBase >	parent_
EndpointConfigurationPtr	configuration_

Member Typedef Documentation

DataType

using mrs::endpoint::DbObjectEndpoint::DataType = DbObject

DbObject

using mrs::endpoint::DbObjectEndpoint::DbObject = mrs::database::entry::DbObject

DbObjectPtr

using mrs::endpoint::DbObjectEndpoint::DbObjectPtr = std::shared_ptr<DbObject>

HandlerFactoryPtr

using mrs::endpoint::DbObjectEndpoint::HandlerFactoryPtr = std::shared_ptr<mrs::interface::HandlerFactory>

Parent

using mrs::endpoint::DbObjectEndpoint::Parent = OptionEndpoint

Constructor & Destructor Documentation

DbObjectEndpoint()

mrs::endpoint::DbObjectEndpoint::DbObjectEndpoint	(	const DbObject &	entry,
		EndpointConfigurationPtr	configuration,
		HandlerFactoryPtr	factory
	)

Member Function Documentation

activate_public()

void mrs::endpoint::DbObjectEndpoint::activate_public ( )

overrideprivatevirtual

Reimplemented from mrs::interface::EndpointBase.

deactivate()

void mrs::endpoint::DbObjectEndpoint::deactivate ( )

overrideprivatevirtual

Reimplemented from mrs::interface::EndpointBase.

does_this_node_require_authentication()

bool mrs::endpoint::DbObjectEndpoint::does_this_node_require_authentication ( ) const

overrideprivatevirtual

Implements mrs::interface::EndpointBase.

get()

const DbObjectPtr mrs::endpoint::DbObjectEndpoint::get

(

)

const

get_id()

UniversalId mrs::endpoint::DbObjectEndpoint::get_id ( ) const

overridevirtual

Implements mrs::interface::EndpointBase.

get_my_url_part()

std::string mrs::endpoint::DbObjectEndpoint::get_my_url_part ( ) const

overrideprivatevirtual

Implements mrs::interface::EndpointBase.

get_my_url_path_part()

std::string mrs::endpoint::DbObjectEndpoint::get_my_url_path_part ( ) const

overrideprivatevirtual

Implements mrs::interface::EndpointBase.

get_options()

std::optional< std::string > mrs::endpoint::DbObjectEndpoint::get_options ( ) const

overridevirtual

Implements mrs::interface::EndpointBase.

get_parent_id()

UniversalId mrs::endpoint::DbObjectEndpoint::get_parent_id ( ) const

overridevirtual

Implements mrs::interface::EndpointBase.

get_this_node_enabled_level()

EnabledType mrs::endpoint::DbObjectEndpoint::get_this_node_enabled_level ( ) const

overrideprivatevirtual

Implements mrs::interface::EndpointBase.

is_index()

bool mrs::endpoint::DbObjectEndpoint::is_index

(

)

const

set()

void mrs::endpoint::DbObjectEndpoint::set	(	const DbObject &	entry,
		EndpointBasePtr	parent
	)

update()

void mrs::endpoint::DbObjectEndpoint::update ( )

overrideprivatevirtual

Reimplemented from mrs::interface::EndpointBase.

Member Data Documentation

entry_

DbObjectPtr mrs::endpoint::DbObjectEndpoint::entry_

private

is_index_

bool mrs::endpoint::DbObjectEndpoint::is_index_ {false}

private

url_handlers_

std::vector<HandlerPtr> mrs::endpoint::DbObjectEndpoint::url_handlers_

private

---

The documentation for this class was generated from the following files:

• router/src/mysql_rest_service/src/mrs/endpoint/db_object_endpoint.h
• router/src/mysql_rest_service/src/mrs/endpoint/db_object_endpoint.cc