Adapter class between Java implemented services and AbstractService instance. More...

#include <externalserviceadapter.hpp>

Inheritance diagram for kanzi::connect::ExternalServiceAdapter:

Public Member Functions
	ExternalServiceAdapter (const string &identfier)
	Constructor.

virtual void	receive (shared_ptr< ExternalServiceSession > session, const MessagePackage &message)
	Invoked to receive incoming message.

virtual void	transmitToAll (const MessagePackage &message)
	Transmits a provided message to wire and delivers it to all sessions available.

virtual bool	transmitToSession (shared_ptr< ExternalServiceSession > session, const MessagePackage &message)
	Transmits a provided message to specific session.

virtual	~ExternalServiceAdapter () override
	Destructor.


virtual GenericInvoker *	getGenericInvoker () override

virtual AbstractSessionSharedPtr	onAcquireSession (int clientId, int sessionId, MessageDispatcher *dispatcher, const string &instanceName) override
	Session factorization method interface.

virtual ContentProviderCollectionSharedPtr	getContentProvider () override
	Returns content provider for this service.

virtual string	getIdentifier () const override

virtual void	onReleaseSession (AbstractSessionSharedPtr session) override
	Virtual method that inheriting classes can implement.


bool	addSubscriptionExt (const string &identifier, shared_ptr< ExternalServiceSession > session)

vector< string >	removeSubscriptionsExt (shared_ptr< ExternalServiceSession > session, const string &identifier="")

bool	hasSubscriptionsExt (const string &identifier)

vector< shared_ptr< ExternalServiceSession > >	findSubscribersExt (const string &identifier)

Public Member Functions inherited from kanzi::connect::AbstractService
	AbstractService ()
	Constructor.

AbstractSessionSharedPtr	acquireSession (int clientId, int sessionId, MessageDispatcher *dispatcher, const string &instanceName)
	Session factorization method.

virtual InvokableOperationResult	addCustomType (const string &xml)
	Add a custom type to the service.

virtual InvokableOperationResult	addCustomTypeDecoded (const string &decodedXml)
	Add a custom type to the service.

virtual int	addEvent (const string &identifier, const string &description)

virtual int	addMethod (const string &identifier, const string &description)

virtual int	addProperty (const string &identifier, const string &description)

virtual InvokableOperationResult	addRoute (const string &xml)
	Add new P2P route(s) for the service.

virtual InvokableOperationResult	addRouteDecoded (const string &decodedXml)
	Add new P2P route(s) for the service.

RuntimeDataSchemaChangeSubscriptionToken	addRuntimeDataSchemaChangeSubscription (RuntimeDataSchemaChangeCallback function)
	Adds a callback to invoke when runtime data schema changes.

StateChangedSubscriptionToken	addStateChangeSubscription (StateCallbackFunction function)
	Adds a state change callback subscription.

bool	addSubscription (const string &identifier, AbstractSessionSharedPtr session)
	Add subscription to the given session for this service.

virtual void	cancelTimer (int64_t timerId)
	Cancels ongoing timer.

size_t	countSessions ()
	Return the amount of sessions towards this service amount of sessions.

int	countSessions () const
	Amount of allocated sessions.

virtual InvokableOperationResult	createRuntimedata (const string &parentIdentifier, const string &xml)
	Create a new runtime data element for the service runtime data.

EnumMap::const_iterator	enumerationValuesBegin ()

EnumMap::const_iterator	enumerationValuesEnd ()

vector< AbstractSessionSharedPtr >	findSubscribers (const string &identifier)
	Find all subscribers for the given identifier.

const SessionContainer &	getAllSessions () const
	Returns all currently active sessions.

SessionContainer	getAllSessionsOfClient (int clientId)
	Returns all sessions for a given client.

string	getAttribute (const string &key)
	Gets value of a service attribute.

KanziStringVectorSharedPtr	getAttributes ()
	Lists all service attributes.

RuntimeDataObjectSharedPtr	getConfigurationProperties ()
	Retrieves configuration properties as a runtime data object to allow more convenient access to data.

ContentClientSharedPtr	getContentClient () const
	Access to content system.

const vector< unique_ptr< CustomType > > &	getCustomTypes () const
	Get the custom types defined for this service.

KanziStringVectorSharedPtr	getDisabledInvokables ()

ConnectDomainSharedPtr	getDomain () const
	Retrieves the connect domain.

optional< int >	getEnumValue (const string &name, const string &enumerator)
	Find out value for enumeration string.

ServiceExtensionContainer *	getExtensions ()

string	getExtensionsSchemas ()

