blob: 98865cd88ef266b09d2059d75e5191e62071b91a (
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
|
/*-
* ============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.context.parameters;
import org.onap.policy.common.parameters.ParameterGroupImpl;
import org.onap.policy.common.parameters.annotations.ClassName;
import org.onap.policy.common.parameters.annotations.NotNull;
/**
* A persistor parameter class that may be specialized by context persistor plugins that require
* plugin specific parameters.
*
* <p>The following parameters are defined:
* <ol>
* <li>pluginClass: the persistor plugin as the JVM local dummy ephemeral persistor
* <li>flushPeriod: Context is flushed to any persistor plugin that is defined periodically, and the
* period for flushing is the flush period.
* </ol>
*
* @author Liam Fallon (liam.fallon@ericsson.com)
*/
@NotNull
public class PersistorParameters extends ParameterGroupImpl {
/** The default persistor is a dummy persistor that stubs the Persistor interface. */
public static final String DEFAULT_PERSISTOR_PLUGIN_CLASS =
"org.onap.policy.apex.context.impl.persistence.ephemeral.EphemeralPersistor";
/** Default periodic flushing interval, 5 minutes in milliseconds. */
public static final long DEFAULT_FLUSH_PERIOD = 300000;
private @ClassName String pluginClass = DEFAULT_PERSISTOR_PLUGIN_CLASS;
// Parameters for flushing
private long flushPeriod = DEFAULT_FLUSH_PERIOD;
/**
* Constructor to create a persistor parameters instance and register the instance with the
* parameter service.
*/
public PersistorParameters() {
super(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
}
/**
* Gets the plugin class.
*
* @return the plugin class
*/
public String getPluginClass() {
return pluginClass;
}
/**
* Sets the plugin class.
*
* @param pluginClass the plugin class
*/
public void setPluginClass(final String pluginClass) {
this.pluginClass = pluginClass;
}
/**
* Gets the flush period in milliseconds.
*
* @return the flush period
*/
public long getFlushPeriod() {
return flushPeriod;
}
/**
* Sets the flush period in milliseconds.
*
* @param flushPeriod the flush period
*/
public void setFlushPeriod(final long flushPeriod) {
if (flushPeriod <= 0) {
this.flushPeriod = DEFAULT_FLUSH_PERIOD;
} else {
this.flushPeriod = flushPeriod;
}
}
@Override
public String toString() {
return "PersistorParameters [name=" + getName() + ", pluginClass=" + pluginClass + ", flushPeriod="
+ flushPeriod + "]";
}
}
|
