|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServiceBus
The service bus is a call-based bus, i.e., the ServiceCaller
members who post a message to this bus normally have a service request and
would like to receive a response in return, especially if the service result
also includes the provision of specific info. Even if no specific info is
expected from the ServiceCallee
member, at least a hint about
the status of the provision of the service is required, e.g. an
acknowledgment stating that the request could be forwarded to an appropriate
ServiceCallee
, or an error message stating that no appropriate
service realization could be found. This interface is available as an OSGi
service at the OSGi framework. it is implicitly used by the
ServiceCaller
-s and ServiceCallee
-s that are
created within the same OSGi bundle context.
Field Summary | |
---|---|
static String |
LOG_MATCHING_END
|
static String |
LOG_MATCHING_MISMATCH
|
static String |
LOG_MATCHING_MISMATCH_CODE
|
static String |
LOG_MATCHING_MISMATCH_DETAILS
|
static String |
LOG_MATCHING_NOSUCCESS
|
static String |
LOG_MATCHING_PROFILE
|
static String |
LOG_MATCHING_PROFILES_END
|
static String |
LOG_MATCHING_PROVIDER_END
|
static String |
LOG_MATCHING_START
|
static String |
LOG_MATCHING_SUCCESS
|
static String |
uAAL_SERVICE_BUS_MODULE_CONTEXT
|
Method Summary | |
---|---|
void |
addAvailabilitySubscription(String callerID,
AvailabilitySubscriber subscriber,
ServiceRequest request)
Adds an availability subscription, in other words a listener, to receive events about the availability of services matching the given request. |
void |
addNewServiceProfiles(String calleeID,
ServiceProfile[] realizedServices)
Registers (advertises) new services (by providing descriptions of them) that will be provided by the ServiceCalee with the specified ID. |
void |
brokerReply(String calleeID,
BusMessage response)
Can be used by ServiceCallees to send a response to the bus which will be delivered to the caller who initiated the initial request. |
void |
brokerRequest(String callerID,
BusMessage request)
Can be used by ServiceCallers to send a request to the bus. |
ServiceProfile[] |
getAllServices(String callerID)
A method used to retrieve the descriptions of all services advertised on the service bus. |
HashMap |
getMatchingServices(String serviceClassURI)
Get all service profiles that describe services of the given service class. |
ServiceProfile[] |
getMatchingServices(String callerID,
Service template)
Get all service profiles that describe services that match the given template in terms of "query by example". |
ServiceProfile[] |
getMatchingServices(String callerID,
String serviceClassURI)
Get all service profiles that describe services of the given service class. |
ServiceProfile[] |
getMatchingServices(String callerID,
String[] keywords)
This version of the method accepts simple keyword-based queries about registered services. |
void |
removeAvailabilitySubscription(String callerID,
AvailabilitySubscriber subscriber,
String requestURI)
Removes an availability subscription from the bus, which was previously added using addAvailabilitySubscription method. |
void |
removeMatchingProfiles(String calleeID,
ServiceProfile[] realizedServices)
Removes specified service profiles that were previously registered by the ServiceCalee with the specified ID. |
void |
unregister(String calleeID,
ServiceCallee callee)
Unregisters a service callee from the bus. |
void |
unregister(String callerID,
ServiceCaller caller)
Unregisters a service caller from the bus. |
Field Detail |
---|
static final String LOG_MATCHING_START
static final String LOG_MATCHING_PROFILE
static final String LOG_MATCHING_SUCCESS
static final String LOG_MATCHING_NOSUCCESS
static final String LOG_MATCHING_PROFILES_END
static final String LOG_MATCHING_PROVIDER_END
static final String LOG_MATCHING_END
static final String LOG_MATCHING_MISMATCH
static final String LOG_MATCHING_MISMATCH_CODE
static final String LOG_MATCHING_MISMATCH_DETAILS
static final String uAAL_SERVICE_BUS_MODULE_CONTEXT
Method Detail |
---|
void addAvailabilitySubscription(String callerID, AvailabilitySubscriber subscriber, ServiceRequest request)
callerID
- the ID of the caller that is registering a subscriber.subscriber
- the object which will be notified when matching services are
advertised or removed from the service bus.request
- the request to which newly registered or unregistered services
must match in order to notify the subscriber about the
corresponding events.void addNewServiceProfiles(String calleeID, ServiceProfile[] realizedServices)
calleeID
- the ID of the ServiceCalee that is advertising new services on
the service bus.realizedServices
- the description of the new services in terms of an array of
service profiles.ServiceProfile[] getAllServices(String callerID)
callerID
- the ID of the caller that is asking the service bus.
ServiceProfile[] getMatchingServices(String callerID, Service template)
callerID
- the ID of the caller that is asking the service bus.template
- the template to be used for making a "query by example"..
ServiceProfile[] getMatchingServices(String callerID, String serviceClassURI)
callerID
- the ID of the caller that is asking the service bus.serviceClassURI
- the URI of the desired service class.
ServiceProfile[] getMatchingServices(String callerID, String[] keywords)
callerID
- the ID of the caller that is asking the service bus.keywords
- the set of keywords to be used for textual match.
void removeAvailabilitySubscription(String callerID, AvailabilitySubscriber subscriber, String requestURI)
addAvailabilitySubscription
method.
callerID
- the ID of the caller that owns the listenersubscriber
- the listeners registered by the callerrequestURI
- the URI of the request used previously for subscriptionvoid removeMatchingProfiles(String calleeID, ServiceProfile[] realizedServices)
calleeID
- the ID of the ServiceCalee that owns the service profiles.realizedServices
- the service profiles to be removed.void brokerRequest(String callerID, BusMessage request)
brokerReply(String, BusMessage)
. The bus
will then inform the original requester (the ServiceCaller that has
called this method) about the result.
callerID
- the ID of the caller that is sending the request.request
- the actual request message.void brokerReply(String calleeID, BusMessage response)
calleeID
- the ID of the service callee which processed the request.response
- the actual response message.void unregister(String callerID, ServiceCaller caller)
callerID
- the ID of the caller to be unregistered.caller
- the ServiceCaller object to be unregistered.void unregister(String calleeID, ServiceCallee callee)
calleeID
- the ID of the callee to be unregistered.callee
- the ServiceCallee object to be unregistered.HashMap getMatchingServices(String serviceClassURI)
serviceClassURI
- the URI of the desired service class.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |