blob: aa6ea9ffeb1bedc2ba681645a3b08b8267748d40 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.context;
import com.google.gson.JsonElement;
import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
/**
* This interface is implemented by plugin classes that use a particular schema to convert Apex context objects to an
* understandable form.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
public interface SchemaHelper {
/**
* Initialize the schema helper with its properties.
*
* @param userKey The key that identifies the user of the schema helper
* @param schema the schema
* @throws ContextRuntimeException the context runtime exception
*/
void init(AxKey userKey, AxContextSchema schema) throws ContextRuntimeException;
/**
* Get the user key of the schema helper.
*
* @return the user key
*/
AxKey getUserKey();
/**
* Get the schema of the schema helper.
*
* @return the schema
*/
AxContextSchema getSchema();
/**
* The Java class that this schema produces on the Java side.
*
* @return the schema class
*/
Class<?> getSchemaClass();
/**
* The Java class that handles the schema for the schema technology in use.
*
* @return the schema object
*/
Object getSchemaObject();
/**
* Create a new instance of the schema class using whatever schema technology is being used.
*
* @return the new instance
*/
Object createNewInstance();
/**
* Create a new instance of the schema class using whatever schema technology is being used.
*
* @param stringValue the string represents the value the new instance should have
* @return the new instance
*/
Object createNewInstance(String stringValue);
/**
* Create a new instance of the schema class from a GSON JsonElement using whatever schema technology is being used.
*
* @param jsonElement the JSON element that holds the Json representation of the object
* @return the new instance
*/
Object createNewInstance(JsonElement jsonElement);
/**
* Unmarshal an object in schema format into a Java object.
*
* @param object the object as a Java object
* @return the object in schema format
*/
Object unmarshal(Object object);
/**
* Marshal a Java object into Json format.
*
* @param schemaObject the object in schema format
* @return the object as a Json string
*/
String marshal2Json(Object schemaObject);
/**
* Marshal a Java object into a GSON json element.
*
* @param schemaObject the object in schema format
* @return the object as a GSON Json element
*/
JsonElement marshal2JsonElement(Object schemaObject);
}
|
