path: root/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaTrigger.java

/*-
 * ============LICENSE_START=======================================================
 * ONAP Policy Model
 * ================================================================================
 * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2019-2021 Nordix Foundation.
 * Modifications Copyright (C) 2022 Bell Canada. 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.models.tosca.simple.concepts;

import com.google.gson.annotations.SerializedName;
import java.time.Duration;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.EmbeddedId;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.apache.commons.lang3.ObjectUtils;
import org.onap.policy.common.parameters.annotations.Min;
import org.onap.policy.common.parameters.annotations.NotBlank;
import org.onap.policy.common.parameters.annotations.NotNull;
import org.onap.policy.common.parameters.annotations.Valid;
import org.onap.policy.models.base.PfConcept;
import org.onap.policy.models.base.PfKey;
import org.onap.policy.models.base.PfReferenceKey;
import org.onap.policy.models.base.validation.annotations.VerifyKey;

/**
 * Class to represent the trigger of policy type in TOSCA definition.
 *
 * @author Chenfei Gao (cgao@research.att.com)
 * @author Liam Fallon (liam.fallon@est.tech)
 */
@Data
@EqualsAndHashCode(callSuper = false)
public class JpaToscaTrigger extends PfConcept {
    private static final long serialVersionUID = -6515211640208986971L;

    @EmbeddedId
    @VerifyKey
    @NotNull
    private PfReferenceKey key;

    @Column
    @NotBlank
    private String description;

    @Column
    @SerializedName("event_type")
    @NotNull
    @NotBlank
    private String eventType;

    @Column
    @SerializedName("schedule")
    @Valid
    private JpaToscaTimeInterval schedule;

    @Column
    @SerializedName("target_filter")
    @Valid
    private JpaToscaEventFilter targetFilter;

    @Column(name = "toscaCondition")
    @Valid
    private JpaToscaConstraint condition;

    @Column(name = "toscaConstraint")
    @Valid
    private JpaToscaConstraint constraint;

    @Column
    @SerializedName("period")
    private Duration period;

    @Column
    @Min(0)
    private int evaluations = 0;

    @Column
    @NotBlank
    private String method;

    @Column
    @NotNull
    @NotBlank
    private String action;

    /**
     * The Default Constructor creates a {@link JpaToscaTrigger} object with a null key.
     */
    public JpaToscaTrigger() {
        this(new PfReferenceKey());
    }

    /**
     * The Key Constructor creates a {@link JpaToscaTrigger} object with the given concept key.
     *
     * @param key the key
     */
    public JpaToscaTrigger(@NonNull final PfReferenceKey key) {
        this(key, "", "");
    }

    /**
     * The full Constructor creates a {@link JpaToscaTrigger} object with all mandatory objects.
     *
     * @param key the key
     * @param eventType the event type
     * @param action the trigger action
     */
    public JpaToscaTrigger(@NonNull final PfReferenceKey key, @NonNull final String eventType,
            @NonNull final String action) {
        this.key = key;
        this.eventType = eventType;
        this.action = action;
    }

    /**
     * Copy constructor.
     *
     * @param copyConcept the concept to copy from
     */
    public JpaToscaTrigger(final JpaToscaTrigger copyConcept) {
        super(copyConcept);
        this.key = new PfReferenceKey(copyConcept.key);
        this.description = copyConcept.description;
        this.eventType = copyConcept.eventType;
        this.schedule = (copyConcept.schedule != null ? new JpaToscaTimeInterval(copyConcept.schedule) : null);
        this.targetFilter =
                (copyConcept.targetFilter != null ? new JpaToscaEventFilter(copyConcept.targetFilter) : null);
        this.condition = copyConcept.condition;
        this.constraint = copyConcept.constraint;
        this.period = copyConcept.period;
        this.evaluations = copyConcept.evaluations;
        this.method = copyConcept.method;
        this.action = copyConcept.action;
    }

    @Override
    public List<PfKey> getKeys() {
        final List<PfKey> keyList = getKey().getKeys();
        if (schedule != null) {
            keyList.addAll(schedule.getKeys());
        }
        if (targetFilter != null) {
            keyList.addAll(targetFilter.getKeys());
        }
        return keyList;
    }

    @Override
    public void clean() {
        key.clean();

        description = (description != null ? description.trim() : description);
        eventType = eventType.trim();

        if (schedule != null) {
            schedule.clean();
        }
        if (targetFilter != null) {
            targetFilter.clean();
        }

        method = (method != null ? method.trim() : method);
        action = action.trim();
    }

    @Override
    public int compareTo(final PfConcept otherConcept) {
        if (otherConcept == null) {
            return -1;
        }
        if (this == otherConcept) {
            return 0;
        }
        if (getClass() != otherConcept.getClass()) {
            return getClass().getName().compareTo(otherConcept.getClass().getName());
        }

        final JpaToscaTrigger other = (JpaToscaTrigger) otherConcept;
        int result = key.compareTo(other.key);
        if (result != 0) {
            return result;
        }

        return compareFields(other);
    }

    /**
     * Compare the fields of this ToscaTrigger object with the fields of the other ToscaProperty object.
     *
     * @param other the other ToscaTrigger object
     */
    private int compareFields(final JpaToscaTrigger other) {
        int result = ObjectUtils.compare(description, other.description);
        if (result != 0) {
            return result;
        }

        result = ObjectUtils.compare(eventType, other.eventType);
        if (result != 0) {
            return result;
        }

        result = ObjectUtils.compare(schedule, other.schedule);
        if (result != 0) {
            return result;
        }

        result = ObjectUtils.compare(targetFilter, other.targetFilter);
        if (result != 0) {
            return result;
        }

        result = ObjectUtils.compare(condition, other.condition);
        if (result != 0) {
            return result;
        }

        result = ObjectUtils.compare(constraint, other.constraint);
        if (result != 0) {
            return result;
        }

        result = ObjectUtils.compare(period, other.period);
        if (result != 0) {
            return result;
        }

        if (evaluations != other.evaluations) {
            return evaluations - other.evaluations;
        }

        result = ObjectUtils.compare(method, other.method);
        if (result != 0) {
            return result;
        }

        return ObjectUtils.compare(action, other.action);
    }
}