BlobObjectChecker.java

  1. /*
  2.  * Copyright (C) 2017, Google Inc.
  3.  * and other copyright owners as documented in the project's IP log.
  4.  *
  5.  * This program and the accompanying materials are made available
  6.  * under the terms of the Eclipse Distribution License v1.0 which
  7.  * accompanies this distribution, is reproduced below, and is
  8.  * available at http://www.eclipse.org/org/documents/edl-v10.php
  9.  *
  10.  * All rights reserved.
  11.  *
  12.  * Redistribution and use in source and binary forms, with or
  13.  * without modification, are permitted provided that the following
  14.  * conditions are met:
  15.  *
  16.  * - Redistributions of source code must retain the above copyright
  17.  *   notice, this list of conditions and the following disclaimer.
  18.  *
  19.  * - Redistributions in binary form must reproduce the above
  20.  *   copyright notice, this list of conditions and the following
  21.  *   disclaimer in the documentation and/or other materials provided
  22.  *   with the distribution.
  23.  *
  24.  * - Neither the name of the Eclipse Foundation, Inc. nor the
  25.  *   names of its contributors may be used to endorse or promote
  26.  *   products derived from this software without specific prior
  27.  *   written permission.
  28.  *
  29.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  30.  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  31.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  34.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38.  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41.  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42.  */

  43. package org.eclipse.jgit.lib;

  44. import org.eclipse.jgit.errors.CorruptObjectException;

  45. /**
  46.  * Verifies that a blob object is a valid object.
  47.  * <p>
  48.  * Unlike trees, commits and tags, there's no validity of blobs. Implementers
  49.  * can optionally implement this blob checker to reject certain blobs.
  50.  *
  51.  * @since 4.9
  52.  */
  53. public interface BlobObjectChecker {
  54.     /** No-op implementation of {@link BlobObjectChecker}. */
  55.     BlobObjectChecker NULL_CHECKER =
  56.             new BlobObjectChecker() {
  57.                 @Override
  58.                 public void update(byte[] in, int p, int len) {
  59.                     // Empty implementation.
  60.                 }

  61.                 @Override
  62.                 public void endBlob(AnyObjectId id) {
  63.                     // Empty implementation.
  64.                 }
  65.             };

  66.     /**
  67.      * Check a new fragment of the blob.
  68.      *
  69.      * @param in
  70.      *            input array of bytes.
  71.      * @param offset
  72.      *            offset to start at from {@code in}.
  73.      * @param len
  74.      *            length of the fragment to check.
  75.      */
  76.     void update(byte[] in, int offset, int len);

  77.     /**
  78.      * Finalize the blob checking.
  79.      *
  80.      * @param id
  81.      *            identity of the object being checked.
  82.      * @throws org.eclipse.jgit.errors.CorruptObjectException
  83.      *             if any error was detected.
  84.      */
  85.     void endBlob(AnyObjectId id) throws CorruptObjectException;
  86. }