java/src/main/com/google/appengine/api/blobstore/BlobInfo.java

   1 // Copyright 2009 Google Inc. All rights reserved.
   2
   3 package com.google.appengine.api.blobstore;
   4
   5 import java.io.IOException;
   6 import java.io.ObjectInputStream;
   7 import java.io.Serializable;
   8 import java.util.Date;
   9
  10 /**
  11  * {@code BlobInfo} contains metadata about a blob. This metadata is gathered by
  12  * parsing the HTTP headers included in the blob upload.
  13  *
  14  * @see <a href="http://tools.ietf.org/html/rfc1867">RFC 1867</a> for
  15  * the specification of HTTP file uploads.
  16  */
  17 public class BlobInfo implements Serializable {
  18   private static final long serialVersionUID = 4530115855912621409L;
  19   private static final String DEFAULT_MD5_HASH = "";
  20   protected final BlobKey blobKey;
  21   protected final String contentType;
  22   protected final Date creation;
  23   protected final String filename;
  24   protected final long size;
  25   protected String md5Hash;
  26
  27   /**
  28    * Creates a {@code BlobInfo} by providing the {@link BlobKey} and all
  29    * associated metadata. This is typically done by the API on the developer's
  30    * behalf.
  31    */
  32   public BlobInfo(BlobKey blobKey, String contentType, Date creation, String filename,
  33                   long size, String md5Hash) {
  34     if (blobKey == null) {
  35       throw new NullPointerException("blobKey must not be null");
  36     }
  37     if (contentType == null) {
  38       throw new NullPointerException("contentType must not be null");
  39     }
  40     if (creation == null) {
  41       throw new NullPointerException("creation must not be null");
  42     }
  43     if (filename == null) {
  44       throw new NullPointerException("filename must not be null");
  45     }
  46     if (md5Hash == null) {
  47       throw new NullPointerException("md5Hash must not be null");
  48     }
  49
  50     this.blobKey = blobKey;
  51     this.contentType = contentType;
  52     this.creation = creation;
  53     this.filename = filename;
  54     this.size = size;
  55     this.md5Hash = md5Hash;
  56   }
  57
  58   public BlobInfo(BlobKey blobKey, String contentType, Date creation, String filename, long size) {
  59     this(blobKey, contentType, creation, filename, size, DEFAULT_MD5_HASH);
  60   }
  61
  62   /**
  63    * Returns the {@link BlobKey} of the Blob this {@code BlobInfo} describes.
  64    */
  65   public BlobKey getBlobKey() {
  66     return blobKey;
  67   }
  68
  69   /**
  70    * Returns the MIME Content-Type provided in the HTTP header during upload of
  71    * this Blob.
  72    */
  73   public String getContentType() {
  74     return contentType;
  75   }
  76
  77   /**
  78    * Returns the time and date the blob was upload.
  79    */
  80   public Date getCreation() {
  81     return creation;
  82   }
  83
  84   /**
  85    * Returns the file included in the Content-Disposition HTTP header during
  86    * upload of this Blob.
  87    */
  88   public String getFilename() {
  89     return filename;
  90   }
  91
  92   /**
  93    * Returns the size in bytes of this Blob.
  94    */
  95   public long getSize() {
  96     return size;
  97   }
  98
  99   /**
 100    * Returns the md5Hash of this Blob.
 101    */
 102   public String getMd5Hash() {
 103     return md5Hash;
 104   }
 105
 106   @Override
 107   public boolean equals(Object obj) {
 108     if (obj instanceof BlobInfo) {
 109       BlobInfo bi = (BlobInfo) obj;
 110       return blobKey.equals(bi.blobKey) &&
 111           contentType.equals(bi.contentType)
 112           &&
 113           creation.equals(bi.creation) &&
 114           filename.equals(bi.filename) &&
 115           size == bi.size &&
 116           md5Hash.equals(bi.md5Hash);
 117     }
 118     return false;
 119   }
 120
 121   @Override
 122   public int hashCode() {
 123     int hash = 17;
 124     hash = hash * 37 + blobKey.hashCode();
 125     hash = hash * 37 + contentType.hashCode();
 126     hash = hash * 37 + filename.hashCode();
 127     hash = hash * 37 + md5Hash.hashCode();
 128     return hash;
 129   }
 130
 131   @Override
 132   public String toString() {
 133     StringBuilder builder = new StringBuilder();
 134     builder.append("<BlobInfo: ");
 135     builder.append(blobKey);
 136     builder.append(", contentType = ");
 137     builder.append(contentType);
 138     builder.append(", creation = ");
 139     builder.append(creation.toString());
 140     builder.append(", filename = ");
 141     builder.append(filename);
 142     builder.append(", size = ");
 143     builder.append(Long.toString(size));
 144     builder.append(", md5Hash = ");
 145     builder.append(md5Hash);
 146     builder.append(">");
 147     return builder.toString();
 148   }
 149
 150   private void readObject(ObjectInputStream in)
 151       throws IOException, ClassNotFoundException {
 152     in.defaultReadObject();
 153     if (md5Hash == null) {
 154       md5Hash = DEFAULT_MD5_HASH;
 155     }
 156   }
 157 }