ModuleOperations.java

/*
 * Copyright 2013 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.rest.client;

import java.io.IOException;
import java.io.InputStream;

import org.springframework.core.io.Resource;
import org.springframework.hateoas.PagedResources;
import org.springframework.xd.rest.domain.DetailedModuleDefinitionResource;
import org.springframework.xd.rest.domain.ModuleDefinitionResource;
import org.springframework.xd.rest.domain.RESTModuleType;

/**
 * Interface defining operations available against Module.
 * 
 * @author Glenn Renfro
 * @author Gunnar Hillert
 * @author Eric Bottard
 * 
 */
public interface ModuleOperations {

	/**
	 * Compose a new composed Module.
	 */
	public ModuleDefinitionResource composeModule(String name, String definition, boolean force);


	/**
	 * List modules known to the system.
	 */
	public PagedResources<ModuleDefinitionResource> list(RESTModuleType type);

	/**
	 * Request deletion of module with given name and type. Only composite modules, which are not currently in use can
	 * be deleted.
	 */
	public void deleteModule(String name, RESTModuleType moduleType);

	/**
	 * Retrieve information about a particular module.
	 */
	public DetailedModuleDefinitionResource info(String name, RESTModuleType type);

	/**
	 * Create a new module by uploading the contents of an archive.
	 */
	public ModuleDefinitionResource uploadModule(String name, RESTModuleType type, Resource bytes, boolean force) throws IOException;
}