1 /*
2  * Copyright (C) 2021 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.server;
18 
19 import android.annotation.BytesLong;
20 import android.annotation.NonNull;
21 import android.os.DropBoxManager;
22 
23 import java.io.Closeable;
24 import java.io.FileDescriptor;
25 import java.io.IOException;
26 
27 public abstract class DropBoxManagerInternal {
addEntry(@onNull String tag, @NonNull EntrySource source, @DropBoxManager.Flags int flags)28     public abstract void addEntry(@NonNull String tag, @NonNull EntrySource source,
29             @DropBoxManager.Flags int flags);
30 
31     /**
32      * Interface which describes a pending entry which knows how to write itself
33      * to the given FD. This abstraction supports implementations which may want
34      * to dynamically generate the entry contents.
35      */
36     public interface EntrySource extends Closeable {
writeTo(@onNull FileDescriptor fd)37         public void writeTo(@NonNull FileDescriptor fd) throws IOException;
38 
length()39         public default @BytesLong long length() {
40             // By default, length is unknown
41             return 0;
42         }
43 
close()44         public default void close() throws IOException {
45             // By default, no resources to close
46         }
47     }
48 }
49