/*
 *  The Sun Project JXTA(TM) Software License
 *  
 *  Copyright (c) 2001-2007 Sun Microsystems, Inc. All rights reserved.
 *  
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions are met:
 *  
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  
 *  2. Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation 
 *     and/or other materials provided with the distribution.
 *  
 *  3. The end-user documentation included with the redistribution, if any, must 
 *     include the following acknowledgment: "This product includes software 
 *     developed by Sun Microsystems, Inc. for JXTA(TM) technology." 
 *     Alternately, this acknowledgment may appear in the software itself, if 
 *     and wherever such third-party acknowledgments normally appear.
 *  
 *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must 
 *     not be used to endorse or promote products derived from this software 
 *     without prior written permission. For written permission, please contact 
 *     Project JXTA at http://www.jxta.org.
 *  
 *  5. Products derived from this software may not be called "JXTA", nor may 
 *     "JXTA" appear in their name, without prior written permission of Sun.
 *  
 *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
 *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN 
 *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  
 *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United 
 *  States and other countries.
 *  
 *  Please see the license information page at :
 *  <http://www.jxta.org/project/www/license.html> for instructions on use of 
 *  the license in source files.
 *  
 *  ====================================================================

 *  This software consists of voluntary contributions made by many individuals 
 *  on behalf of Project JXTA. For more information on Project JXTA, please see 
 *  http://www.jxta.org.
 *  
 *  This license is based on the BSD license adopted by the Apache Foundation. 
 */

package net.jxta.content;

import java.util.EventListener;

/**
 * This interface should expose events which should be common to
 * most/all implementations and which provide information relevant to
 * allowing the application a mechanism by which to inform the end
 * user of the share activity.  Anything beyond this is probably
 * better off in a provider-specific extension of this base
 * interface
 * 
 * @see net.jxta.content.ContentShare
 * @see net.jxta.content.ContentShareEvent
 * @see net.jxta.content.ContentProvider
 */
public interface ContentShareListener extends EventListener {
    
    /**
     * For ContentProvider mechanisms using connection-oriented
     * protocols, this event indicates that a remote client has
     * initiated Content data transfer.  As this would typically
     * only apply to connection-oriented implementations, it's
     * use by the ContentProvider is optional.
     * 
     * @param event event data
     */
    void shareSessionOpened(ContentShareEvent event);
    
    /**
     * For provider mechanisms using connection-oriented protocols,
     * this event indicates that a remote client session has
     * completed.  Completion in this sense does not indicate success
     * or failure, simply termination of the effort.  As this would
     * typically only apply to connection-oriented implementations,
     * it's use by the ContentProvider is optional.
     * 
     * @param event event data
     */
    void shareSessionClosed(ContentShareEvent event);
    
    /**
     * Event indicating that a ContentShare object has been accessed by
     * a remote peer.  This event is general enough that it should be
     * supported by all ContentShare implementations, though implementations
     * may wish to throttle the frequency of events being published to
     * allow for more scalable performance.  ContentProviders must call
     * this method for each distinguishable remote access on a
     * best-effort basis.
     * 
     * @param event event data
     */
    void shareAccessed(ContentShareEvent event);

}