JXTA

net.jxta.resolver
Interface ResolverService

All Superinterfaces:
GenericResolver, Module, Service

public interface ResolverService
extends Service, GenericResolver

Provides a generic mechanism for JXTA Services to send "Queries", and receive "Responses". It removes the burden for registered handlers in deal with :

The ResolverService does not proccess the queries, nor does it not compose reponses. Processing of queries, and composition of responses is left up to the registered handlers. Services that wish to handle queries and generate reponses must implement QueryHandler.

See Also:
Service, QueryHandler, ResolverQueryMsg, ResolverResponseMsg

Field Summary
static int OK
          Returned by query handlers to indicate that the query has been resolved and a response has been sent.
static int Repropagate
          Returned by query handlers to indicate that the query should be forwarded to the rest of the network.
 
Fields inherited from interface net.jxta.platform.Module
START_AGAIN_PROGRESS, START_AGAIN_STALLED, START_DISABLED, START_OK
 
Method Summary
 QueryHandler registerHandler(String name, QueryHandler handler)
          Registers a given QueryHandler, returns the previous handler registered under this name.
 SrdiHandler registerSrdiHandler(String name, SrdiHandler handler)
          Registers a given SrdiHandler, returns the previous handler registered under this name.
 void sendQuery(String destPeer, ResolverQueryMsg query)
          Sends a resolver query.
 void sendResponse(String destPeer, ResolverResponseMsg response)
          Send a resolver response.
 void sendSrdi(String destPeer, ResolverSrdiMsg srdi)
          Send an SRDI message.
 QueryHandler unregisterHandler(String name)
          Unregisters a given QueryHandler, returns the previous handler registered under this name.
 SrdiHandler unregisterSrdiHandler(String name)
          Unregisters a given SrdiHandler, returns the previous handler registered under this name.
 
Methods inherited from interface net.jxta.service.Service
getImplAdvertisement, getInterface
 
Methods inherited from interface net.jxta.platform.Module
init, startApp, stopApp
 

Field Detail

Repropagate

static final int Repropagate
Returned by query handlers to indicate that the query should be forwarded to the rest of the network.

See Also:
Constant Field Values

OK

static final int OK
Returned by query handlers to indicate that the query has been resolved and a response has been sent.

See Also:
Constant Field Values
Method Detail

registerHandler

QueryHandler registerHandler(String name,
                             QueryHandler handler)
Registers a given QueryHandler, returns the previous handler registered under this name.

Parameters:
name - The name under which this handler is to be registered.
handler - The handler.
Returns:
The previous handler registered under this name.

unregisterHandler

QueryHandler unregisterHandler(String name)
Unregisters a given QueryHandler, returns the previous handler registered under this name.

Parameters:
name - The name of the handler to unregister.
Returns:
The previous handler registered under this name.

registerSrdiHandler

SrdiHandler registerSrdiHandler(String name,
                                SrdiHandler handler)
Registers a given SrdiHandler, returns the previous handler registered under this name.

Parameters:
name - The name under which this handler is to be registered.
handler - The handler.
Returns:
The previous handler registered under this name.

unregisterSrdiHandler

SrdiHandler unregisterSrdiHandler(String name)
Unregisters a given SrdiHandler, returns the previous handler registered under this name.

Parameters:
name - The name of the handler to unregister.
Returns:
The previous handler registered under this name

sendQuery

void sendQuery(String destPeer,
               ResolverQueryMsg query)
Sends a resolver query. If destPeer is null the message is propagated.

Parameters:
destPeer - The destination peer of the query or null if the query is to be propagated.
query - The query to match.

sendResponse

void sendResponse(String destPeer,
                  ResolverResponseMsg response)
Send a resolver response. If destPeer is null then the response is propagated. Propagated responses are generally announcements and not responses to active queries.

Parameters:
destPeer - The destination peer of the response or null if the response is to be propagated.
response - The response to be sent.

sendSrdi

void sendSrdi(String destPeer,
              ResolverSrdiMsg srdi)
Send an SRDI message.

If destPeer is null the message is walked.

Parameters:
destPeer - is the destination of the SRDI message.
srdi - is the SRDI message to be sent.

JXSE