string	getFullyQualifiedConfigurationPropertyName (const string &name)
	Constructs a fully qualified configuration property name, usually the fully qualified name is something like "Connect.Service.MyService.ConfigurationProperties.MyPropertyName".

InterfaceDomainBase *	getInterfaceDomain () const
	Access to interface domain.

virtual RuntimeDataObjectSharedPtr	getModifiedConfigurationProperties ()
	Retrieves modified configuration properties as runtime data object.

virtual string	getName ()
	Returns the override name.

WorkQueueInterface *	getProxyWorkQueue ()
	Returns a proxied work queue instance that can be used by composited classes to to assign work to this service.

AbstractSessionSharedPtr	getRunningSession ()

virtual string	getSchema ()
	Returns service schema in XML format.

virtual const ServiceDescription &	getServiceDescription () const
	Access the static service description info.

virtual p2p::RoutingRulesSharedPtr	getServiceRoutingInformation ()
	Return service routing information.

virtual const ServiceState &	getServiceState () const
	Gets service state information.

AbstractSessionSharedPtr	getSession (int clientId, int sessionId)
	Returns session by client & session id.

int	getStopInterval () const
	Retrieve service stop interval.

WorkQueueInterface *	getWorkQueue () const
	Access to signal that allows to invoke work().

bool	hasEnumValues (const string &name)
	Checks if enum has been defined on this service.

bool	hasSubscriptions (const string &identifier)
	Check if the given identifier has any subscriptions.

virtual void	initialize (InterfaceDomainBase domain, ContentClientSharedPtr contentClient, WorkQueueInterface workQueue)
	Initialize this service.

bool	manualPersistenceOverride () const
	Defines whether manual persistence override is active, i.e.

bool	processMessage (const MessagePackage &message, AbstractSessionSharedPtr session, shared_ptr< GenericRPCReplyMessage > &ret)
	Offer received message directly to service to implement a short path for scripts and built-in methods. Intended for internal use.

void	releaseAllSessions ()
	Unconditionally releases all sessions. use carefully.

void	releaseSession (AbstractSessionSharedPtr session)
	Releases previously allocated session.

virtual InvokableOperationResult	removeCustomType (const string &typeName)
	Remove a custom type from a service.

virtual int	removeEvent (const string &identifier)

virtual int	removeMethod (const string &identifier)

virtual int	removeProperty (const string &identifier)

virtual InvokableOperationResult	removeRoute (const string &subjectName)
	Remove a route from a service.

virtual InvokableOperationResult	removeRuntimedataElement (const string &elementIdentifier)
	Remove runtime data element from the service runtime data.

void	removeRuntimeDataSchemaChangeSubscription (RuntimeDataSchemaChangeSubscriptionToken token)
	Remove schema change subscription.

void	removeStateChangeSubscription (StateChangedSubscriptionToken token)
	Remove state change subscription.

vector< string >	removeSubscriptions (AbstractSessionSharedPtr session, const string &identifier="")
	Remove subscription to the given session for this service.

AbstractService::ServiceControlResult	resetService (ServiceArgumentsSharedPtr arguments)
	Tries to reset service.

ServiceRuntimeData &	runtimeData ()
	Retrieve service runtime data.

void	setAttribute (const string &key, const string &value)
	Add service attributes as key value pairs.

void	setDomain (ConnectDomainSharedPtr domain)
	Set the connect domain.

void	setFileClient (VirtualFileClient *client)
	Set the client instance to access VirtualFileService.

virtual void	setName (const string &name)
	Defines a override name used to identify the service.

void	setPersistence (AbstractService::ServiceDescription::Persistence persistence)
	Sets the service persistence.

virtual void	setRunningSession (AbstractSessionSharedPtr session)
	Stores the currently running session.

virtual InvokableOperationResult	setRuntimedataValue (const string &elementIdentifier, const string &value)
	Set runtime data value for the given element in the service runtime data.

bool	setServiceRuntimeDataSchema (const string &xml)
	Set service runtime data schema.

void	setServiceState (AbstractService::ServiceState state)
	sets service state information.

void	setServiceVersion (AbstractService::ServiceDescription::Version version, AbstractService::ServiceDescription::Version minCompatibleVersion=AbstractService::ServiceDescription::Version())
	Configures the service version information.

void	setSettingFactory (const persistence::SettingFactory *factory)
	Set the setting factory instance to allow using persistence service.

void	setStopInterval (int seconds)
	Configures the stop interval.

virtual int64_t	setTimer (int64_t milliseconds, ConnectWorkItem::Executor callback)
	Installs a timer to be called after a specified timeout in milliseconds.

virtual int64_t	setTimer (int64_t milliseconds, ConnectWorkItem::Executor callback, ConnectWorkItem::ExecutionContext executionContext)
	Installs a timer to be called after a specified timeout in milliseconds.

