sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/api/src/net/jxta/resolver/QueryHandler.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.protocol.ResolverQueryMsg;
  61 import net.jxta.protocol.ResolverResponseMsg;
  62 import net.jxta.exception.*;
  63 import java.io.*;
  64
  65
  66 /**
  67  * Services that wish to act as a resolver handler must implement this interface
  68  *
  69  * @see net.jxta.resolver.ResolverService
  70  * @see net.jxta.protocol.ResolverQueryMsg
  71  * @see net.jxta.protocol.ResolverResponseMsg
  72  **/
  73 public interface QueryHandler {
  74
  75     /**
  76      * Process the resolver query, and generate response
  77      * it is the responsibility of the handler to send the response
  78      *
  79      * <p/><pre>
  80      * result = processIncomingQuery(query);
  81      * if (result != null) {
  82      *   resolver.sendResponse(query.getSrc(), response);
  83      *   return ResolverService.OK;
  84      *  } else return ResolverService.Repropagate;
  85      * </pre>
  86      *
  87      * @param query ResolverQueryMsg query
  88      * @return int status, {@link net.jxta.resolver.ResolverService#OK OK}
  89      * success, {@link net.jxta.resolver.ResolverService#Repropagate Repropagate}
  90      * to indicate a re-propagation is needed.
  91      */
  92
  93     public int processQuery(ResolverQueryMsg query);
  94
  95     /**
  96      * Called when messages are received by the ResolverService
  97      * it calls back this method to deal with received responses
  98      *
  99      * @param response ResolverQueryMsg response
 100      **/
 101     public void processResponse(ResolverResponseMsg response);
 102 }