package cn.jpush.api.device;
|
|
import java.lang.reflect.Type;
|
import java.util.Map;
|
import java.util.Set;
|
|
import com.google.gson.Gson;
|
import com.google.gson.JsonArray;
|
import com.google.gson.JsonObject;
|
import com.google.gson.JsonPrimitive;
|
import com.google.gson.reflect.TypeToken;
|
|
import cn.jiguang.common.ClientConfig;
|
import cn.jiguang.common.ServiceHelper;
|
import cn.jiguang.common.utils.Preconditions;
|
import cn.jiguang.common.utils.StringUtils;
|
import cn.jiguang.common.connection.HttpProxy;
|
import cn.jiguang.common.connection.NativeHttpClient;
|
import cn.jiguang.common.resp.APIConnectionException;
|
import cn.jiguang.common.resp.APIRequestException;
|
import cn.jiguang.common.resp.BaseResult;
|
import cn.jiguang.common.resp.BooleanResult;
|
import cn.jiguang.common.resp.DefaultResult;
|
import cn.jiguang.common.resp.ResponseWrapper;
|
|
public class DeviceClient {
|
|
private final NativeHttpClient _httpClient;
|
private String hostName;
|
private String devicesPath;
|
private String tagsPath;
|
private String aliasesPath;
|
|
public DeviceClient(String masterSecret, String appKey) {
|
this(masterSecret, appKey, null, ClientConfig.getInstance());
|
}
|
|
/**
|
* This will be removed in the future. Please use ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setMaxRetryTimes} instead of this constructor.
|
* @param masterSecret API access secret of the appKey.
|
* @param appKey The KEY of one application on JPush.
|
* @param maxRetryTimes The max retry times.
|
*
|
*/
|
@Deprecated
|
public DeviceClient(String masterSecret, String appKey, int maxRetryTimes) {
|
this(masterSecret, appKey, maxRetryTimes, null);
|
}
|
|
/**
|
* This will be removed in the future. Please use ClientConfig{jiguang-common cn.jiguang.common.ClientConfig#setMaxRetryTimes} instead of this constructor.
|
* @param masterSecret API access secret of the appKey.
|
* @param appKey The KEY of one application on JPush.
|
* @param maxRetryTimes The max retry times.
|
* @param proxy The HTTP proxy.
|
*
|
*/
|
@Deprecated
|
public DeviceClient(String masterSecret, String appKey, int maxRetryTimes, HttpProxy proxy) {
|
ClientConfig conf = ClientConfig.getInstance();
|
conf.setMaxRetryTimes(maxRetryTimes);
|
ServiceHelper.checkBasic(appKey, masterSecret);
|
|
hostName = (String) conf.get(ClientConfig.DEVICE_HOST_NAME);
|
devicesPath = (String) conf.get(ClientConfig.DEVICES_PATH);
|
tagsPath = (String) conf.get(ClientConfig.TAGS_PATH);
|
aliasesPath = (String) conf.get(ClientConfig.ALIASES_PATH);
|
|
String authCode = ServiceHelper.getBasicAuthorization(appKey, masterSecret);
|
_httpClient = new NativeHttpClient(authCode, proxy, conf);
|
|
}
|
|
/**
|
* Create a Device Client by client configuration.
|
*
|
* @param masterSecret API access secret of the appKey.
|
* @param appKey The KEY of one application on JPush.
|
* @param proxy The proxy, if there is no proxy, should be null.
|
* @param conf The client configuration. Can use ClientConfig.getInstance() as default.
|
*/
|
public DeviceClient(String masterSecret, String appKey, HttpProxy proxy, ClientConfig conf) {
|
ServiceHelper.checkBasic(appKey, masterSecret);
|
|
hostName = (String) conf.get(ClientConfig.DEVICE_HOST_NAME);
|
devicesPath = (String) conf.get(ClientConfig.DEVICES_PATH);
|
tagsPath = (String) conf.get(ClientConfig.TAGS_PATH);
|
aliasesPath = (String) conf.get(ClientConfig.ALIASES_PATH);
|
|
String authCode = ServiceHelper.getBasicAuthorization(appKey, masterSecret);
|
_httpClient = new NativeHttpClient(authCode, proxy, conf);
|
}
|
|
// -------------- device
|
|
public TagAliasResult getDeviceTagAlias(String registrationId) throws APIConnectionException, APIRequestException {
|
String url = hostName + devicesPath + "/" + registrationId;
|
|
ResponseWrapper response = _httpClient.sendGet(url);
|
|
return BaseResult.fromResponse(response, TagAliasResult.class);
|
}
|
|
public DefaultResult updateDeviceTagAlias(String registrationId, boolean clearAlias, boolean clearTag) throws APIConnectionException, APIRequestException {
|
Preconditions.checkArgument(clearAlias || clearTag, "It is not meaningful to do nothing.");
|
|
String url = hostName + devicesPath + "/" + registrationId;
|
|
JsonObject top = new JsonObject();
|
if (clearAlias) {
|
top.addProperty("alias", "");
|
}
|
if (clearTag) {
|
top.addProperty("tags", "");
|
}
|
|
ResponseWrapper response = _httpClient.sendPost(url, top.toString());
|
|
return DefaultResult.fromResponse(response);
|
}
|
|
public DefaultResult updateDeviceTagAlias(String registrationId, String alias,
|
Set<String> tagsToAdd, Set<String> tagsToRemove) throws APIConnectionException, APIRequestException {
|
String url = hostName + devicesPath + "/" + registrationId;
|
|
JsonObject top = new JsonObject();
|
if (null != alias) {
|
top.addProperty("alias", alias);
|
}
|
|
JsonObject tagObject = new JsonObject();
|
JsonArray tagsAdd = ServiceHelper.fromSet(tagsToAdd);
|
if (tagsAdd.size() > 0) {
|
tagObject.add("add", tagsAdd);
|
}
|
|
JsonArray tagsRemove = ServiceHelper.fromSet(tagsToRemove);
|
if (tagsRemove.size() > 0) {
|
tagObject.add("remove", tagsRemove);
|
}
|
|
if (tagObject.entrySet().size() > 0) {
|
top.add("tags", tagObject);
|
}
|
|
ResponseWrapper response = _httpClient.sendPost(url, top.toString());
|
|
return DefaultResult.fromResponse(response);
|
}
|
|
public DefaultResult bindMobile(String registrationId, String mobile)
|
throws APIConnectionException, APIRequestException {
|
if ( StringUtils.isEmpty(mobile) ) {
|
// delete bind while mobile is empty.
|
mobile = "";
|
} else {
|
// Preconditions.checkArgument(StringUtils.isMobileNumber(mobile), "The mobile format is incorrect. " + mobile);
|
}
|
|
String url = hostName + devicesPath + "/" + registrationId;
|
JsonObject top = new JsonObject();
|
top.addProperty("mobile", mobile);
|
ResponseWrapper response = _httpClient.sendPost(url, top.toString());
|
return DefaultResult.fromResponse(response);
|
}
|
|
// ------------- tags
|
|
public TagListResult getTagList() throws APIConnectionException, APIRequestException {
|
String url = hostName + tagsPath + "/";
|
|
ResponseWrapper response = _httpClient.sendGet(url);
|
|
return TagListResult.fromResponse(response, TagListResult.class);
|
}
|
|
public BooleanResult isDeviceInTag(String theTag, String registrationID) throws APIConnectionException, APIRequestException {
|
String url = hostName + tagsPath + "/" + theTag + "/registration_ids/" + registrationID;
|
ResponseWrapper response = _httpClient.sendGet(url);
|
|
return BaseResult.fromResponse(response, BooleanResult.class);
|
}
|
|
public DefaultResult addRemoveDevicesFromTag(String theTag, Set<String> toAddUsers, Set<String> toRemoveUsers) throws APIConnectionException, APIRequestException {
|
String url = hostName + tagsPath + "/" + theTag;
|
|
JsonObject top = new JsonObject();
|
JsonObject registrationIds = new JsonObject();
|
|
if (null != toAddUsers && toAddUsers.size() > 0) {
|
JsonArray array = new JsonArray();
|
for (String user : toAddUsers) {
|
array.add(new JsonPrimitive(user));
|
}
|
registrationIds.add("add", array);
|
}
|
if (null != toRemoveUsers && toRemoveUsers.size() > 0) {
|
JsonArray array = new JsonArray();
|
for (String user : toRemoveUsers) {
|
array.add(new JsonPrimitive(user));
|
}
|
registrationIds.add("remove", array);
|
}
|
|
top.add("registration_ids", registrationIds);
|
|
ResponseWrapper response = _httpClient.sendPost(url, top.toString());
|
|
return DefaultResult.fromResponse(response);
|
}
|
|
public DefaultResult deleteTag(String theTag, String platform) throws APIConnectionException, APIRequestException {
|
String url = hostName + tagsPath + "/" + theTag;
|
if (null != platform) {
|
url += "?platform=" + platform;
|
}
|
|
ResponseWrapper response = _httpClient.sendDelete(url);
|
|
return DefaultResult.fromResponse(response);
|
}
|
|
|
// ------------- alias
|
|
public AliasDeviceListResult getAliasDeviceList(String alias, String platform) throws APIConnectionException, APIRequestException {
|
String url = hostName + aliasesPath + "/" + alias;
|
if (null != platform) {
|
url += "?platform=" + platform;
|
}
|
|
ResponseWrapper response = _httpClient.sendGet(url);
|
|
return BaseResult.fromResponse(response, AliasDeviceListResult.class);
|
}
|
|
public DefaultResult deleteAlias(String alias, String platform) throws APIConnectionException, APIRequestException {
|
String url = hostName + aliasesPath + "/" + alias;
|
if (null != platform) {
|
url += "?platform=" + platform;
|
}
|
|
ResponseWrapper response = _httpClient.sendDelete(url);
|
|
return DefaultResult.fromResponse(response);
|
}
|
|
public DefaultResult removeDevicesFromAlias(String alias, Set<String> toRemoveDevice) throws APIConnectionException, APIRequestException {
|
String url = hostName + aliasesPath + "/" + alias;
|
|
JsonObject top = new JsonObject();
|
JsonObject registrationIds = new JsonObject();
|
|
if (null != toRemoveDevice && toRemoveDevice.size() > 0) {
|
JsonArray array = new JsonArray();
|
for (String device : toRemoveDevice) {
|
array.add(new JsonPrimitive(device));
|
}
|
registrationIds.add("remove", array);
|
}
|
|
top.add("registration_ids", registrationIds);
|
|
ResponseWrapper response = _httpClient.sendPost(url, top.toString());
|
|
return DefaultResult.fromResponse(response);
|
}
|
|
// -------------- devices status
|
|
public Map<String, OnlineStatus> getUserOnlineStatus(String... registrationIds)
|
throws APIConnectionException, APIRequestException
|
{
|
Preconditions.checkArgument((null != registrationIds ),
|
"The registration id list should not be null.");
|
Preconditions.checkArgument(registrationIds.length > 0 && registrationIds.length <= 1000,
|
"The length of registration id list should between 1 and 1000.");
|
|
String url = hostName + devicesPath + "/status";
|
JsonObject json = new JsonObject();
|
JsonArray array = new JsonArray();
|
for(int i = 0; i < registrationIds.length; i++) {
|
array.add(new JsonPrimitive(registrationIds[i]));
|
}
|
json.add("registration_ids", array);
|
Type type = new TypeToken<Map<String, OnlineStatus>>(){}.getType();
|
ResponseWrapper response = _httpClient.sendPost(url, json.toString());
|
Map<String, OnlineStatus> map = new Gson().fromJson(response.responseContent, type);
|
return map;
|
}
|
|
}
|
