/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2001 The Apache Software Foundation.  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
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *     "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache" or
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * 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 THE APACHE SOFTWARE FOUNDATION 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 the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jetspeed.portal.expire;

//jetspeed stuff

import org.apache.jetspeed.portal.*;

//java stuff
import java.util.*;

/**
Handles content expiration

@author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
@version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
*/
public abstract class BaseExpire implements Expire {

    private boolean expired = false;
    private long creationTime;
    private Hashtable properties = new Hashtable();
    private Portlet portlet = null;
    
    /**
    @see Expire#init
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public void init() {
        this.setCreationTime( System.currentTimeMillis() );
    }
    
    /**
    @see Expire#isExpired
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public boolean isExpired() {
        return this.expired;
    }

    /**
    @see Expire#setExpired
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public void setExpired( boolean expired ) {
        this.expired = expired;
    }

    /**
    @see Expire#getCreationTime
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public long getCreationTime() {
        return this.creationTime;
    }
  
    /**
    @see Expire#setCreationTime
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public void setCreationTime( long creationTime ) {
        
        this.creationTime = creationTime;
    }
    
    /**
    @see Expire#setProperty
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public void setProperty( String name, String value ) {
        this.properties.put( name, value );
    }

    /**
    @see Expire#getProperty
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public String getProperty( String name ) {
        return (String)this.properties.get( name );
    }

    /**
    Get the Portlet on which this is based.
    
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public Portlet getPortlet() {
        return this.portlet;
    }
    
    /**
    Set the Portlet on which this is based.
    
    @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
    @version $Id: BaseExpire.java,v 1.4 2001/09/10 22:39:50 sgala Exp $
    */
    public void setPortlet( Portlet portlet ) {
        this.portlet = portlet;
    }
    
    
    
}

