/*
 * 
 * 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 com.sun.jini.landlord;

import net.jini.core.lease.LeaseDeniedException;
import net.jini.core.lease.UnknownLeaseException;
import net.jini.id.Uuid;

/**
 * Interface that defines the basic landlord primitives (renew and
 * cancel) as local methods.  Classes already implementing 
 * <code>Landlord</code> should be able to implement this interface
 * simply by adding it the the <code>implements</code> clause of their
 * class declaration.
 * <p>
 * Some users may want to implement this interface using an adaptor
 * class. This could be useful in situations where the landlord's
 * cancel and renew methods don't do quite the right thing for batch
 * lease operations
 * <p>
 * This interface gives local landlord utilities access to the cancel
 * and renew methods.
 *
 * @author Sun Microsystems, Inc.
 *
 * @see com.sun.jini.landlord.Landlord 
 * @since 2.0
 */
public interface LocalLandlord {
    /**
     * Renew the lease that is associated with the given cookie.
     *
     * @param cookie   an object that universally and uniquely identifies a
     *                 lease granted by this <code>LocalLandlord</code>
     * @param duration the duration in milliseconds the client
     *                 wants the lease renewed for
     * @return The new duration the lease should have
     * @throws LeaseDeniedException if the landlord is unwilling to
     *         renew the lease
     * @throws UnknownLeaseException if landlord does not know about
     *         a lease with the specified <code>cookie</code>
     */
    public long renew(Uuid cookie, long duration)
	throws LeaseDeniedException, UnknownLeaseException;
       
    /**
     * Cancel the lease that is associated with the given cookie.
     *
     * @param cookie   an object that universally and uniquely identifies a
     *                 lease granted by this <code>LocalLandlord</code>
     * @throws UnknownLeaseException if landlord does not know about
     *         a lease with the specified <code>cookie</code>
     */
    public void cancel(Uuid cookie) throws UnknownLeaseException;
}
 
