com.opsdatastore.annotation.CollectorExtension Maven / Gradle / Ivy
package com.opsdatastore.annotation;
/*-
* #%L
* OpsDataStore SDK
* %%
* Copyright (C) 2017 OpsDataStore
* %%
* 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.
* #L%
*/
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation indicating that the annotated class is an extension of the
* Collector interface and providing properties that need to be transmitted to
* the collector engine through the collector.conf file
* @author kguthrie
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface CollectorExtension {
/**
* Name of the identifier field. If blank, the name of the actual field
* will be used
* @return name set at compile time
*/
String name();
/**
* name of the organization or individual providing this collector
* @return name of the provider set at compile time
*/
String provider();
/**
* Description of the collector
* @return description set at compile time
*/
String description() default "";
/**
* Default number of seconds between collections. If not set or set to a
* value less than or equal to 0, then no default collector interval will be
* set
* @return the collection interval in seconds set at compile time
*/
int defaultCollectionIntervalSeconds() default 0;
}