tcbot-engine/src/main/java/org/apache/ignite/tcbot/engine/conf/INotificationChannel.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.ignite.tcbot.engine.conf;

import javax.annotation.Nullable;

/**
 *
 */
public interface INotificationChannel {
    /**
     * Subscribed to new failures in a branch.
     *
     * @param trackedBranchId Tracked branch id.
     */
    public boolean isSubscribedToBranch(String trackedBranchId);

    /**
     * Checks if server related issue can be used for notification. For users it is determined by credentials.
     *
     * @param srvCode Server code.
     */
    public boolean isServerAllowed(String srvCode);

    /**
     * @param tag Tag from actual build/issue.
     */
    public boolean isSubscribedToTag(@Nullable String tag);

    /**
     * Returns email address.
     */
    @Nullable
    public String email();

    /**
     * Slack channel (started from #) or user.
     */
    @Nullable
    public String slack();

    /**
     * @return any tags specified for this channel, filtration should be applied.
     */
    public boolean hasTagFilter();

}