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.analysis
18 
19 import com.android.libraries.pcc.chronicle.api.DataTypeDescriptor
20 import com.android.libraries.pcc.chronicle.api.ProcessorNode
21 import com.android.libraries.pcc.chronicle.api.cantrip.Cantrip
22 import com.android.libraries.pcc.chronicle.api.policy.Policy
23 import com.android.libraries.pcc.chronicle.api.policy.builder.UsageType
24 
25 /**
26  * Defines a factory capable of building [Cantrips][Cantrip] based on a [ConnectionRequest] and a
27  * given [UsageType].
28  */
29 interface CantripFactory {
30   /**
31    * Builds a [Cantrip] for the [dtd] accessed via a [requester][ProcessorNode] given the
32    * [usageType] and abiding by the [policy][Policy].
33    */
buildCantripnull34   fun <Data> buildCantrip(
35     dtd: DataTypeDescriptor,
36     requester: ProcessorNode,
37     policy: Policy?,
38     usageType: UsageType
39   ): Cantrip<Data>
40 }
41