aboutsummaryrefslogtreecommitdiffstats
path: root/core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/MessageHolder.java
blob: e5c5aaee55863201b48a796c3c29984132802955 (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*-
 * ============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.core.infrastructure.messaging;

import java.io.Serializable;
import java.net.InetAddress;
import java.util.ArrayList;
import java.util.List;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * The Class MessageHolder holds a set of messages to be sent as a single block of messages in this messaging
 * implementation.
 *
 * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
 * @param <M> the generic type of message being handled by a message holder instance
 */
public class MessageHolder<M> implements Serializable {
    private static final int HASH_PRIME = 31;
    private static final int FOUR_BYTES = 32;

    // Serial ID
    private static final long serialVersionUID = 1235487535388793719L;

    // Get a reference to the logger
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(MessageHolder.class);

    // Properties of the message holder
    private final long creationTime;
    private final InetAddress senderHostAddress;

    // Sequence of message in the message holder
    private final List<M> messages;

    /**
     * Constructor, create the message holder.
     *
     * @param senderHostAddress the host address of the sender of the message holder container
     */
    public MessageHolder(final InetAddress senderHostAddress) {
        LOGGER.entry(senderHostAddress);
        messages = new ArrayList<>();
        this.senderHostAddress = senderHostAddress;
        creationTime = System.currentTimeMillis();
    }

    /**
     * Return the messages in this message holder.
     *
     * @return the messages
     */
    public List<M> getMessages() {
        return messages;
    }

    /**
     * Adds a message to this message holder.
     *
     * @param message the message to add
     */
    public void addMessage(final M message) {
        if (!messages.contains(message)) {
            messages.add(message);
        } else {
            LOGGER.warn("duplicate message {} added to message holder", message);
        }
    }

    /**
     * Gets the creation time.
     *
     * @return the creation time
     */
    public long getCreationTime() {
        return creationTime;
    }

    /**
     * Gets the sender host address.
     *
     * @return the sender host address
     */
    public InetAddress getSenderHostAddress() {
        return senderHostAddress;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public String toString() {
        return "ApexCommandProtocol [creationTime=" + creationTime + ", senderHostAddress=" + senderHostAddress + "]";
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public int hashCode() {
        final int prime = HASH_PRIME;
        int result = 1;
        result = prime * result + ((senderHostAddress == null) ? 0 : senderHostAddress.hashCode());
        result = prime * result + ((messages == null) ? 0 : messages.hashCode());
        result = prime * result + (int) (creationTime ^ (creationTime >>> FOUR_BYTES));
        return result;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final MessageHolder<?> other = (MessageHolder<?>) obj;
        if (senderHostAddress == null) {
            if (other.senderHostAddress != null) {
                return false;
            }
        } else if (!senderHostAddress.equals(other.senderHostAddress)) {
            return false;
        }
        if (messages == null) {
            if (other.messages != null) {
                return false;
            }
        } else if (!messages.equals(other.messages)) {
            return false;
        }
        return creationTime == other.creationTime;
    }
}