1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.camera.session;
18 
19 import java.io.File;
20 import java.io.IOException;
21 
22 import javax.annotation.Nonnull;
23 
24 /**
25  * Interface for the session storage manager which handles management of storage
26  * space that can be used for temporary session files.
27  */
28 public interface SessionStorageManager {
29 
30     /**
31      * Returns the directory that can be used for temporary sessions of a
32      * specific type, defined by 'subDirectory'.
33      * <p>
34      * Before returning, this method will make sure the returned directory is
35      * clean of expired session data.
36      *
37      * @param subDirectory The subdirectory to use/create within the temporary
38      *            session space, e.g. "foo".
39      * @return A valid file object that points to an existing directory.
40      * @throws IOException If the directory could not be made available.
41      */
getSessionDirectory(String subDirectory)42     public File getSessionDirectory(String subDirectory) throws IOException;
43 
44     /**
45      * Initializes the directories for storing the final session output
46      * temporarily before it is copied to the final location after calling
47      * {@link #finish()}.
48      * <p>
49      * This method will make sure the directories and file exists and is
50      * writeable, otherwise it will throw an exception.
51      *
52      * @param title the title of this session. Will be used to create a unique
53      *            sub-directory.
54      * @return The path to a JPEG file which can be used to write the final
55      *         output to.
56      * @throws IOException If the directory could not be created.
57      */
58     @Nonnull
createTemporaryOutputPath(String subDirectory, String title)59     public File createTemporaryOutputPath(String subDirectory, String title) throws IOException;
60 }
61