BusCleaner.java

/*
 * Copyright 2015 the original author or authors.
 *
 * 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 org.springframework.xd.dirt.integration.bus;

import java.util.List;
import java.util.Map;


/**
 * Interface for implementations that perform cleanup for message buses.
 *
 * @author Gary Russell
 * @since 1.2
 */
public interface BusCleaner {

	/**
	 * Clean up all resources for the supplied stream/job.
	 * @param entity the stream or job; may be terminated with a simple wild card '*', in which
	 * case all streams with names starting with the characters before the '*' will be cleaned.
	 * @param isJob true if the entity is a job.
	 * @return a map of lists of resources removed.
	 */
	Map<String, List<String>> clean(String entity, boolean isJob);

}