module.java

jxme的一些相关程序,主要是手机上程序开发以及手机和计算机通信的一些程序资料,程序编译需要Ant支持

/*
 * Copyright (c) 2001 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 the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    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.
 * ====================================================================
 *
 * 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.
 *
 * $Id: Module.java,v 1.4 2001/11/06 07:54:16 jice Exp $
 */

package net.jxta.platform;

import net.jxta.peergroup.PeerGroup;
import net.jxta.document.Advertisement;
import net.jxta.id.ID;
import net.jxta.exception.PeerGroupException;

/**
 * This interface defines a JXTA module. All JXTA
 * services need to implement this interface. Endpoint protocols and
 * applications need to implement that interface if they are to be loaed
 * and started by a PeerGroup. Service and Application implements Module,
 * PeerGroup implements service and ShellApp implements application, as
 * a result both implement Module.
 * 
 * <p>Jxta Modules are given their initialization parameters via the init()
 * method rather than a non-default constructor.
 *
 * <p>Modules are passed the peer group within which they are created.
 * From the peergroup object, Modules can acccess all the peer group
 * services. The PeerGroup within which a PeerGroup runs is known as its
 * parent.
 * The initial root peer group is known as the World Peer Group and is
 * implemented by an object of class Platform, a subclass of PeerGroup.
 * The "parent" PeerGroup of the World Peer Group is null.
 *
 * @see net.jxta.peergroup.PeerGroup
 * @see net.jxta.service.Service
 * @see net.jxta.endpoint.EndpointProtocol
 * @see net.jxta.platform.Application
 * @see net.jxta.platform.ModuleClassID
 * @see net.jxta.protocol.ModuleImplAdvertisement
 * @see net.jxta.id.ID
 * @see net.jxta.document.Advertisement
 *
 * @version $Revision: 1.4 $
 * @since JXTA 1.0
 */

public interface Module {
    
    /**
     *  Initialize the module, passing it its peer group and advertisement.
     *
     *  @param group The PeerGroup from which this Module can obtain services.
     *  If this module is a service, this is also the PeerGroup of which this
     *  module is a service.
     *  @param assignedID Identity of Module within group.
     *  modules can use it as a the root of their namespace to create
     *  names that are unique within the group but predictible by the
     *  same module on another peer. This is normaly the ModuleClassID
     *  which is also the name under which the module is known by other
     *  modules. For a group it is the PeerGroupID itself.
     *  The parameters of a service, in the Peer configuration, are indexed
     *  by the assignedID of that service, and a Service must publish its
     *  run-time parameters in the Peer Advertisement under its assigned ID.
     *  @param implAdv The implementation advertisement for this Module.
     *
     *  @exception PeerGroupException This module failed to initialize.
     *
     * @since   JXTA 1.0
     */
    public void init(PeerGroup group,
                     ID assignedID,
                     Advertisement implAdv)
        throws PeerGroupException;
    
    /**
     *  Some Modules will wait for start() being called, before proceeding
     *  beyond a certain point. That's also the opportunity to supply
     *  harbitrary arguments (mostly to applications).
     *
     *  Note: the name of this method is historical and no-longer adequate.
     *
     *  @param args An array of Strings forming the parameters for this
     *  Module.
     *
     *  @return int status indication. By convention 0 means that this Module
     *  started succesfully.
     */
    public int startApp(String[] args);
    
    /**
     *  One can ask a Module to stop.
     *  The Module cannot be forced to comply, but in the future
     *  we might be able to deny it access to anything after some timeout.
     *
     *  Note: the name of this method is no-longer adequate.
     */
    public void stopApp();
}