1 /*
2  * Copyright (C) 2022 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.libraries.pcc.chronicle.api
18 
19 /**
20  * A [ConnectionProvider] is capable of providing [Connection]s to data.
21  *
22  * For each type of data a [ConnectionProvider] provides connections to, it also must supply
23  * [Chronicle] with information about the capabilities of the storage of said data (See
24  * [ManagedDataType] and [ManagementStrategy]).
25  */
26 interface ConnectionProvider {
27   val dataType: DataType
28 
29   /** Builds and returns a connection of the provided [connectionRequest]. */
getConnectionnull30   fun getConnection(connectionRequest: ConnectionRequest<out Connection>): Connection
31 
32   @Suppress("UNCHECKED_CAST")
33   fun <T : Connection> getTypedConnection(connectionRequest: ConnectionRequest<T>): T {
34     return requireNotNull(getConnection(connectionRequest) as? T) {
35       "Returned connection could not be cast to $connectionRequest"
36     }
37   }
38 }
39