aboutsummaryrefslogtreecommitdiffstats
path: root/feature-pooling-dmaap/src/main/java/org/onap/policy/drools/pooling/message/Message.java
blob: e8a4671d8542efbaf6805695be2a10a12d254e0b (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
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2018 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.drools.pooling.message;

import org.onap.policy.drools.pooling.PoolingFeatureException;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

/**
 * Messages sent on the internal topic.
 */
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({@Type(value = Forward.class, name = "forward"), @Type(value = Heartbeat.class, name = "heartbeat"),
                @Type(value = Identification.class, name = "identification"),
                @Type(value = Leader.class, name = "leader"), @Type(value = Offline.class, name = "offline"),
                @Type(value = Query.class, name = "query")})
public class Message {

    /**
     * Name of the administrative channel.
     */
    public static final String ADMIN = "_admin";

    /**
     * Host that originated the message.
     */
    private String source;

    /**
     * Channel on which the message is routed, which is either the target host
     * or {@link #ADMIN}.
     */
    private String channel;

    /**
     * 
     */
    public Message() {
        super();
    }

    /**
     * 
     * @param source host on which the message originated
     */
    public Message(String source) {
        this.source = source;
    }

    public String getSource() {
        return source;
    }

    public void setSource(String source) {
        this.source = source;
    }

    public String getChannel() {
        return channel;
    }

    public void setChannel(String channel) {
        this.channel = channel;
    }

    /**
     * Checks the validity of the message, including verifying that required
     * fields are not missing.
     * 
     * @throws PoolingFeatureException if the message is invalid
     */
    @JsonIgnore
    public void checkValidity() throws PoolingFeatureException {
        if (source == null || source.isEmpty()) {
            throw new PoolingFeatureException("missing message source");
        }

        if (channel == null || channel.isEmpty()) {
            throw new PoolingFeatureException("missing message channel");
        }
    }

}