org.openremote.manager.rules.RulesEngineId Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018, OpenRemote Inc.
 *
 * See the CONTRIBUTORS.txt file in the distribution for a
 * full listing of individual contributors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see .
 */
package org.openremote.manager.rules;

import org.openremote.model.rules.AssetRuleset;
import org.openremote.model.rules.GlobalRuleset;
import org.openremote.model.rules.RealmRuleset;
import org.openremote.model.rules.Ruleset;

import java.util.Objects;
import java.util.Optional;

/**
 * The scope of a {@link RulesEngine} and, optional, the realm or asset it belongs to.
 *
 * An engine in {@link org.openremote.model.rules.GlobalRuleset} scope has no {@link #realm}
 * or {@link #assetId}. An engine {@link RealmRuleset} scope has only
 * {@link #realm}. An engine in {@link org.openremote.model.rules.AssetRuleset} scope has both.
 */
public class RulesEngineId {

    final protected Class scope;
    final protected String realm;
    final protected String assetId;

    @SuppressWarnings("unchecked")
    public RulesEngineId() {
        this((Class) GlobalRuleset.class, null, null);
    }

    @SuppressWarnings("unchecked")
    public RulesEngineId(String realm) {
        this((Class) RealmRuleset.class, realm, null);
    }

    @SuppressWarnings("unchecked")
    public RulesEngineId(String realm, String assetId) {
        this((Class) AssetRuleset.class, realm, assetId);
    }

    protected RulesEngineId(Class scope, String realm, String assetId) {
        this.scope = scope;
        this.realm = realm;
        this.assetId = assetId;
    }

    public Class getScope() {
        return scope;
    }

    public Optional getRealm() {
        return Optional.ofNullable(realm);
    }

    public Optional getAssetId() {
        return Optional.ofNullable(assetId);
    }

    public Optional getId() {
        return scope == RealmRuleset.class ? getRealm() : scope == AssetRuleset.class ? getAssetId() : Optional.empty();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        RulesEngineId that = (RulesEngineId) o;
        return scope == that.scope &&
            Objects.equals(realm, that.realm) &&
            Objects.equals(assetId, that.assetId);
    }

    @Override
    public int hashCode() {

        return Objects.hash(scope, realm, assetId);
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "{" +
            "scope=" + scope.getSimpleName() +
            ", realm='" + realm + '\'' +
            ", assetId='" + assetId + '\'' +
            '}';
    }
}