com.opsdatastore.collector.CollectorSink Maven / Gradle / Ivy
package com.opsdatastore.collector;
/*-
* #%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%
*/
/**
* Interface defining a class that accepts collected objects for transmission to
* the collector
* @author kguthrie
*/
public interface CollectorSink {
/**
* Enumeration of operations that can be performed on a given collected
* object
*/
public static enum Operation {
Update
, Delete
}
/**
* This method must be implemented to instruct the sink what to do with
* operation and object pairs
* @param obj object to be added
* @param operation operation to be performed on that object
*/
void sendToSink(CollectedObject obj, Operation operation);
/**
* Update the given object
* @param obj
*/
default void sendUpdate(CollectedObject obj) {
sendToSink(obj, CollectorSink.Operation.Update);
}
/**
* Delete the given object
* @param obj
*/
default void sendDelete(CollectedObject obj) {
sendToSink(obj, CollectorSink.Operation.Delete);
}
}