FileSystemChecksumService.java

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ratpack.file.internal;

import ratpack.api.Nullable;

public interface FileSystemChecksumService {

  /**
   *  Calculate checksum for file given by {@code path} relative to server's {@code baseDir}.
   *
   *  @param path file path relative to root defined by server's ```baseDir```
   *  @return calculated checksum
   *  @throws Exception NoSuchFileException
   */
  @Nullable
  String checksum(String path) throws Exception;
}