jadex.bridge.service.types.platform

Interface IJadexMultiPlatformBinder

All Known Subinterfaces:

IJadexPlatformBinder

public interface IJadexMultiPlatformBinder

Interface for the platform binder object.

Method Summary

Modifier and Type	Method and Description
<any>	getCMS(IComponentIdentifier platformID) Deprecated. use getService() or getsService() instead.
IExternalAccess	getExternalPlatformAccess(IComponentIdentifier platformID) Returns the Jadex External Platform Access object for a given platform Id
<any>	getMS(IComponentIdentifier platformID) Deprecated. use getService() or getsService() instead.
IResourceIdentifier	getResourceIdentifier() Returns the ResourceIdentifier of the /ClientApp/ classes.
<S> <any>	getService(IComponentIdentifier platformId, java.lang.Class<S> serviceClazz) Looks up a service.
<S> <any>	getService(IComponentIdentifier platformId, java.lang.Class<S> serviceClazz, java.lang.String scope) Looks up a service.
<S> S	getsService(IComponentIdentifier platformId, java.lang.Class<S> serviceClazz) Looks up a service and returns it synchronously.
boolean	isPlatformRunning(IComponentIdentifier platformID) Checks whether a jadex platform is running.
void	shutdownJadexPlatform(IComponentIdentifier platformID) Terminates the running jadex platform with the given ID.
void	shutdownJadexPlatforms() Terminates all running jadex platforms.
<any>	startComponent(IComponentIdentifier platformId, java.lang.String name, java.lang.Class<?> clazz) Start a new Component on a given platform with default CreationInfo.
<any>	startComponent(IComponentIdentifier platformId, java.lang.String name, java.lang.Class<?> clazz, CreationInfo creationInfo) Start a new Component on a given platform.
<any>	startComponent(IComponentIdentifier platformId, java.lang.String name, java.lang.String modelPath) Start a new Component on a given platform with default CreationInfo.
<any>	startComponent(IComponentIdentifier platformId, java.lang.String name, java.lang.String modelPath, CreationInfo creationInfo) Start a new Component on a given platform.
<any>	startComponent(IComponentIdentifier platformId, java.lang.String name, java.lang.String modelPath, CreationInfo creationInfo, <any> terminationListener) Start a new Component on a given platform.
<any>	startJadexPlatform() Starts a Jadex Platform with default configuration
<any>	startJadexPlatform(PlatformConfiguration config) Starts a Jadex Platform.
<any>	startJadexPlatform(RootComponentConfiguration.KERNEL[] kernels) Starts a Jadex Platform.
<any>	startJadexPlatform(RootComponentConfiguration.KERNEL[] kernels, java.lang.String platformId) Starts a Jadex Platform.

Method Detail

getExternalPlatformAccess

IExternalAccess getExternalPlatformAccess(IComponentIdentifier platformID)

Returns the Jadex External Platform Access object for a given platform Id

Parameters:

platformID -

Returns:

IExternalAccess

isPlatformRunning

boolean isPlatformRunning(IComponentIdentifier platformID)

Checks whether a jadex platform is running.

Parameters:

platformID - the IComponenntIdentifier of the platform to check.

Returns:

true, when runnning, else false.

getCMS

<any> getCMS(IComponentIdentifier platformID)

Deprecated. use getService() or getsService() instead.

Retrieves the CMS of the Platform with the given ID.

getMS

<any> getMS(IComponentIdentifier platformID)

Deprecated. use getService() or getsService() instead.

Retrieves the MS of the Platform with the given ID.

getsService

<S> S getsService(IComponentIdentifier platformId,
                  java.lang.Class<S> serviceClazz)

Looks up a service and returns it synchronously.

Parameters:

platformId - Id of the platform to use for lookup

serviceClazz - Class of the service (interface) to find

Returns:

the service

getService

<S> <any> getService(IComponentIdentifier platformId,
                     java.lang.Class<S> serviceClazz)

