aboutsummaryrefslogtreecommitdiffstats
path: root/examples/examples-aadm/src/main/java/org/onap/policy/apex/examples/aadm/concepts/ImsiStatus.java
blob: 4b7def09746a3510934d17323d1ee254902030b4 (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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*-
 * ============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.examples.aadm.concepts;

import java.io.Serializable;

/**
 * The Class IMSIStatus holds the status of an IMSI in the AADM domain.
 */
public class ImsiStatus implements Serializable {
    private static final long serialVersionUID = 2852523814242234172L;

    private static final long TIME_NOT_SET = 0;

    private final String imsi;

    private boolean anomalous = false;
    private long anomalousTime = TIME_NOT_SET;
    private String enodeBId;
    private long blackListedTime = TIME_NOT_SET;
    private long blockingCount = 0;

    /**
     * Initiate an IMSI status instance with an IMSI value.
     *
     * @param imsi the IMSI value
     */
    public ImsiStatus(final String imsi) {
        this.imsi = imsi;
    }

    /**
     * Gets the IMSI value.
     *
     * @return the IMSI value
     */
    public String getImsi() {
        return imsi;
    }

    /**
     * Gets the anomalous flag.
     *
     * @return the anomalous flag
     */
    public boolean getAnomalous() {
        return anomalous;
    }

    /**
     * Sets the anomalous flag.
     *
     * @param anomalous the anomalous flag
     */
    public void setAnomalous(final boolean anomalous) {
        this.anomalous = anomalous;
    }

    /**
     * Gets the time of the most recent anomolous event.
     *
     * @return the time of the most recent anomolous event
     */
    public long getAnomolousTime() {
        return anomalousTime;
    }

    /**
     * Sets the time of the most recent anomolous event.
     *
     * @param incomingAnomalousTime the time of the most recent anomolous event
     */
    public void setAnomolousTime(final long incomingAnomalousTime) {
        this.anomalousTime = incomingAnomalousTime;
    }

    /**
     * Gets the eNodeB ID to which the IMSI is attached.
     *
     * @return theeNodeB ID to which the IMSI is attached
     */
    public String getENodeBId() {
        return enodeBId;
    }

    /**
     * Sets the eNodeB ID to which the IMSI is attached.
     *
     * @param incomingENodeBId the eNodeB ID to which the IMSI is attached
     */
    public void setENodeBId(final String incomingENodeBId) {
        this.enodeBId = incomingENodeBId;
    }

    /**
     * Checks if the eNodeB ID to which the IMSI is attached is set.
     *
     * @return true, if eNodeB ID to which the IMSI is attached is set
     */
    public boolean checkSetENodeBId() {
        return (enodeBId != null);
    }

    /**
     * Gets the time at which the IMSI was blacklisted.
     *
     * @return the time at which the IMSI was blacklisted
     */
    public long getBlacklistedTime() {
        return blackListedTime;
    }

    /**
     * Sets the time at which the IMSI was blacklisted.
     *
     * @param incomingBlackListedTime the time at which the IMSI was blacklisted
     */
    public void setBlacklistedTime(final long incomingBlackListedTime) {
        this.blackListedTime = incomingBlackListedTime;
    }

    /**
     * Gets the number of times this IMSI was blocked.
     *
     * @return the number of times this IMSI was blocked
     */
    public long getBlockingCount() {
        return blockingCount;
    }

    /**
     * Sets the number of times this IMSI was blocked.
     *
     * @param blockingCount the number of times this IMSI was blocked
     */
    public void setBlockingCount(final long blockingCount) {
        this.blockingCount = blockingCount;
    }

    /**
     * Increment the number of times this IMSI was blocked.
     *
     * @return the incremented number of times this IMSI was blocked
     */
    public long incrementBlockingCount() {
        return ++blockingCount;
    }

    /**
     * Decrement the number of times this IMSI was blocked.
     *
     * @return the decremented number of times this IMSI was blocked
     */
    public long decrementBlockingCount() {
        return --blockingCount;
    }
}