com.bluenimble.platform.api.ApiResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluenimble-jvm-sdk Show documentation

BlueNimble Serverless SDK

There is a newer version: 2.50.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.bluenimble.platform.api;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Date;
import java.util.List;

import com.bluenimble.platform.json.JsonObject;
import com.bluenimble.platform.streams.Chunk;
import com.bluenimble.platform.streams.StreamDecorator;

public interface ApiResource extends Serializable {

	interface Selector {
		boolean select (String name, boolean isFolder);
	}
	
	String 				owner 			();

	String 				name 			();
	String 				path 			();
	Date 				timestamp 		();
	String 				contentType 	();
	long 				length 			();

	void 				pipe 			(OutputStream out, 	long position, long count) 	throws IOException;
	void 				pipe 			(InputStream in, 	long position, long count) 	throws IOException;
	void 				pipe 			(OutputStream out, StreamDecorator decorator, Chunk... chunks) 			
																						throws IOException;
	InputStream 		toInput 		() 												throws IOException;
	
	ApiStreamSource 	toStreamSource 	();
	
	Object				template		(JsonObject data, boolean withScripting) throws IOException;

	String 				extension 		();
	List 	children 		(Selector selector);
	
}