blob: aa288f7d6377a7db0b9278f5926797108113cd14 (
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
|
/*
* ============LICENSE_START=======================================================
* ONAP PAP
* ================================================================================
* Copyright (C) 2019 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.pap.main.comm.msgdata;
import org.onap.policy.models.pdp.concepts.PdpMessage;
import org.onap.policy.models.pdp.concepts.PdpStatus;
import org.onap.policy.pap.main.comm.TimerManager;
/**
* Wraps a message, providing methods appropriate to the message type.
*/
public abstract class MessageData {
private final PdpMessage message;
private final int maxRetries;
private final TimerManager timers;
/**
* Constructs the object.
*
* @param message message to be wrapped by this
* @param maxRetries max number of retries
* @param timers the timer manager for messages of this type
*/
public MessageData(PdpMessage message, int maxRetries, TimerManager timers) {
this.message = message;
this.maxRetries = maxRetries;
this.timers = timers;
}
/**
* Gets the wrapped message.
*
* @return the wrapped message
*/
public PdpMessage getMessage() {
return message;
}
/**
* Gets a string, suitable for logging, identifying the message type.
*
* @return the message type
*/
public String getType() {
return message.getClass().getSimpleName();
}
/**
* Gets the maximum retry count for the particular message type.
*
* @return the maximum retry count
*/
public int getMaxRetryCount() {
return maxRetries;
}
/**
* Gets the timer manager for the particular message type.
*
* @return the timer manager
*/
public TimerManager getTimers() {
return timers;
}
/**
* Indicates that the response did not match what was expected.
*
* @param reason the reason for the mismatch
*/
public abstract void mismatch(String reason);
/**
* Indicates that processing of this particular message has completed successfully.
*/
public abstract void completed();
/**
* Checks the response to ensure it is as expected.
*
* @param response the response to check
* @return an error message, if a fatal error has occurred, {@code null} otherwise
*/
public abstract String checkResponse(PdpStatus response);
}
|
