rdvconnection.java

JXTA&#8482 is a set of open, generalized peer-to-peer (P2P) protocols that allow any networked devi

/*
 * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
 *  
 *  The Sun Project JXTA(TM) Software License
 *  
 *  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.impl.rendezvous.edge;

import net.jxta.id.ID;
import net.jxta.impl.rendezvous.PeerConnection;
import net.jxta.impl.rendezvous.RendezVousServiceImpl;
import net.jxta.impl.util.TimeUtils;
import net.jxta.peergroup.PeerGroup;
import net.jxta.protocol.PeerAdvertisement;

import java.util.logging.Level;

import net.jxta.logging.Logging;

import java.util.logging.Logger;

/**
 * Manages a connection with a client or a rendezvous peer.
 */
public class RdvConnection extends PeerConnection {

    /**
     * Logger
     */
    private final static transient Logger LOG = Logger.getLogger(RdvConnection.class.getName());

    protected long leasedTil;
    protected long beginRenewalAt;

    protected PeerAdvertisement cachedPeerAdvertisement = null;
    protected int cachedModCount = -1;

    /**
     * Constructor for the PeerConnection object
     *
     * @param group      group context
     * @param rdvService the rendezvous service to use for sending messages.
     * @param peer       destination peerid
     */
    public RdvConnection(PeerGroup group, RendezVousServiceImpl rdvService, ID peer) {
        super(group, rdvService.endpoint, peer);

        cachedPeerAdvertisement = group.getPeerAdvertisement();
        cachedModCount = cachedPeerAdvertisement.getModCount();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return super.toString() + " / " + Long.toString(TimeUtils.toRelativeTimeMillis(beginRenewalAt));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void setLease(long leaseDuration) {
        setLease(leaseDuration, 0);
    }

    /**
     * Set the lease duration in relative milliseconds.
     *
     * @param leaseDuration the lease duration in relative milliseconds.
     * @param earlyRenewal  amount of time in relative milliseconds before lease end to begin renewal
     */
    public void setLease(long leaseDuration, long earlyRenewal) {

        if (leaseDuration < earlyRenewal) {
            throw new IllegalArgumentException("Renewal scheduled before begining of lease");
        }

        super.setLease(leaseDuration);
        beginRenewalAt = TimeUtils.toAbsoluteTimeMillis(leaseDuration - earlyRenewal);
    }

    /**
     * Declare that we are connected.
     *
     * @param padv          the node advertisement
     * @param leaseDuration lease duration in milliseconds
     * @param earlyRenewal  early renwal in milliseconds
     */
    public void connect(PeerAdvertisement padv, long leaseDuration, long earlyRenewal) {
        super.connect(leaseDuration);

        setLease(leaseDuration, earlyRenewal);

        // We will almost certainly need a messenger soon. Get it now.
        getCachedMessenger(padv);
    }

    /**
     * Time at which the lease needs renewal in absolute milliseconds.
     *
     * @return The lease value
     */
    public long getRenewal() {
        return beginRenewalAt;
    }
}