client-cpp  0.0.1-SNAPSHOT
kaa::EndpointRegistrationManager Class Reference

#include <EndpointRegistrationManager.hpp>

+ Inheritance diagram for kaa::EndpointRegistrationManager:
+ Collaboration diagram for kaa::EndpointRegistrationManager:

Public Member Functions

 EndpointRegistrationManager (IKaaClientStateStoragePtr status)
 
virtual void regenerateEndpointAccessToken ()
 
virtual const std::string & getEndpointAccessToken ()
 
virtual void attachEndpoint (const std::string &endpointAccessToken, IEndpointAttachStatusListener *listener=nullptr)
 
virtual void detachEndpoint (const std::string &endpointKeyHash, IEndpointAttachStatusListener *listener=nullptr)
 
virtual void detachEndpoint (IEndpointAttachStatusListener *listener=nullptr)
 
virtual void attachUser (const std::string &userExternalId, const std::string &userAccessToken, IEndpointAttachStatusListener *listener=nullptr)
 
virtual const AttachedEndpointsgetAttachedEndpoints ()
 
virtual void addAttachedEndpointListListener (IAttachedEndpointListListener *listener)
 
virtual void removeAttachedEndpointListListener (IAttachedEndpointListListener *listener)
 
virtual std::map< std::string,
std::string > 
getEndpointsToAttach ()
 
virtual std::map< std::string,
std::string > 
getEndpointsToDetach ()
 
virtual UserAttachRequestPtr getUserAttachRequest ()
 
virtual void onUserAttach (const UserSyncResponse::userAttachResponse_t &response)
 
virtual void onEndpointsAttach (const std::vector< EndpointAttachResponse > &endpoints)
 
virtual void onEndpointsDetach (const std::vector< EndpointDetachResponse > &endpoints)
 
virtual void onCurrentEndpointAttach (const UserAttachNotification &response)
 
virtual void onCurrentEndpointDetach (const UserDetachNotification &response)
 
virtual bool isCurrentEndpointAttached ()
 
virtual void setTransport (UserTransport *transport)
 
virtual void setAttachStatusListener (IEndpointAttachStatusListener *listener)
 
- Public Member Functions inherited from kaa::IEndpointRegistrationManager
virtual ~IEndpointRegistrationManager ()
 
- Public Member Functions inherited from kaa::IRegistrationProcessor
virtual ~IRegistrationProcessor ()
 

Detailed Description

Definition at line 42 of file EndpointRegistrationManager.hpp.

Constructor & Destructor Documentation

kaa::EndpointRegistrationManager::EndpointRegistrationManager ( IKaaClientStateStoragePtr  status)

Member Function Documentation

virtual void kaa::EndpointRegistrationManager::addAttachedEndpointListListener ( IAttachedEndpointListListener listener)
virtual

Adds listener of attached endpoint list changes

Parameters
listenerAttached endpoints list change listener

Implements kaa::IEndpointRegistrationManager.

virtual void kaa::EndpointRegistrationManager::attachEndpoint ( const std::string &  endpointAccessToken,
IEndpointAttachStatusListener listener = nullptr 
)
virtual

Adds new endpoint attach request

Parameters
endpointAccessTokenAccess token of the attaching endpoint
listenerOptional listener to notify about result of endpoint attaching. Set to null if is no need in it.

Implements kaa::IEndpointRegistrationManager.

virtual void kaa::EndpointRegistrationManager::attachUser ( const std::string &  userExternalId,
const std::string &  userAccessToken,
IEndpointAttachStatusListener listener = nullptr 
)
virtual

Creates user attach request

Parameters
userExternalId
userAccessToken
listenerOptional listener to notify about result of user attaching. Set to null if there is no need in it.

Implements kaa::IEndpointRegistrationManager.

virtual void kaa::EndpointRegistrationManager::detachEndpoint ( const std::string &  endpointKeyHash,
IEndpointAttachStatusListener listener = nullptr 
)
virtual

Adds new endpoint detach request

Parameters
endpointKeyHashKey hash of the attached endpoint
listenerOptional listener to notify about result of endpoint detaching. Set to null if is no need in it.

Implements kaa::IEndpointRegistrationManager.

virtual void kaa::EndpointRegistrationManager::detachEndpoint ( IEndpointAttachStatusListener listener = nullptr)
virtual

Adds current endpoint detach request

Parameters
listenerOptional listener to notify about result of endpoint detaching. Set to null if is no need in it.

Implements kaa::IEndpointRegistrationManager.

virtual const AttachedEndpoints& kaa::EndpointRegistrationManager::getAttachedEndpoints ( )
virtual

Retrieves list of attached endpoints

Returns
set of attached endpoint's "access token/key hash" pair

Implements kaa::IEndpointRegistrationManager.

virtual const std::string& kaa::EndpointRegistrationManager::getEndpointAccessToken ( )
inlinevirtual

Retrieve an access token for a current endpoint

Implements kaa::IEndpointRegistrationManager.

Definition at line 50 of file EndpointRegistrationManager.hpp.

virtual std::map<std::string, std::string> kaa::EndpointRegistrationManager::getEndpointsToAttach ( )
virtual
virtual std::map<std::string, std::string> kaa::EndpointRegistrationManager::getEndpointsToDetach ( )
virtual
virtual UserAttachRequestPtr kaa::EndpointRegistrationManager::getUserAttachRequest ( )
virtual
virtual bool kaa::EndpointRegistrationManager::isCurrentEndpointAttached ( )
inlinevirtual

Checks if current endpoint is already attached to some user

Implements kaa::IEndpointRegistrationManager.

Definition at line 84 of file EndpointRegistrationManager.hpp.

virtual void kaa::EndpointRegistrationManager::onCurrentEndpointAttach ( const UserAttachNotification &  response)
virtual
virtual void kaa::EndpointRegistrationManager::onCurrentEndpointDetach ( const UserDetachNotification &  response)
virtual
virtual void kaa::EndpointRegistrationManager::onEndpointsAttach ( const std::vector< EndpointAttachResponse > &  endpoints)
virtual
virtual void kaa::EndpointRegistrationManager::onEndpointsDetach ( const std::vector< EndpointDetachResponse > &  endpoints)
virtual
virtual void kaa::EndpointRegistrationManager::onUserAttach ( const UserSyncResponse::userAttachResponse_t &  response)
virtual
virtual void kaa::EndpointRegistrationManager::regenerateEndpointAccessToken ( )
virtual

Generate new access token for a current endpoint

Implements kaa::IEndpointRegistrationManager.

virtual void kaa::EndpointRegistrationManager::removeAttachedEndpointListListener ( IAttachedEndpointListListener listener)
virtual

Removes listener of attached endpoint list changes

Parameters
listenerAttached endpoints list change listener

Implements kaa::IEndpointRegistrationManager.

virtual void kaa::EndpointRegistrationManager::setAttachStatusListener ( IEndpointAttachStatusListener listener)
inlinevirtual

Set lister to notify about attaching/detaching the current endpoint either by itself or another endpoint

Parameters
listenerAttach status listener

Implements kaa::IEndpointRegistrationManager.

Definition at line 95 of file EndpointRegistrationManager.hpp.

virtual void kaa::EndpointRegistrationManager::setTransport ( UserTransport transport)
inlinevirtual

Definition at line 88 of file EndpointRegistrationManager.hpp.


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