com.centurylink.mdw.annotations.Monitor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mdw-common Show documentation

MDW is a microservices based workflow framework

There is a newer version: 6.1.39

/*
 * Copyright (C) 2018 CenturyLink, Inc.
 *
 * 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.
 */
package com.centurylink.mdw.annotations;

import java.lang.annotation.*;

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Monitor {

    /**
     * Value is the monitor label.
     */
    String value();

    /**
     * This represents the type of monitor to (optionally register).
     */
    Class category();

    /**
     * Recommended practice is to leave this set to false, and then enable
     * per activity in MDW Studio or MDWHub.  This way only designated activities
     * will trigger this monitor.  If defaultEnabled is set to true, this monitor
     * is enabled unless explicitly deselected in MDW Studio/Hub.
     */
    boolean defaultEnabled() default false;

    /**
     * Default value for user-entered options for this monitor.
     * The value entered in MDW Studio/Hub is available as the forth column in the
     * JSONArray value from attribute "monitors" in the runtimeContext.
     */
    String defaultOptions() default "";
}