src/java/org/apache/jcs/engine/ElementAttributes.java

package org.apache.jcs.engine;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.Serializable;

import org.apache.jcs.access.exception.InvalidArgumentException;

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 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 acknowlegement:
 * "This product includes software developed by the
 * Apache Software Foundation (http://www.apache.org/)."
 * Alternately, this acknowlegement may appear in the software itself,
 * if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Velocity", and "Apache Software
 * Foundation" 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"
 * nor may "Apache" appear in their names without prior written
 * permission of the Apache Group.
 *
 * 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/>.
 */
import org.apache.jcs.engine.behavior.IElementAttributes;

/**
 * Element attribute descriptor class.
 *
 * @author <a href="mailto:asmuts@yahoo.com">Aaron Smuts</a>
 * @created January 15, 2002
 * @version $Id: ILateralCacheTCPListener.java,v 1.2 2002/01/18 22:08:26
 */
public class ElementAttributes implements IElementAttributes, Serializable, Cloneable
{

    /**
     * Is this item distributable at all.
     */
    public boolean IS_DISTRIBUTE = false;
    // lateral

    /**
     * can this item be flushed to disk
     */
    public boolean IS_SPOOL = false;

    /**
     * Is this item laterally distributable
     */
    public boolean IS_LATERAL = false;

    /**
     * Can this item be sent to the remote cache
     */
    public boolean IS_REMOTE = false;

    /**
     * can turn off expiration
     */
    public boolean IS_ETERNAL = true;

    /**
     * Description of the Field
     */
    public long version = 0;

    /**
     * Max life seconds
     */
    public long mls = -1;

    /**
     * Description of the Field
     */
    public long idle = -1;

    /**
     * The byte size of teh field. Must be manually set.
     */
    public int size = 0;

    /**
     * The creation time
     */
    public long createTime = 0;

    /**
     * The last access time
     */
    public long lastAccessTime = 0;

    /**
     * Constructor for the IElementAttributes object
     */
    public ElementAttributes()
    {
        this.createTime = System.currentTimeMillis();
        this.lastAccessTime = this.createTime;
    }


    /**
     * Constructor for the IElementAttributes object
     *
     * @param attr
     */
    private ElementAttributes( ElementAttributes attr )
    {

        IS_ETERNAL = attr.IS_ETERNAL;

        // waterfal onto disk, for pure disk set memory to 0
        IS_SPOOL = attr.IS_SPOOL;

        IS_DISTRIBUTE = attr.IS_DISTRIBUTE;

        // lateral
        IS_LATERAL = attr.IS_LATERAL;

        // central rmi store
        IS_REMOTE = attr.IS_REMOTE;

        mls = attr.mls;
        // timetolive
        idle = attr.idle;
        size = attr.size;

    }


    /**
     * Description of the Method
     *
     * @return
     */
    public IElementAttributes copy()
    {
        try
        {
//            ElementAttributes attr = ( ElementAttributes ) this.clone();
//            attr.createTime = System.currentTimeMillis();
//            attr.setLastAccessTimeNow();
//            return attr;

            // need to make this more efficient.  Just want to insure
            // a proper copy
            ElementAttributes attr = new ElementAttributes( );
            attr.setIdleTime(this.getIdleTime());
            attr.setIsEternal(this.getIsEternal());
            attr.setIsDistribute(this.getIsDistribute());
            attr.setIsLateral(this.getIsLateral());
            attr.setIsRemote(this.getIsRemote());
            attr.setIsSpool(this.getIsSpool());
            attr.setMaxLifeSeconds(this.getMaxLifeSeconds());
            return attr;

        }
        catch ( Exception e )
        {
            return new ElementAttributes();
        }
    }


    /**
     * Description of the Method
     *
     * @return
     */
    public Object clone2()
    {

        try
        {
            ByteArrayOutputStream baos =
                new ByteArrayOutputStream( 100 );
            ObjectOutputStream oos = new
                ObjectOutputStream( baos );
            oos.writeObject( this );
            byte buf[] = baos.toByteArray();
            oos.close();

            // deserialize byte array into ArrayList

            ByteArrayInputStream bais =
                new ByteArrayInputStream( buf );
            ObjectInputStream ois = new
                ObjectInputStream( bais );
            ElementAttributes attr =
                ( ElementAttributes ) ois.readObject();
            ois.close();

            attr.createTime = System.currentTimeMillis();
            return attr;
        }
        catch ( Exception e )
        {
        }
        return null;
    }

    /**
     * Sets the version attribute of the IElementAttributes object
     *
     * @param version The new version value
     */
    public void setVersion( long version )
    {
        this.version = version;
    }


    /**
     * Sets the maxLifeSeconds attribute of the IElementAttributes object
     *
     * @param ttl The new timeToLive value
     * @param mls The new {3} value
     */
    public void setMaxLifeSeconds( long mls )
    {
        this.mls = mls;
    }

    /**
     * Gets the {3} attribute of the ElementAttributes object
     *
     * @return The {3} value
     */
    public long getMaxLifeSeconds()
    {
        return this.mls;
    }


    /**
     * Sets the idleTime attribute of the IElementAttributes object
     *
     * @param idle The new idleTime value
     */
    public void setIdleTime( long idle )
    {
        this.idle = idle;
    }


    //public void setListener( int event, CacheEventListener listerner) {}

    /**
     * Size in bytes.
     *
     * @param size The new size value
     */
    public void setSize( int size )
    {
        this.size = size;
    }


    /**
     * Gets the size attribute of the IElementAttributes object
     *
     * @return The size value
     */
    public int getSize()
    {
        return size;
    }


    /**
     * Gets the createTime attribute of the IElementAttributes object
     *
     * @return The createTime value
     */
    public long getCreateTime()
    {
        return createTime;
    }


    /**
     * Sets the createTime attribute of the IElementAttributes object
     */
    public void setCreateTime()
    {
        createTime = System.currentTimeMillis();
    }


    /**
     * Gets the version attribute of the IElementAttributes object
     *
     * @return The version value
     */
    public long getVersion()
    {
        return version;
    }


    /**
     * Gets the idleTime attribute of the IElementAttributes object. Keeping
     * track of this will require storing the last access time. This could get
     * expensive.
     *
     * @return The idleTime value
     */
    public long getIdleTime()
    {
        return this.idle;
    }


    /**
     * If the returned value is negative, the item has expired
     *
     * @return The timeToLive value
     */
    public long getTimeToLiveSeconds()
    {
        long now = System.currentTimeMillis();
        return ( this.getCreateTime() + ( this.getMaxLifeSeconds() * 1000 ) ) - now;
    }


    /**
     * Gets the LastAccess attribute of the IAttributes object
     *
     * @return The LastAccess value
     */
    public long getLastAccessTime()
    {
        return this.lastAccessTime;
    }

    /**
     * Sets the LastAccessTime as now of the IElementAttributes object
     */
    public void setLastAccessTimeNow()
    {
        this.lastAccessTime = System.currentTimeMillis();
    }


    /**
     * Gets the {3} attribute of the IElementAttributes object
     *
     * @return The {3} value
     */
    public boolean getIsDistribute()
    {
        return this.IS_DISTRIBUTE;
    }
     public void setIsDistribute( boolean val) {
        this.IS_DISTRIBUTE = val;
     }

    /**
     * can this item be flushed to disk
     *
     * @return The {3} value
     */
    public boolean getIsSpool()
    {
        return this.IS_SPOOL;
    }
     public void setIsSpool( boolean val) {
        this.IS_SPOOL = val;
     }

    /**
     * Is this item laterally distributable
     *
     * @return The {3} value
     */
    public boolean getIsLateral()
    {
        return this.IS_LATERAL;
    }
     public void setIsLateral( boolean val) {
        this.IS_LATERAL = val;
     }

    /**
     * Can this item be sent to the remote cache
     *
     * @return The {3} value
     */
    public boolean getIsRemote()
    {
        return this.IS_REMOTE;
    }
     public void setIsRemote( boolean val) {
        this.IS_REMOTE = val;
     }

    /**
     * can turn off expiration
     *
     * @return The {3} value
     */
    public boolean getIsEternal()
    {
        return this.IS_ETERNAL;
    }

     public void setIsEternal( boolean val) {
        this.IS_ETERNAL = val;
     }


    /**
     * For logging and debugging the element IElementAttributes.
     *
     * @return
     */
    public String toString()
    {
        StringBuffer dump = new StringBuffer();

        dump.append( "[ IS_LATERAL = " ).append( IS_LATERAL )
            .append( ", IS_SPOOL = " ).append( IS_SPOOL )
            .append( ", IS_REMOTE = " ).append( IS_REMOTE )
            .append( ", IS_ETERNAL = " ).append( IS_ETERNAL )
            .append( ", MaxLifeSeconds = " ).append( this.getMaxLifeSeconds() )
            .append( ", IdleTime = " ).append( this.getIdleTime() )
            .append( ", CreateTime = " ).append( this.getCreateTime() )
            .append( ", LastAccessTime = " ).append( this.getLastAccessTime() )
            .append( ", getTimeToLiveSeconds() = " ).append( String.valueOf( getTimeToLiveSeconds() ) )
            .append( ", createTime = " ).append( String.valueOf( createTime ) )
            .append( " ]" );

        return dump.toString();
    }
}