com.byteplus.service.IBaseService Maven / Gradle / Ivy
package com.byteplus.service;
import com.byteplus.model.response.RawResponse;
import com.byteplus.model.sts2.Policy;
import com.byteplus.model.sts2.SecurityToken2;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import java.util.List;
import java.util.Map;
/**
* The interface Service.
*/
public interface IBaseService {
/**
* Sets client no reuse.
*/
void setClientNoReuse();
/**
* Gets access key.
*
* @return the access key
*/
String getAccessKey();
/**
* Sets access key.
*
* @param accessKey the access key
*/
void setAccessKey(String accessKey);
/**
* Gets secret key.
*
* @return the secret key
*/
String getSecretKey();
/**
* Sets secret key.
*
* @param secretKey the secret key
*/
void setSecretKey(String secretKey);
/**
* Sets region.
*
* @param region the region
*/
void setRegion(String region);
/**
* Gets region.
*
* @return the region
*/
String getRegion();
/**
* Sets host.
*
* @param host the host
*/
void setHost(String host);
/**
* Sets scheme.
*
* @param scheme the scheme
*/
void setScheme(String scheme);
/**
* Sets http client.
*
* @param httpClient the http client
*/
void setHttpClient(HttpClient httpClient);
/**
* Sets service info.
*
* @param serviceInfo the service info
*/
void setServiceInfo(com.byteplus.model.ServiceInfo serviceInfo);
/**
* Sets socket timeout.
*
* @param socketTimeout the socket timeout
*/
void setSocketTimeout(int socketTimeout);
/**
* Sets connection timeout.
*
* @param connectionTimeout the connection timeout
*/
void setConnectionTimeout(int connectionTimeout);
/**
* Query raw response.
*
* @param api the api
* @param params the params
* @return the raw response
* @throws Exception the exception
*/
RawResponse query(String api, List params) throws Exception;
/**
* Gets sign url.
*
* @param api the api
* @param params the params
* @return the sign url
* @throws Exception the exception
*/
String getSignUrl(String api, List params) throws Exception;
/**
* Json raw response.
*
* @param api the api
* @param params the params
* @param body the body
* @return the raw response
* @throws Exception the exception
*/
RawResponse json(String api, List params, String body) throws Exception;
/**
* Post raw response.
*
* @param api the api
* @param params the params
* @param form the form
* @return the raw response
* @throws Exception the exception
*/
RawResponse post(String api, List params, List form) throws Exception;
/**
* Put boolean.
*
* @param url the url
* @param filePath the file path
* @param headers the headers
* @return the boolean
* @throws Exception the exception
*/
boolean put(String url, String filePath, Map headers) throws Exception;
/**
* Put binary data.
*
* @param url target url
* @param data binary data
* @param headers http headers
* @return put status
* @throws Exception exception
*/
boolean putData(String url, byte[] data, Map headers) throws Exception;
/**
* Sign by sts2.
* @param inlinePolicy the Policy
* @param expire expire time
* @return the sts2
* @throws Exception the exception
*/
SecurityToken2 signSts2(Policy inlinePolicy, long expire) throws Exception;
/**
* Free monitor thread
*/
void destroy();
}