FileStorage.java

/*
 * Copyright 2010 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 org.springframework.data;

/**
 * Portable service abstraction for storing files.
 * @author Keith Donald
 */
public interface FileStorage {

	/**
	 * Get a storage URL for the file identified with the following name.
	 * @param fileName the relative file name
	 * @return the full path to the file in the store
	 */
	String absoluteUrl(String fileName);

	/**
	 * Put a file into storage.
	 * @param file the file data
	 * @return a URL that can be used to obtain the file
	 */
	// TODO exception hierarchy
	String storeFile(FileData file);
	
}