StorageObject.java

/**
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * @author Arne Kepp / The Open Planning Project 2009
 *  
 */
package org.geowebcache.storage;

/**
 * A generic cacheable object
 */
public abstract class StorageObject {
    public static enum Status { UNSET, HIT, MISS, LOCK, EXPIRED_LOCK};
    
    Status status = Status.UNSET;
    
    long created;
    
    long access_last;
    
    long access_count;
    
    String blob_format;
    
    int blob_size;
    
    
    /**
     * @return the name of the type of object. Identical for all objects of a class.
     */
    abstract public String getType();
    
    /**
     * @return the size of the tile blob.
     */
    public int getBlobSize() {
        return blob_size;
    }

    public String getBlobFormat() {
        return blob_format;
    }
    
    /**
     * The time that the stored resource was created/modified
     */
    public long getCreated() {
        return created;
    }
    
    public Status getStatus() {
        return status;
    }
    
    /**
     * The time that the stored resource was created/modified
     */
    public void setCreated(long created) {
        this.created = created;
    }
    
    public void setBlobFormat(String blobFormat) {
        this.blob_format = blobFormat;
    }
    
    /**
     * Used to set the size of the blob when the tile is created, and the actual storage size once
     * the {@link BlobStore} saves it, so notifications to {@link BlobStoreListener}s are sent with
     * the actual storage size.
     * 
     * @param blob_size the size of tile as stored in the backend storage mechanism.
     */
    public void setBlobSize(int blob_size) {
        this.blob_size = blob_size;
    }
    
    public void setStatus(Status status) {
        this.status = status;
    }
}