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
120
121
122
123
124
125
126
127
128
129
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2021 AT&T Intellectual Property. 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.core.engine.event;
import java.io.Serializable;
import lombok.Getter;
import org.onap.policy.apex.context.ContextRuntimeException;
import org.onap.policy.apex.context.SchemaHelper;
import org.onap.policy.apex.context.impl.schema.SchemaHelperFactory;
import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
import org.onap.policy.apex.model.eventmodel.concepts.AxField;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;
/**
* Instances of the Class EnField are event fields being passed through the Apex system.
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
@Getter
public class EnField implements Serializable {
private static final long serialVersionUID = -5713525780081840333L;
// Logger for this class
private static final XLogger LOGGER = XLoggerFactory.getXLogger(EnField.class);
// The definition of this field in the Apex model
private final AxField axField;
// The schema helper for this field
private transient SchemaHelper schemaHelper;
// The value of this field
private final transient Object value;
/**
* Instantiates a new EnField, an Engine Field.
*
* @param axField the field definition from the Apex model
* @param value the value
*/
public EnField(final AxField axField, final Object value) {
// Save the field definition from the Apex model
this.axField = axField;
this.value = value;
// Get a schema helper to handle translations of fields to and from the schema
try {
schemaHelper = new SchemaHelperFactory().createSchemaHelper(axField.getKey(), axField.getSchema());
} catch (final ContextRuntimeException e) {
final String message = "schema helper cannot be created for parameter with key \"" + axField.getId()
+ "\" with schema \"" + axField.getSchema() + "\"";
LOGGER.warn(message, e);
throw new EnException(message, e);
}
}
/**
* Get the name of the field.
*
* @return the field name
*/
public String getName() {
return axField.getKey().getLocalName();
}
/**
* Get the key of the field.
*
* @return the field key
*/
public AxReferenceKey getKey() {
return axField.getKey();
}
/**
* {@inheritDoc}.
*/
@Override
public String toString() {
return "EnField [axField=" + axField + ", value=" + value + "]";
}
/**
* Get an assignable object that will work with the field.
*
* @return the assignable value
*/
public Object getAssignableValue() {
// Use the schema helper to get the translated value of the object
return schemaHelper.unmarshal(value);
}
/**
* Is the value object assignable to this field.
*
* @return true if the value is assignable
*/
public boolean isAssignableValue() {
try {
schemaHelper.unmarshal(value);
return true;
} catch (final Exception e) {
if (LOGGER.isTraceEnabled()) {
LOGGER.trace("value {} is not assignable to this field", value, e);
}
return false;
}
}
}
|