Looks up a service.

Parameters:

platformId - Id of the platform to use for lookup

serviceClazz - Class of the service (interface) to find

Returns:

Future of the service.

See Also:

getsService

getService

<S> <any> getService(IComponentIdentifier platformId,
                     java.lang.Class<S> serviceClazz,
                     java.lang.String scope)

Looks up a service.

Parameters:

platformId - Id of the platform to use for lookup

serviceClazz - Class of the service (interface) to find

scope - Search scope. See RequiredServiceInfo constants.

Returns:

Future of the service.

See Also:

getsService

startJadexPlatform

<any> startJadexPlatform(RootComponentConfiguration.KERNEL[] kernels)

Starts a Jadex Platform.

Parameters:

kernels - String array of kernel Identifiers (see constants in JadexPlatformManager).

Returns:

IFuture The external platform access

startJadexPlatform

<any> startJadexPlatform(RootComponentConfiguration.KERNEL[] kernels,
                         java.lang.String platformId)

Starts a Jadex Platform.

Parameters:

kernels - String array of kernel Identifiers (see constants in JadexPlatformManager).

platformId - Identifier of the new platform

Returns:

IFuture The external platform access

startJadexPlatform

<any> startJadexPlatform()

Starts a Jadex Platform with default configuration

Returns:

IFuture The external platform access

startJadexPlatform

<any> startJadexPlatform(PlatformConfiguration config)

Starts a Jadex Platform.

Parameters:

config - additional options that are passed directly to the platform starter.

Returns:

IFuture The external platform access

shutdownJadexPlatforms

void shutdownJadexPlatforms()

Terminates all running jadex platforms.

shutdownJadexPlatform

void shutdownJadexPlatform(IComponentIdentifier platformID)

Terminates the running jadex platform with the given ID.

Parameters:

platformID - Platform to terminate.

startComponent

<any> startComponent(IComponentIdentifier platformId,
                     java.lang.String name,
                     java.lang.String modelPath,
                     CreationInfo creationInfo,
                     <any> terminationListener)

Start a new Component on a given platform.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created component

modelPath - Path to the model file of the new component

creationInfo - CreationInfo to pass to the started Component.

terminationListener - The listener to call when the component was terminated.

Returns:

ComponentIdentifier of the created agent.

startComponent

<any> startComponent(IComponentIdentifier platformId,
                     java.lang.String name,
                     java.lang.String modelPath,
                     CreationInfo creationInfo)

Start a new Component on a given platform.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created component

modelPath - Path to the model file of the new component

creationInfo - CreationInfo to pass to the started Component.

Returns:

ComponentIdentifier of the created agent.

startComponent

<any> startComponent(IComponentIdentifier platformId,
                     java.lang.String name,
                     java.lang.String modelPath)

Start a new Component on a given platform with default CreationInfo.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created component

modelPath - Path to the model file of the new component

Returns:

ComponendIdentifier of the created agent.

startComponent

<any> startComponent(IComponentIdentifier platformId,
                     java.lang.String name,
                     java.lang.Class<?> clazz,
                     CreationInfo creationInfo)

Start a new Component on a given platform.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created component

clazz - Class of the new component

creationInfo - CreationInfo to pass to the started Component.

Returns:

ComponentIdentifier of the created agent.

startComponent

<any> startComponent(IComponentIdentifier platformId,
                     java.lang.String name,
                     java.lang.Class<?> clazz)

Start a new Component on a given platform with default CreationInfo.

Parameters:

platformId - Identifier of the jadex platform

name - name of the newly created agent

clazz - Path to the bpmn model file of the new agent

Returns:

ComponentIdentifier of the created agent.

getResourceIdentifier

IResourceIdentifier getResourceIdentifier()

Returns the ResourceIdentifier of the /ClientApp/ classes. As one JadexService exists per ClientApp, this will never change. Use this RID to launch new components that are defined within the ClientApp.

Returns: