com.baidubce.services.dumap

Class DuMapTraceClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.dumap.BaseDuMapClient

com.baidubce.services.dumap.DuMapTraceClient

public class DuMapTraceClient
extends BaseDuMapClient

DuMap trace client which provides the APIs related to trace services.

Author:

weizhijun

Nested Class Summary

Nested classes/interfaces inherited from class com.baidubce.services.dumap.BaseDuMapClient

BaseDuMapClient.BodyType

Field Summary

Fields inherited from class com.baidubce.AbstractBceClient

config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
DuMapTraceClient() Construct a dumap trace client with default configurations.
DuMapTraceClient(BceClientConfiguration configuration) Construct a dumap trace client with the specified configurations.

Method Summary

Modifier and Type	Method and Description
String	addEntity(String appId, AddEntityRequest request) Add a new entity, which represents a person, a car or any other object.
String	addMonitoredPerson(String appId, AddMonitoredPersonRequest request) Add some monitored entities to the specified trace service.
String	addPoint(String appId, AddPointRequest request) Upload a track point for an entity.
String	addPoint(String appId, AddPointsRequest request) Upload multiple tracks point of one entity or multiple entities at one time.
String	analyze(String appId, DrivingBehaviorAnalysisParam param) Analyzing the driving behavior of an entity.
String	analyze(String appId, StayPointAnalysisParam param) Analyzing the stay points of an entity in the specified time period.
String	cancelCallbackUrl(String appId, CancelCallbackUrlRequest request) Cancel the callback url setting of the specified trace service.
String	createExportJob(String appId, CreateJobRequest request) Create a new job to export all track data of the specified trace service over a period of time.
String	createFence(String appId, CreateCircleFenceRequest request) Create a circle fence.
String	createFence(String appId, CreateDistrictFenceRequest request) Create an administrative district fence.
String	createFence(String appId, CreatePolygonFenceRequest request) Create a polygonal fence.
String	createFence(String appId, CreatePolylineFenceRequest request) Create a linear fence.
String	deleteEntity(String appId, DeleteEntityRequest request) Delete some entity according to the entity name.
String	deleteExportJob(String appId, DeleteJobRequest request) Delete a track data exporting job of the specified service.
String	deleteFence(String appId, DeleteFenceRequest request) Deleting the specified fence according to the specified monitored entity or fence IDs.
String	deleteMonitoredPerson(String appId, DeleteMonitoredPersonRequest request) Delete some monitored entities of the specified fence.
String	getExportJob(String appId, GetJobParam param) Query the status of all track data exporting job of the specified service.
String	historyAlarm(String appId, BatchHistoryAlarmParam param) Query the historical alarm information of fences over the specified period of time.
String	historyAlarm(String appId, HistoryAlarmParam param) Query the historical alarm information of the specified entity.
String	listEntity(String appId, ListEntityParam param) List entities according to the conditions given in the filter.
String	listFence(String appId, ListFenceParam param) Query the list of fences of the specified trace service.
String	listMonitoredPerson(String appId, ListMonitoredPersonParam param) List all monitored entities of the specified fence.
String	queryCallbackUrl(String appId, QueryCallbackUrlParam param) Query the callback url of the specified trace service.
String	queryStatus(String appId, QueryStatusByLocationParam param) Query an entity in or out of the specified fences according the given location of the entity.
String	queryStatus(String appId, QueryStatusParam param) Query an entity in or out of the specified fences.
String	search(String appId, AroundSearchParam param) Search entities in the specified circle area.
String	search(String appId, BoundSearchParam param) Search entities in the specified rectangular area.
String	search(String appId, DistrictSearchParam param) Search entities in the specified administrative district.
String	search(String appId, KeywordSearchParam param) Search entities according to the specified keyword.
String	search(String appId, PolygonSearchParam param) Search entities in the specified polygonal area.
String	setCallbackUrl(String appId, SetCallbackUrlRequest request) Set callback url of the specified trace service.
String	track(String appId, GetDistanceParam param) Query the mileage over a period of time of an entity.
String	track(String appId, GetLatestPointParam param) Query the latest track point of an entity, which supports real-time correction.
String	track(String appId, GetTrackParam param) Query track information of an entity.
String	updateEntity(String appId, UpdateEntityRequest request) Update description of some entity.
String	updateFence(String appId, UpdateCircleFenceRequest request) Update the information of a specified circle fence.
String	updateFence(String appId, UpdateDistrictFenceRequest request) Update the information of a specified administrative district fence.
String	updateFence(String appId, UpdatePolygonFenceRequest request) Update the information of a specified polygonal fence.
String	updateFence(String appId, UpdatePolylineFenceRequest request) Update the information of a specified linear fence.
DuMapTraceClient	withUriPrefix(String uriPrefix) Setting the prefix of uri for this client.

Methods inherited from class com.baidubce.services.dumap.BaseDuMapClient

callDuMap, callDuMap, fillInHeadAndBody, fillParams, safeAddQueryParam, toForm, toJson

Methods inherited from class com.baidubce.AbstractBceClient

getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DuMapTraceClient

public DuMapTraceClient()

Construct a dumap trace client with default configurations.

DuMapTraceClient

public DuMapTraceClient(BceClientConfiguration configuration)

Construct a dumap trace client with the specified configurations.

Parameters:

configuration - Client configurations.

Method Detail

withUriPrefix

public DuMapTraceClient withUriPrefix(String uriPrefix)

Setting the prefix of uri for this client.

Parameters:

uriPrefix - Uri prefix. It should be "/trace" or "/api". The default value is "/api". And "/trace" is just for product test.

Returns:

DuMapTraceClient

addEntity

public String addEntity(String appId,
                        AddEntityRequest request)

Add a new entity, which represents a person, a car or any other object.

Parameters:

appId - App ID.

request - Add entity request.

Returns:

Json string.

updateEntity

public String updateEntity(String appId,
                           UpdateEntityRequest request)

Update description of some entity.

Parameters:

appId - App ID.

request - Update entity request.

Returns:

Json string.

deleteEntity

public String deleteEntity(String appId,
                           DeleteEntityRequest request)

Delete some entity according to the entity name.

Parameters:

appId - App ID.

request - Deleting entity request.

Returns:

Json string.

listEntity

public String listEntity(String appId,
                         ListEntityParam param)

List entities according to the conditions given in the filter.

Parameters:

appId - App ID.

param - List entity request parameters.

Returns:

Json string.

addPoint

public String addPoint(String appId,
                       AddPointRequest request)

Upload a track point for an entity.

Parameters:

appId - App ID.

request - Add point request.

Returns:

Json string.

addPoint

public String addPoint(String appId,
                       AddPointsRequest request)

Upload multiple tracks point of one entity or multiple entities at one time.

Parameters:

appId - App ID.

request - Add points request.

Returns:

Json string.

search

public String search(String appId,
                     KeywordSearchParam param)

Search entities according to the specified keyword. It will return the real-time location of the entities.

Parameters:

appId - App ID.

param - Keyword searching request parameters.

Returns:

Json string.

search

public String search(String appId,
                     BoundSearchParam param)

Search entities in the specified rectangular area. It will return the real-time location of the entities.

Parameters:

appId - App ID.

param - Bound searching request parameters.

Returns:

Json string.

search

public String search(String appId,
                     AroundSearchParam param)

Search entities in the specified circle area. It will return the real-time location of the entities.

Parameters:

appId - App ID.

param - Around searching request parameters.

Returns:

Json string.

search

public String search(String appId,
                     PolygonSearchParam param)

Search entities in the specified polygonal area. It will return the real-time location of the entities.

Parameters:

appId - App ID.

param - Polygonal searching request parameters.

Returns:

Json string.

search

public String search(String appId,
                     DistrictSearchParam param)

Search entities in the specified administrative district.

Parameters:

appId - App ID.

param - District searching request parameters.

Returns:

Json string.

track

public String track(String appId,
                    GetLatestPointParam param)

Query the latest track point of an entity, which supports real-time correction.
It will return the real-time information of the entity, such as location, speed, direction, height, limitations and so on.

Parameters:

appId - App ID.

param - Getting latest point request parameters.

Returns:

Json string.

track

public String track(String appId,
                    GetDistanceParam param)

Query the mileage over a period of time of an entity.
It support track correction and compensation.
It also support calculate the mileage of original track.

Parameters:

appId - App ID.

param - Getting distance request parameters.

Returns:

Json string.

track

public String track(String appId,
                    GetTrackParam param)

Query track information of an entity.
It support real-time correction.

Parameters:

appId - App ID.

param - Getting track request parameters.

Returns:

Json string.

analyze

public String analyze(String appId,
                      StayPointAnalysisParam param)

Analyzing the stay points of an entity in the specified time period.
If the entity in the "stay_radius", and for a time longer than "stay_time", then it will be regarded as one time of staying.

Parameters:

appId - App ID.

param - Stay point analyzing request parameters.

Returns:

Json string.

analyze

public String analyze(String appId,
                      DrivingBehaviorAnalysisParam param)

Analyzing the driving behavior of an entity.
The response includes the followed information.
1. General information: origin, destination, mileage, time, average speed, maximum speed.
2. Exception information: speeding, accelerating, braking, swerving.

Parameters:

appId - App ID.

param - Driving behavior analyzing request parameters.

Returns:

Json string.

createFence

public String createFence(String appId,
                          CreateCircleFenceRequest request)

Create a circle fence.

Parameters:

appId - App ID.

request - Creating circle fence request.

Returns:

Json string.

createFence

public String createFence(String appId,
                          CreatePolygonFenceRequest request)

Create a polygonal fence.

Parameters:

appId - App ID.

request - Creating polygonal fence request.

Returns:

Json string.

createFence

public String createFence(String appId,
                          CreatePolylineFenceRequest request)

Create a linear fence.

Parameters:

appId - App ID.

request - Creating linear fence request.

Returns:

Json string.

createFence

public String createFence(String appId,
                          CreateDistrictFenceRequest request)

Create an administrative district fence.

Parameters:

appId - App ID.

request - Creating administrative district fence request.

Returns:

Json string.

updateFence

public String updateFence(String appId,
                          UpdateCircleFenceRequest request)

Update the information of a specified circle fence.

Parameters:

appId - App ID.

request - Updating circle fence request.

Returns:

Json string.

updateFence

public String updateFence(String appId,
                          UpdatePolygonFenceRequest request)

Update the information of a specified polygonal fence.

Parameters:

appId - App ID.

request - Updating polygonal fence request.

Returns:

Json string.

updateFence

public String updateFence(String appId,
                          UpdatePolylineFenceRequest request)

Update the information of a specified linear fence.

Parameters:

appId - App ID.

request - Update linear fence request.

Returns:

Json string.

updateFence

public String updateFence(String appId,
                          UpdateDistrictFenceRequest request)

Update the information of a specified administrative district fence.

Parameters:

appId - App ID.

request - Updating administrative district fence.

Returns:

Json string.

deleteFence

public String deleteFence(String appId,
                          DeleteFenceRequest request)

Deleting the specified fence according to the specified monitored entity or fence IDs.

Parameters:

appId - App ID.

request - Deleting fence request.

Returns:

Json string.

listFence

public String listFence(String appId,
                        ListFenceParam param)

Query the list of fences of the specified trace service.

Parameters:

appId - App ID.

param - Listing fence request parameters.

Returns:

Json string.

addMonitoredPerson

public String addMonitoredPerson(String appId,
                                 AddMonitoredPersonRequest request)

Add some monitored entities to the specified trace service.

Parameters:

appId - App ID.

request - Adding monitored entities request.

Returns:

Json string.

deleteMonitoredPerson

public String deleteMonitoredPerson(String appId,
                                    DeleteMonitoredPersonRequest request)

Delete some monitored entities of the specified fence.

Parameters:

appId - App ID.

request - Deleting monitored entities request.

Returns:

Json string.

listMonitoredPerson

public String listMonitoredPerson(String appId,
                                  ListMonitoredPersonParam param)

List all monitored entities of the specified fence.

Parameters:

appId - App ID.

param - Listing monitored entities request parameters.

Returns:

Json string.

queryStatus

public String queryStatus(String appId,
                          QueryStatusParam param)

Query an entity in or out of the specified fences.

Parameters:

appId - App ID.

param - Querying status request parameters.

Returns:

Json string.

queryStatus

public String queryStatus(String appId,
                          QueryStatusByLocationParam param)

Query an entity in or out of the specified fences according the given location of the entity.

Parameters:

appId - App ID.

param - Querying status by location request parameters.

Returns:

Json string.

historyAlarm

public String historyAlarm(String appId,
                           HistoryAlarmParam param)

Query the historical alarm information of the specified entity.
The alarm information is saved for just 7 days.

Parameters:

appId - App ID.

param - Querying historical alarm request parameters.

Returns:

Json string.

historyAlarm

public String historyAlarm(String appId,
                           BatchHistoryAlarmParam param)

Query the historical alarm information of fences over the specified period of time.

Parameters:

appId - App ID.

param - Querying batch historical alarm request parameters.

Returns:

Json string.

setCallbackUrl

public String setCallbackUrl(String appId,
                             SetCallbackUrlRequest request)

Set callback url of the specified trace service.

Parameters:

appId - App ID.

request - Setting callback url request.

Returns:

Json string.

cancelCallbackUrl

public String cancelCallbackUrl(String appId,
                                CancelCallbackUrlRequest request)

Cancel the callback url setting of the specified trace service.

Parameters:

appId - App ID.

request - Canceling callback url request.

Returns:

Json string.

queryCallbackUrl

public String queryCallbackUrl(String appId,
                               QueryCallbackUrlParam param)

Query the callback url of the specified trace service.

Parameters:

appId - App ID.

param - Querying callback url request parameters.

Returns:

Json string.

createExportJob

public String createExportJob(String appId,
                              CreateJobRequest request)

Create a new job to export all track data of the specified trace service over a period of time.
The time period of each job must be less than 24 hours.
And each trace service has a maximum of 10 jobs.

Parameters:

appId - App ID.

request - Creating job request.

Returns:

Json string.

deleteExportJob

public String deleteExportJob(String appId,
                              DeleteJobRequest request)

Delete a track data exporting job of the specified service.

Parameters:

appId - App ID.

request - Deleting job request.

Returns:

Json string.

getExportJob

public String getExportJob(String appId,
                           GetJobParam param)

Query the status of all track data exporting job of the specified service.

Parameters:

appId - App ID.

param - Querying job status request parameters.

Returns:

Json string.