jadex.platform.service.df

Class DirectoryFacilitatorService

java.lang.Object

jadex.platform.service.df.DirectoryFacilitatorService

All Implemented Interfaces:

jadex.bridge.service.types.df.IDF

public class DirectoryFacilitatorService
extends java.lang.Object
implements jadex.bridge.service.types.df.IDF

Directory facilitator implementation for standalone platform.

Field Summary

Fields

Modifier and Type	Field and Description
protected jadex.bridge.service.types.clock.IClockService	clockservice The cached clock service.
protected jadex.bridge.service.types.cms.IComponentManagementService	cms The cached component management service.
protected jadex.commons.collection.IndexMap	components The registered components.
protected jadex.bridge.IInternalAccess	provider The platform.

Constructor Summary

Constructors

Constructor and Description
DirectoryFacilitatorService() Create a standalone df.

Method Summary

Modifier and Type	Method and Description
jadex.bridge.service.types.df.IDFComponentDescription	createDFComponentDescription(jadex.bridge.IComponentIdentifier component, jadex.bridge.service.types.df.IDFServiceDescription service) Create a df component description.
jadex.bridge.service.types.df.IDFComponentDescription	createDFComponentDescription(jadex.bridge.IComponentIdentifier component, jadex.bridge.service.types.df.IDFServiceDescription[] services, java.lang.String[] languages, java.lang.String[] ontologies, java.lang.String[] protocols, java.util.Date leasetime) Create a new df component description.
jadex.bridge.service.types.df.IDFComponentDescription	createDFComponentDescription(jadex.bridge.IComponentIdentifier component, jadex.bridge.service.types.df.IDFServiceDescription service, long leasetime) Create a df component description.
jadex.bridge.service.types.df.IDFServiceDescription	createDFServiceDescription(java.lang.String name, java.lang.String type, java.lang.String ownership) Create a df service description.
jadex.bridge.service.types.df.IDFServiceDescription	createDFServiceDescription(java.lang.String name, java.lang.String type, java.lang.String ownership, java.lang.String[] languages, java.lang.String[] ontologies, java.lang.String[] protocols, jadex.bridge.service.types.df.IProperty[] properties) Create a df service description.
jadex.bridge.ISearchConstraints	createSearchConstraints(int maxresults, int maxdepth) Create a search constraints object.
jadex.commons.future.IFuture<java.lang.Void>	deregister(jadex.bridge.service.types.df.IDFComponentDescription cdesc) Deregister a component description.
protected boolean	includes(java.lang.Object[] a, java.lang.Object[] b) Test if one array of objects is included in the other (without considering the order).
protected boolean	match(jadex.bridge.service.types.df.IDFComponentDescription desc, jadex.bridge.service.types.df.IDFComponentDescription template) Test if a component description matches a given template.
protected boolean	match(jadex.bridge.service.types.df.IDFServiceDescription desc, jadex.bridge.service.types.df.IDFServiceDescription template) Test if a service description matches a given template.
jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription>	modify(jadex.bridge.service.types.df.IDFComponentDescription cdesc) Modify a component description.
jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription>	register(jadex.bridge.service.types.df.IDFComponentDescription cdesc) Register a component description.
jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription[]>	search(jadex.bridge.service.types.df.IDFComponentDescription adesc, jadex.bridge.ISearchConstraints con) Search for components matching the given description.
jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription[]>	search(jadex.bridge.service.types.df.IDFComponentDescription adesc, jadex.bridge.ISearchConstraints con, boolean remote) Search for components matching the given description.
jadex.commons.future.IFuture<java.lang.Void>	startService() Start the service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

provider

protected jadex.bridge.IInternalAccess provider

The platform.

cms

protected jadex.bridge.service.types.cms.IComponentManagementService cms

The cached component management service.

clockservice

protected jadex.bridge.service.types.clock.IClockService clockservice

The cached clock service.

components

protected jadex.commons.collection.IndexMap components

The registered components.

Constructor Detail

DirectoryFacilitatorService

public DirectoryFacilitatorService()

Create a standalone df.

Method Detail

register

public jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription> register(jadex.bridge.service.types.df.IDFComponentDescription cdesc)

Register a component description.

Specified by:

register in interface jadex.bridge.service.types.df.IDF

Throws:

java.lang.RuntimeException - when the component description is already registered.

deregister

public jadex.commons.future.IFuture<java.lang.Void> deregister(jadex.bridge.service.types.df.IDFComponentDescription cdesc)

Deregister a component description.

Specified by:

deregister in interface jadex.bridge.service.types.df.IDF

Throws:

java.lang.RuntimeException - when the component is not registered.

modify

public jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription> modify(jadex.bridge.service.types.df.IDFComponentDescription cdesc)

Modify a component description.

Specified by:

modify in interface jadex.bridge.service.types.df.IDF

Throws:

java.lang.RuntimeException - when the component is not registered.

search

public jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription[]> search(jadex.bridge.service.types.df.IDFComponentDescription adesc,
                                                                                                    jadex.bridge.ISearchConstraints con)

Search for components matching the given description.

Specified by:

search in interface jadex.bridge.service.types.df.IDF

Returns:

An array of matching component descriptions.

search

public jadex.commons.future.IFuture<jadex.bridge.service.types.df.IDFComponentDescription[]> search(jadex.bridge.service.types.df.IDFComponentDescription adesc,
                                                                                                    jadex.bridge.ISearchConstraints con,
                                                                                                    boolean remote)

Search for components matching the given description.

Specified by:

search in interface jadex.bridge.service.types.df.IDF

Returns:

An array of matching component descriptions.

createDFServiceDescription

public jadex.bridge.service.types.df.IDFServiceDescription createDFServiceDescription(java.lang.String name,
                                                                                      java.lang.String type,
                                                                                      java.lang.String ownership)

Create a df service description.

Specified by:

createDFServiceDescription in interface jadex.bridge.service.types.df.IDF

Parameters:

name - The name.

type - The type.

ownership - The ownership.

Returns:

The service description.

createDFServiceDescription

public jadex.bridge.service.types.df.IDFServiceDescription createDFServiceDescription(java.lang.String name,
                                                                                      java.lang.String type,
                                                                                      java.lang.String ownership,
                                                                                      java.lang.String[] languages,
                                                                                      java.lang.String[] ontologies,
                                                                                      java.lang.String[] protocols,
                                                                                      jadex.bridge.service.types.df.IProperty[] properties)

Create a df service description.

Specified by:

createDFServiceDescription in interface jadex.bridge.service.types.df.IDF

Parameters:

name - The name.

type - The type.

ownership - The ownership.

languages - The languages.

ontologies - The ontologies.

protocols - The protocols.

properties - The properties.

Returns:

The service description.

createDFComponentDescription

public jadex.bridge.service.types.df.IDFComponentDescription createDFComponentDescription(jadex.bridge.IComponentIdentifier component,
                                                                                          jadex.bridge.service.types.df.IDFServiceDescription service)

Create a df component description.

Specified by:

createDFComponentDescription in interface jadex.bridge.service.types.df.IDF

Parameters:

component - The component.

service - The service.

Returns:

The df component description.

createDFComponentDescription

public jadex.bridge.service.types.df.IDFComponentDescription createDFComponentDescription(jadex.bridge.IComponentIdentifier component,
                                                                                          jadex.bridge.service.types.df.IDFServiceDescription service,
                                                                                          long leasetime)

Create a df component description.

Specified by:

createDFComponentDescription in interface jadex.bridge.service.types.df.IDF

Parameters:

component - The component.

service - The service.

Returns:

The df component description.

createDFComponentDescription

public jadex.bridge.service.types.df.IDFComponentDescription createDFComponentDescription(jadex.bridge.IComponentIdentifier component,
                                                                                          jadex.bridge.service.types.df.IDFServiceDescription[] services,
                                                                                          java.lang.String[] languages,
                                                                                          java.lang.String[] ontologies,
                                                                                          java.lang.String[] protocols,
                                                                                          java.util.Date leasetime)

Create a new df component description.

Specified by:

createDFComponentDescription in interface jadex.bridge.service.types.df.IDF

Parameters:

component - The component id.

services - The services.

languages - The languages.

ontologies - The ontologies.

protocols - The protocols.

Returns:

The component description.

createSearchConstraints

public jadex.bridge.ISearchConstraints createSearchConstraints(int maxresults,
                                                               int maxdepth)

Create a search constraints object.

Specified by:

createSearchConstraints in interface jadex.bridge.service.types.df.IDF

Parameters:

maxresults - The maximum number of results.

maxdepth - The maximal search depth.

Returns:

The search constraints.

startService

public jadex.commons.future.IFuture<java.lang.Void> startService()

Start the service.

match

protected boolean match(jadex.bridge.service.types.df.IDFComponentDescription desc,
                        jadex.bridge.service.types.df.IDFComponentDescription template)

Test if a component description matches a given template.

match

protected boolean match(jadex.bridge.service.types.df.IDFServiceDescription desc,
                        jadex.bridge.service.types.df.IDFServiceDescription template)

Test if a service description matches a given template.

includes

protected boolean includes(java.lang.Object[] a,
                           java.lang.Object[] b)

Test if one array of objects is included in the other (without considering the order). Test is performed using equals().