bool	simulateEvent (const string &messageName, const MessagePackage &message)
	Post a message to all running sessions as event. Intended for internal use.

AbstractService::ServiceControlResult	startService (ServiceControlSource serviceControlSource, ServiceArgumentsSharedPtr arguments)
	Tries to start the service.

AbstractService::ServiceControlResult	stopService (ServiceControlSource serviceControlSource)
	Tries to stop the service.

virtual void	uninitialize ()
	Uninitialize this service.

virtual void	work (ConnectWorkItemSharedPtr workItem)
	Asks service to perform work.

virtual	~AbstractService ()
	Destructor.

Protected Member Functions
virtual void	onSubscriptionsEnded (const vector< string > &identifiers)
	Notifies that these streams no longer have any subscribers left (but they used to have) This is notified when a session is released without it first explicitly unsubscribing.

Protected Member Functions inherited from kanzi::connect::AbstractService
void	addEnumValue (const string &name, const string &enumerator, int value)
	Store value for enumeration string.

VirtualFileClient *	getFileClient () const
	Get instance to access the VirtualFileService.

ScriptContextSharedPtr	getScriptContext ()
	Get shared script context.

const persistence::SettingFactory *	getSettingFactory () const
	Get the setting factory instance.

void	notifyRuntimeSchemaChange ()
	Notify all observers that service schema has changed.

virtual void	notifyWork ()
	Allows the derived class to invoke work().

virtual void	notifyWork (ConnectWorkItemSharedPtr workItem)
	Called notify that this service would have a work item to be processed later on.

virtual void	notifyWork (ConnectWorkItemSharedPtr workItem, const ConnectWorkItem::Executor executor)
	Called to notify this service has work to do and for that work use the attached executor.

void	notifyWork (const ConnectWorkItem::Executor executor)
	Call to notify that provided executor should be run the kanzi connect main thread context.

virtual AbstractService::ServiceControlResult	onResetServiceRequest (ServiceArgumentsSharedPtr arguments)
	Inherited classes should implements this method that is invoked when service is requested to reset itself.

virtual AbstractService::ServiceControlResult	onStartServiceRequest (ServiceArgumentsSharedPtr arguments)
	Inherited classes should implement this method that is invoked when service is to be started.

virtual AbstractService::ServiceControlResult	onStopServiceRequest ()
	Inherited classes should implement this method that is invoked when service is to be stopped.

bool	prepareScriptContext ()
	Prepare script plugin for use.

virtual string	provideServiceRoutingInformationOverride ()
	Service should override this in order to provide a custom routing information structure.

virtual string	provideServiceRuntimeDataOverride ()
	Service should override this in order to provide a runtime data structure.

void	registerEnumValue (AbstractServiceSharedPtr service, const string &name, const string &enumerator, int value)
	Store value for enumeration string for a service.

void	setConfigurationPropertyPrefix (const string &prefix)
	Configures the configuration property name prefix used to build fully qualified configuration property names.

bool	writeConfigurationPropertyInternal (const string &stream)
	Writes a configuration property value.

Additional Inherited Members
Public Types inherited from kanzi::connect::AbstractService
typedef map< string, EnumValues >	EnumMap

typedef map< string, int >	EnumValues

enum	InvokableOperationResult { Success = 0 , AlreadyExists = -1 , ValidationFailed = -2 , NotFound = -3 , NotReady = -4 }

typedef function< void(AbstractService *)	RuntimeDataSchemaChangeCallback)
	Callback prototype to be invoked when runtime data schema changes.

typedef shared_ptr< void >	RuntimeDataSchemaChangeSubscriptionToken
	Handle given as return value to runtime data schema change callback registration.

enum	ServiceControlResult { ServiceControlSuccess , ServiceControlFailed , ServiceControlNotSupported }

typedef enum kanzi::connect::AbstractService::ServiceControlResult	ServiceControlResult

enum	ServiceControlSource { ServiceControlSourceManual , ServiceControlSourceLogic }

typedef enum kanzi::connect::AbstractService::ServiceControlSource	ServiceControlSource

typedef vector< AbstractSessionSharedPtr >	SessionContainer
	Container type for all connected sessions.

typedef function< void(AbstractService *)	StateCallbackFunction)
	Function prototype to be invoked when state changes.

typedef shared_ptr< void >	StateChangedSubscriptionToken
	Handle given as return value to state callback registration.

Detailed Description

Adapter class between Java implemented services and AbstractService instance.

Constructor & Destructor Documentation

◆ ExternalServiceAdapter()

