sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/resolver/ResolverService.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.resolver;
  58
  59
  60 import net.jxta.service.Service;
  61 import net.jxta.protocol.ResolverQueryMsg;
  62 import net.jxta.protocol.ResolverResponseMsg;
  63 import net.jxta.protocol.ResolverSrdiMsg;
  64
  65
  66 /**
  67  * Provides a generic mechanism for JXTA Services to send "Queries", and receive
  68  * "Responses". It removes the burden for registered handlers in deal with :
  69  *
  70  *<ul type-disc>
  71  *    <li>Setting message tags, to ensure uniqueness of tags and
  72  *     ensures that messages are sent to the correct address, and group.</p>
  73  *    <li>Authentication, and verification of credentials.</p>
  74  *    <li>Query routing.</p>
  75  *    <li>drop rogue messages.</p>
  76  *</ul>
  77  *
  78  * <p/>The ResolverService does not proccess the queries, nor does it not
  79  * compose reponses. Processing of queries, and composition of responses is left
  80  * up to the registered handlers. Services that wish to handle queries and
  81  * generate reponses must implement {@link net.jxta.resolver.QueryHandler}.
  82  *
  83  * @see net.jxta.service.Service
  84  * @see net.jxta.resolver.QueryHandler
  85  * @see net.jxta.protocol.ResolverQueryMsg
  86  * @see net.jxta.protocol.ResolverResponseMsg
  87  */
  88 public interface ResolverService extends Service, GenericResolver {
  89
  90     /**
  91      *  Returned by query handlers to indicate that the query should be
  92      *  forwarded to the rest of the network.
  93      */
  94     public final static int Repropagate = -1;
  95
  96     /**
  97      *  Returned by query handlers to indicate that the query has been resolved
  98      *  and a response has been sent.
  99      */
 100     public final static int OK = 0;
 101
 102     /**
 103      *  Registers a given QueryHandler, returns the previous handler registered
 104      *  under this name.
 105      *
 106      *  @param name The name under which this handler is to be registered.
 107      *  @param handler The handler.
 108      *  @return The previous handler registered under this name.
 109      */
 110     public QueryHandler registerHandler(String name, QueryHandler handler);
 111
 112     /**
 113      *  Unregisters a given QueryHandler, returns the previous handler
 114      *  registered under this name.
 115      *
 116      *  @param name The name of the handler to unregister.
 117      *  @return The previous handler registered under this name.
 118      */
 119     public QueryHandler unregisterHandler(String name);
 120
 121     /**
 122      *  Registers a given SrdiHandler, returns the previous handler registered
 123      *  under this name.
 124      *
 125      *  @param name The name under which this handler is to be registered.
 126      *  @param handler The handler.
 127      *  @return The previous handler registered under this name.
 128      *
 129      */
 130     public SrdiHandler registerSrdiHandler(String name, SrdiHandler handler);
 131
 132     /**
 133      *  Unregisters a given SrdiHandler, returns the previous handler registered
 134      *  under this name.
 135      *
 136      *  @param name The name of the handler to unregister.
 137      *  @return The previous handler registered under this name
 138      *
 139      */
 140     public SrdiHandler unregisterSrdiHandler(String name);
 141
 142     /**
 143      *  Sends a resolver query. If <tt>destPeer</tt> is <tt>null</tt> the
 144      *  message is propagated.
 145      *
 146      *  @param destPeer The destination peer of the query or <tt>null</tt> if
 147      *  the query is to be propagated.
 148      *  @param query The query to match.
 149      */
 150     public void sendQuery(String destPeer, ResolverQueryMsg query);
 151
 152     /**
 153      *  Send a resolver response. If <tt>destPeer</tt> is <tt>null</tt> then the
 154      *  response is propagated. Propagated responses are generally announcements
 155      *  and not responses to active queries.
 156      *
 157      *  @param destPeer The destination peer of the response or <tt>null</tt> if
 158      *  the response is to be propagated.
 159      *  @param response The response to be sent.
 160      */
 161     public void sendResponse(String destPeer, ResolverResponseMsg response);
 162
 163     /**
 164      *  Send an SRDI message.
 165      *
 166      *  <p/>If <tt>destPeer</tt> is <tt>null</tt> the message is walked.
 167      *
 168      *  @param destPeer is the destination of the SRDI message.
 169      *  @param srdi is the SRDI message to be sent.
 170      */
 171     public void sendSrdi(String destPeer, ResolverSrdiMsg srdi);
 172 }