jadex.bridge.service.types.df

Interface IDF

public interface IDF

Interface for the directory facilitator (DF). Provides services for registering, modifying, deregistering and searching of component resp. service descriptions.

Method Summary

Methods

Modifier and Type	Method and Description
IDFComponentDescription	createDFComponentDescription(IComponentIdentifier component, IDFServiceDescription service) Create a df component description.
IDFComponentDescription	createDFComponentDescription(IComponentIdentifier component, IDFServiceDescription[] services, String[] languages, String[] ontologies, String[] protocols, Date leasetime) Create a new df component description.
IDFServiceDescription	createDFServiceDescription(String name, String type, String ownership) Create a df service description.
IDFServiceDescription	createDFServiceDescription(String name, String type, String ownership, String[] languages, String[] ontologies, String[] protocols, IProperty[] properties) Create a df service description.
ISearchConstraints	createSearchConstraints(int maxresults, int maxdepth) Create a search constraints object.
IFuture<Void>	deregister(IDFComponentDescription adesc) Deregister an component description.
IFuture<IDFComponentDescription>	modify(IDFComponentDescription adesc) Modify an component description.
IFuture<IDFComponentDescription>	register(IDFComponentDescription adesc) Register an component description.
IFuture<IDFComponentDescription[]>	search(IDFComponentDescription adesc, ISearchConstraints con) Search for components matching the given description.
IFuture<IDFComponentDescription[]>	search(IDFComponentDescription adesc, ISearchConstraints con, boolean remote) Search for components matching the given description.

Method Detail

register

IFuture<IDFComponentDescription> register(IDFComponentDescription adesc)

Register an component description.

Throws:

RuntimeException - when the component is already registered.

deregister

IFuture<Void> deregister(IDFComponentDescription adesc)

Deregister an component description.

Throws:

RuntimeException - when the component is not registered.

modify

IFuture<IDFComponentDescription> modify(IDFComponentDescription adesc)

Modify an component description.

Throws:

RuntimeException - when the component is not registered.

search

IFuture<IDFComponentDescription[]> search(IDFComponentDescription adesc,
                                        ISearchConstraints con)

Search for components matching the given description.

Returns:

An array of matching component descriptions.

search

IFuture<IDFComponentDescription[]> search(IDFComponentDescription adesc,
                                        ISearchConstraints con,
                                        boolean remote)

Search for components matching the given description.

Returns:

An array of matching component descriptions.

createDFServiceDescription

IDFServiceDescription createDFServiceDescription(String name,
                                               String type,
                                               String ownership)

Create a df service description.

Parameters:

name - The name.

type - The type.

ownership - The ownership.

Returns:

The service description.

createDFServiceDescription

IDFServiceDescription createDFServiceDescription(String name,
                                               String type,
                                               String ownership,
                                               String[] languages,
                                               String[] ontologies,
                                               String[] protocols,
                                               IProperty[] properties)

Create a df service description.

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

IDFComponentDescription createDFComponentDescription(IComponentIdentifier component,
                                                   IDFServiceDescription service)

Create a df component description.

Parameters:

component - The component.

service - The service.

Returns:

The df component description.

createDFComponentDescription

IDFComponentDescription createDFComponentDescription(IComponentIdentifier component,
                                                   IDFServiceDescription[] services,
                                                   String[] languages,
                                                   String[] ontologies,
                                                   String[] protocols,
                                                   Date leasetime)

Create a new df component description.

Parameters:

component - The component id.

services - The services.

languages - The languages.

ontologies - The ontologies.

protocols - The protocols.

Returns:

The component description.

createSearchConstraints

ISearchConstraints createSearchConstraints(int maxresults,
                                         int maxdepth)

Create a search constraints object.

Parameters:

maxresults - The maximum number of results.

maxdepth - The maximal search depth.

Returns:

The search constraints.