kanzi::connect::ExternalServiceAdapter::ExternalServiceAdapter ( const string & identfier )

Constructor.

Parameters

identfier the name of the service this adapter represents.

◆ ~ExternalServiceAdapter()

virtual kanzi::connect::ExternalServiceAdapter::~ExternalServiceAdapter ( )

inlineoverridevirtual

Destructor.

Member Function Documentation

◆ addSubscriptionExt()

bool kanzi::connect::ExternalServiceAdapter::addSubscriptionExt	(	const string &	identifier,
		shared_ptr< ExternalServiceSession >	session )

See also: kanzi::connect::connect::AbstractService

◆ findSubscribersExt()

vector< shared_ptr< ExternalServiceSession > > kanzi::connect::ExternalServiceAdapter::findSubscribersExt ( const string & identifier )

◆ getContentProvider()

virtual ContentProviderCollectionSharedPtr kanzi::connect::ExternalServiceAdapter::getContentProvider ( )

inlineoverridevirtual

Returns content provider for this service.

Returns: Collection of content providers, created by this service.

Reimplemented from kanzi::connect::AbstractService.

◆ getGenericInvoker()

virtual GenericInvoker * kanzi::connect::ExternalServiceAdapter::getGenericInvoker ( )

overridevirtual

See also: kanzi::connect::connect::AbstractService

Reimplemented from kanzi::connect::AbstractService.

◆ getIdentifier()

virtual string kanzi::connect::ExternalServiceAdapter::getIdentifier ( ) const

overridevirtual

Implements kanzi::connect::AbstractService.

◆ hasSubscriptionsExt()

bool kanzi::connect::ExternalServiceAdapter::hasSubscriptionsExt ( const string & identifier )

◆ onAcquireSession()

virtual AbstractSessionSharedPtr kanzi::connect::ExternalServiceAdapter::onAcquireSession	(	int	clientId,
		int	sessionId,
		MessageDispatcher *	dispatcher,
		const string &	instanceName )

overridevirtual

Session factorization method interface.

To be overrided by concrete services

Parameters

clientId	client identifier number
sessionId	session identifier number
dispatcher	message dispatching functionality for the session.
instanceName	name for the service/session instance

Returns: newly allocated session. ownership is transfered.

Implements kanzi::connect::AbstractService.

◆ onReleaseSession()

virtual void kanzi::connect::ExternalServiceAdapter::onReleaseSession ( AbstractSessionSharedPtr session )

overridevirtual

Virtual method that inheriting classes can implement.

Can be used to receive notifications when sessions are destroyed.

Parameters

session identifies the session to be released. ownership not transfered.

Reimplemented from kanzi::connect::AbstractService.

◆ onSubscriptionsEnded()

virtual void kanzi::connect::ExternalServiceAdapter::onSubscriptionsEnded ( const vector< string > & identifiers )

protectedvirtual

Notifies that these streams no longer have any subscribers left (but they used to have) This is notified when a session is released without it first explicitly unsubscribing.

Parameters

identifiers Contains the stream identifiers that have lost their subscribers

◆ receive()

virtual void kanzi::connect::ExternalServiceAdapter::receive	(	shared_ptr< ExternalServiceSession >	session,
		const MessagePackage &	message )

virtual

Invoked to receive incoming message.

This is handled in external code (Java etc)

Parameters

message the message to be processed.

◆ removeSubscriptionsExt()

vector< string > kanzi::connect::ExternalServiceAdapter::removeSubscriptionsExt	(	shared_ptr< ExternalServiceSession >	session,
		const string &	identifier = "" )

◆ transmitToAll()

virtual void kanzi::connect::ExternalServiceAdapter::transmitToAll ( const MessagePackage & message )

virtual

Transmits a provided message to wire and delivers it to all sessions available.

Parameters

message the message to be sent.

◆ transmitToSession()

virtual bool kanzi::connect::ExternalServiceAdapter::transmitToSession	(	shared_ptr< ExternalServiceSession >	session,
		const MessagePackage &	message )

virtual

Transmits a provided message to specific session.

Parameters

session	the session where to send to message. Session presence is verified before making the call.
message	the message to be sent.

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

connect/interface/externalserviceadapter.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExternalServiceAdapter()

◆ ~ExternalServiceAdapter()

Member Function Documentation

◆ addSubscriptionExt()

◆ findSubscribersExt()

◆ getContentProvider()

◆ getGenericInvoker()

◆ getIdentifier()

◆ hasSubscriptionsExt()

◆ onAcquireSession()

◆ onReleaseSession()

◆ onSubscriptionsEnded()

◆ receive()

◆ removeSubscriptionsExt()

◆ transmitToAll()

◆ transmitToSession()