/*
 * 
 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * The contents of this file are subject to the Sun Community Source
 * License v3.0/Jini Technology Specific Attachment v 1.0 (the
 * "License"). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 * http://wwws.sun.com/software/jini/licensing/SCSL3_JiniTSA1.html.
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Reference Code is Jini Technology Core Platform code, v2.0. The
 * Developer of the Reference Code is Sun Microsystems, Inc.
 * 
 * Contributor(s): Sun Microsystems, Inc.
 * 
 * The contents of this file comply with the Jini Technology Core
 * Platform Compatibility Kit, v2.0A.
 * 
 * Tester(s): Sun Microsystems, Inc.
 * 
 * Test Platform(s):
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Solaris(TM)SPARC/x86
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Linux (Intel x86)
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Windows (Intel Platform)
 * 
 */
package net.jini.lease;

import java.rmi.RemoteException;

/**
 * Interface to the lease renewal service. The interface is not a remote
 * interface; each implementation of the renewal service exports proxy
 * objects that implement the <code>LeaseRenewalService</code> interface
 * that use an implementation-specific protocol to communicate with the
 * actual remote server. All of the proxy methods obey normal RMI remote
 * interface semantics. Two proxy objects are equal if they are proxies
 * for the same renewal service. Every method invocation (on both a
 * <code>LeaseRenewalService</code> and any <code>LeaseRenewalSet</code>
 * it has created) is atomic with respect to other invocations.
 * 
 * @author Sun Microsystems, Inc.
 * @see LeaseRenewalSet 
 */

public interface LeaseRenewalService {
    /**
     * Create a new <code>LeaseRenewalSet</code> that the client can
     * populate with leases to be renewed. The initial duration of the
     * lease granted on this set will be less than or equal to
     * <code>leaseDuration</code>.
     * <p>
     * Two calls to this method should never return objects that are
     * equal.
     *
     * @param leaseDuration requested lease duration in milliseconds
     * @return a new <code>LeaseRenewalSet</code> in the renewal service
     * @throws IllegalArgumentException if <code>leaseDuration</code> is
     *	       not positive, <code>Lease.ANY</code>, or
     *	       <code>Lease.FOREVER</code>
     * @throws RemoteException if a communication-related exception
     *	       occurs
     */
    public LeaseRenewalSet createLeaseRenewalSet(long leaseDuration) 
	throws RemoteException;
}
