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 /**
23  * Interface for the session storage manager which handles management of storage
24  * space that can be used for temporary session files.
25  */
26 public interface SessionStorageManager {
27 
28     /**
29      * Returns the directory that can be used for temporary sessions of a
30      * specific type, defined by 'subDirectory'.
31      * <p>
32      * Before returning, this method will make sure the returned directory is
33      * clean of expired session data.
34      *
35      * @param subFolder The subfolder to use/create within the temporary session
36      *            space, e.g. "foo".
37      * @return A valid file object that points to an existing directory.
38      * @throws IOException If the directory could not be made available.
39      */
getSessionDirectory(String subDirectory)40     public File getSessionDirectory(String subDirectory) throws IOException;
41 }
42