1 /* 2 * Copyright 2025 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 package com.android.isolated_storage_service; 17 18 /** 19 * The AIDL interface for the Icing search engine within the isolated storage service. 20 * These APIs generally map to the available APIs in the Icing search engine library at external/icing/java/src/com/google/android/icing/IcingSearchEngine.java. 21 */ 22 interface IIcingSearchEngine { 23 @nullable initialize(in byte[] icingSearchEngineOptionsProto)24 /*InitializeResultProto*/ byte[] initialize(in byte[] icingSearchEngineOptionsProto); 25 close()26 void close(); 27 28 @nullable reset()29 /*ResetResultProto*/ byte[] reset(); 30 31 @nullable setSchema(in byte[] schemaProto, boolean ignoreErrorsAndDeleteDocuments)32 /*SetSchemaResultProto*/ byte[] setSchema(in byte[] schemaProto, boolean ignoreErrorsAndDeleteDocuments); 33 34 @nullable getSchema()35 /*GetSchemaResultProto*/ byte[] getSchema(); 36 37 @nullable getSchemaForDatabase(String database)38 /*GetSchemaResultProto*/ byte[] getSchemaForDatabase(String database); 39 40 @nullable getSchemaType(String schemaType)41 /*GetSchemaTypeResultProto*/ byte[] getSchemaType(String schemaType); 42 43 @nullable put(in byte[] documentProto)44 /*PutResultProto*/ byte[] put(in byte[] documentProto); 45 46 @nullable batchPut(in byte[] putDocumentRequestProto)47 /*BatchPutResultProto*/ byte[] batchPut(in byte[] putDocumentRequestProto); 48 49 @nullable get(String name_space, String uri, in byte[] getResultSpecProto)50 /*GetResultProto*/ byte[] get(String name_space, String uri, in byte[] getResultSpecProto); 51 52 @nullable reportUsage(in byte[] usageReportProto)53 /*ReportUsageResultProto*/ byte[] reportUsage(in byte[] usageReportProto); 54 55 @nullable getAllNamespaces()56 /*GetAllNamespacesResultProto*/ byte[] getAllNamespaces(); 57 58 @nullable search(in byte[] searchSpecProto, in byte[] scoringSpecProto, in byte[] resultSpecProto)59 /*SearchResultProto*/ byte[] search(in byte[] searchSpecProto, in byte[] scoringSpecProto, in byte[] resultSpecProto); 60 61 @nullable getNextPage(long nextPageToken)62 /*SearchResultProto*/ byte[] getNextPage(long nextPageToken); 63 invalidateNextPageToken(long nextPageToken)64 void invalidateNextPageToken(long nextPageToken); 65 66 @nullable openWriteBlob(in byte[] blobHandleProto)67 /*BlobProto*/ byte[] openWriteBlob(in byte[] blobHandleProto); 68 69 @nullable removeBlob(in byte[] blobHandleProto)70 /*BlobProto*/ byte[] removeBlob(in byte[] blobHandleProto); 71 72 @nullable openReadBlob(in byte[] blobHandleProto)73 /*BlobProto*/ byte[] openReadBlob(in byte[] blobHandleProto); 74 75 @nullable commitBlob(in byte[] blobHandleProto)76 /*BlobProto*/ byte[] commitBlob(in byte[] blobHandleProto); 77 78 @nullable deleteDoc(String name_space, String uri)79 /*DeleteResultProto*/ byte[] deleteDoc(String name_space, String uri); 80 81 @nullable searchSuggestions(in byte[] suggestionSpecProto)82 /*SuggestionResponse*/ byte[] searchSuggestions(in byte[] suggestionSpecProto); 83 84 @nullable deleteByNamespace(String name_space)85 /*DeleteByNamespaceResultProto*/ byte[] deleteByNamespace(String name_space); 86 87 @nullable deleteBySchemaType(String schemaType)88 /*DeleteBySchemaTypeResultProto*/ byte[] deleteBySchemaType(String schemaType); 89 90 @nullable deleteByQuery(in byte[] searchSpecProto, boolean returnDeletedDocumentInfo)91 /*DeleteByQueryResultProto*/ byte[] deleteByQuery(in byte[] searchSpecProto, boolean returnDeletedDocumentInfo); 92 93 @nullable persistToDisk( int persistTypeCode)94 /*PersistToDiskResultProto*/ byte[] persistToDisk(/*PersistType.Code*/ int persistTypeCode); 95 96 @nullable optimize()97 /*OptimizeResultProto*/ byte[] optimize(); 98 99 @nullable getOptimizeInfo()100 /*GetOptimizeInfoResultProto*/ byte[] getOptimizeInfo(); 101 102 @nullable getStorageInfo()103 /*StorageInfoResultProto*/ byte[] getStorageInfo(); 104 105 @nullable getDebugInfo( int verbosity)106 /*DebugInfoResultProto*/ byte[] getDebugInfo(/*DebugInfoVerbosity.Code*/ int verbosity); 107 }