com.wialon.core

Class Session

java.lang.Object

com.wialon.core.EventProvider

com.wialon.core.Session

public class Session
extends EventProvider

Wialon session static object. Contain all information about active Wialon server session.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Session.events
static class	Session.GisType Gis type constants for @getBaseGisUrl call

Method Summary

Methods

Modifier and Type	Method and Description
int	checkFeature(java.lang.String feature) Check if billing service is available for given session
void	checkItemsBilling(java.lang.Long[] items, java.lang.String serviceName, java.lang.Long accessFlags, ResponseHandler callback) Check collection of items for billing service and access level usage possibility
void	createAuthHash(ResponseHandler callback) Create authorization hash that can be used to create copy of session from any IP
void	createResource(User creator, java.lang.String name, long dataFlags, SearchResponseHandler callback) Create new resource
void	createUnit(User creator, java.lang.String name, long hwTypeId, long dataFlags, SearchResponseHandler callback) Create new unit
void	createUnitGroup(User creator, java.lang.String name, long dataFlags, SearchResponseHandler callback) Create new unit group
void	createUser(User creator, java.lang.String name, java.lang.String password, long dataFlags, SearchResponseHandler callback) Create new user
void	deleteItem(Item item, ResponseHandler callback) Delete item, require ACL bit Item.accessFlag.deleteItem over item Can't be deleted: current user, users that has other items created com them and billing accounts(resources).
void	getAccountData(boolean fullInfo, ResponseHandler callback) Get account information for current user as JSON Object
java.lang.String	getBaseGisUrl(Session.GisType gisType) Get base URL for GIS service
java.lang.String	getBaseUrl() Get base URL for server
User	getCurrUser() Get current user
com.google.gson.JsonObject	getFeatures() Fetch available billing services for given session
com.google.gson.Gson	getGson()
void	getHwCommands(java.lang.Long deviceTypeId, java.lang.Long unitId, ResponseHandler callback) Get all available hardware type commands
void	getHwTypes(java.lang.String filterType, java.lang.Object[] filterValue, java.lang.Boolean includeType, ResponseHandler callback) Get hardware types
java.lang.String	getId() Get events session ID
static Session	getInstance()
Item	getItem(long itemId) Get item com ID
java.util.Collection<Item>	getItems() Get all items
<T extends Item> java.util.Collection<T>	getItems(java.lang.Class<T> itemClass) Get collection of items of given Class
java.util.Collection<Item>	getItems(Item.ItemType itemsType) Get collection of items of given type
com.google.gson.JsonParser	getJsonParser()
MessagesLoader	getMessagesLoader() Get messages loader object for given session
Renderer	getRenderer() Get renderer object for given session
void	getReportTables(ResponseHandler callback) Get report tables available for current user as JSON Object
long	getServerTime() Get latest known server time
boolean	initSession(java.lang.String baseUrl) Initialize Wialon session
boolean	isInitialized() Check on initialize Wialon session
boolean	isInternalGis()
void	listTokens(java.lang.String app, ResponseHandler callback) Get all available authorization tokens
void	login(java.lang.String user, java.lang.String password, ResponseHandler callback) Perform login to Wialon server.
void	loginAuthHash(java.lang.String authHash, ResponseHandler callback) Perform login to Wialon server using authorization hash.
void	loginToken(java.lang.String token, ResponseHandler callback)
void	loginToken(java.lang.String token, java.lang.String service, ResponseHandler callback) Perform login to Wialon server using authorization token.
void	logout(int flags, ResponseHandler callback)
void	logout(ResponseHandler callback) Logout from Wialon server.
void	resetPasswordPerform(User user, java.lang.String code, ResponseHandler callback) Perform password reset for Wialon user.
void	resetPasswordRequest(User user, java.lang.String email, java.lang.String emailFrom, java.lang.String url, java.lang.String lang, ResponseHandler callback) Request reset password for Wialon user.
void	searchItem(long id, long dataFlags, SearchResponseHandler callback) Search for item
void	searchItems(SearchSpec searchSpec, int forceRefresh, long dataFlags, int indexFrom, int indexTo, SearchResponseHandler callback) Search for items
void	sendSms(java.lang.String phoneNumber, java.lang.String smsText, ResponseHandler callback) Send SMS, current user should have flag User.userFlag.canSendSMS and should have enough SMS messages available for account
boolean	setEvtPollInterval(long interval) Change event poll interval
void	setInternalGis(boolean isEnabled)
void	updateDataFlags(UpdateSpec[] spec, ResponseHandler callback) Update data flags for items: load or unload items from current session, change their data flags
void	updateItem(Item item, com.google.gson.JsonObject itemData) Update item data
void	updateToken(java.lang.String callMode, java.lang.String token, ResponseHandler callback) Create/Update/Delete authorization token

Methods inherited from class com.wialon.core.EventProvider

addListener, clearListeners, fireEvent, removeListener, removeListeners

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Session getInstance()

isInternalGis

public boolean isInternalGis()

setInternalGis

public void setInternalGis(boolean isEnabled)

getJsonParser

public com.google.gson.JsonParser getJsonParser()

getGson

public com.google.gson.Gson getGson()

getItem

public Item getItem(long itemId)

Get item com ID

Parameters:

itemId - {Integer} Item ID

Returns:

{wialon.item.Item} Item

getItems

public java.util.Collection<Item> getItems(Item.ItemType itemsType)

Get collection of items of given type

Parameters:

itemsType - {ItemType} Type of items to get, pass null to fetch all items

Returns:

collection of items

getItems

public <T extends Item> java.util.Collection<T> getItems(java.lang.Class<T> itemClass)

Get collection of items of given Class

Type Parameters:

T - Type

Parameters:

itemClass - Class of item

Returns:

collection of items

getItems

public java.util.Collection<Item> getItems()

Get all items

Returns:

{List} includes all items

initSession

public boolean initSession(java.lang.String baseUrl)

Initialize Wialon session

Parameters:

baseUrl -

login

public void login(java.lang.String user,
         java.lang.String password,
         ResponseHandler callback)

Perform login to Wialon server.

Parameters:

user - {String} user name

password - {String} user password

callback - {ResponseHandler} callback function that is called after login

loginAuthHash

public void loginAuthHash(java.lang.String authHash,
                 ResponseHandler callback)

Perform login to Wialon server using authorization hash. Auth hash can be fetched with wialon.core.Session.createAuthHash

Parameters:

authHash - authorization hash

callback - callback function that is called after login

loginToken

public void loginToken(java.lang.String token,
              ResponseHandler callback)

loginToken

public void loginToken(java.lang.String token,
              java.lang.String service,
              ResponseHandler callback)

Perform login to Wialon server using authorization token. Auth token can be fetched with Session.updateToken

Parameters:

token - authorization token

callback - callback function that is called after login

updateToken

public void updateToken(java.lang.String callMode,
               java.lang.String token,
               ResponseHandler callback)

Create/Update/Delete authorization token

Parameters:

callMode - operation mode with the authorization token (create/update/delete)

token - JSON object parameters with keys: TODO: h authorization token hash (only 'update'/'delete') app application name for which was created token at specifies time ranges token will be active (0 - activation current time) dur proposed token validity duration in seconds (0 - unlimited duration) fl mask for additional ACL restrictions p additional JSON data items limit access to only this collection of storage items deleteAll delete all available tokens (only 'delete')

listTokens

public void listTokens(java.lang.String app,
              ResponseHandler callback)

Get all available authorization tokens

Parameters:

app - application name for which was created token, optional

callback - callback that get result of server operation

logout

public void logout(ResponseHandler callback)

Logout from Wialon server.

Parameters:

callback - {ResponseHandler} callback function that is called after logout: where zero is success

logout

public void logout(int flags,
          ResponseHandler callback)

createAuthHash

public void createAuthHash(ResponseHandler callback)

Create authorization hash that can be used to create copy of session from any IP

Parameters:

callback - {ResponseHandler} callback function that is called after login: {authHash: "XXX"}, where zero code is success

searchItems

public void searchItems(SearchSpec searchSpec,
               int forceRefresh,
               long dataFlags,
               int indexFrom,
               int indexTo,
               SearchResponseHandler callback)

Search for items

Parameters:

searchSpec - Search specification in form: {itemsType: "", propName: "", propValueMask: "", sortType: ""} where itemsType: type of items to search for propName - name of property for filtering, usually "sys_name" propValueMask - value mask of property for filtering, asteriks can be used propType[optional] - type of property, should be empty for simple properties, optional values are: "guid" - convert property value from id to GUID, "list" - search for ID in list property (e.g. unit in group), "propitemname" - search for prop item name, e.g. custom fields, sensors sortType - name of property that will be used for sorting, if any, usually used "sys_name"

forceRefresh - if non-zero value used, skip any caching and perform operation in realtime (try to avoid passing 1 here)

dataFlags - what data-flags returned items should have

indexFrom - starting index for returning result, for new searches use zero value

indexTo - ending index for returning result, for new searches use ('max number of items to return'-1) value

callback - callback function that is called after remote call: callback(code, data), where code: operation result code (zero is success) data (result) consists of: {items: [], dataFlags: 0x10, totalItemsCount: 100, indexFrom: 0, indexTo: 9, searchSpec: {...}}

searchItem

public void searchItem(long id,
              long dataFlags,
              SearchResponseHandler callback)

Search for item

Parameters:

id - ID of item to search for

dataFlags - {Integer}: what data-flags returned item should have

callback - {?Function} callback function that is called after remote call: callback(code, item)

updateDataFlags

public void updateDataFlags(UpdateSpec[] spec,
                   ResponseHandler callback)

Update data flags for items: load or unload items from current session, change their data flags

Parameters:

spec - {Object} Specification of what to update in form [{type: "id|type|col", data: , flags: 100, mode: 0/1/2},...] where flags: what flags to setup type - selector: id - item-id, item - item type, col - collection of items ID mode - update flags mode: 0 - set, 1 - add, 2 - remove

callback - {ResponseHandler} callback function that is called after remote call: callback(code), where zero code is success

getId

public java.lang.String getId()

Get events session ID

Returns:

{String} events session ID

getRenderer

public Renderer getRenderer()

Get renderer object for given session

Returns:

renderer

getMessagesLoader

public MessagesLoader getMessagesLoader()

Get messages loader object for given session

Returns:

MessagesLoader renderer

isInitialized

public boolean isInitialized()

Check on initialize Wialon session

Returns:

{boolean} initialization state

getBaseUrl

public java.lang.String getBaseUrl()

Get base URL for server

Returns:

{String} base URL: remote://api.wialon.net or https://secure.wialon.net

getServerTime

public long getServerTime()

Get latest known server time

Returns:

{long} Last known server time in UNIX seconds

getCurrUser

public User getCurrUser()

Get current user

Returns:

{User} Currently active user

setEvtPollInterval

public boolean setEvtPollInterval(long interval)

Change event poll interval

Parameters:

interval - value in milliseconds between 2000 - 120000 (2-120 seconds)

getHwTypes

public void getHwTypes(java.lang.String filterType,
              java.lang.Object[] filterValue,
              java.lang.Boolean includeType,
              ResponseHandler callback)

Get hardware types

Parameters:

filterType - filter type (name, id, type) or null to ignore

filterValue - filter value String[] for filterType="name" or "type" and Long[] for filterType="id", pass null to ignore

includeType - Whether add type to hardware params, pass null to ignore

callback - callback function that is called after remote call

getHwCommands

public void getHwCommands(java.lang.Long deviceTypeId,
                 java.lang.Long unitId,
                 ResponseHandler callback)

Get all available hardware type commands

Parameters:

deviceTypeId - ID of hw type to search for

unitId - ID of avl_unit

callback - callback function that is called after remote call

getFeatures

public com.google.gson.JsonObject getFeatures()

Fetch available billing services for given session

Returns:

features information

checkFeature

public int checkFeature(java.lang.String feature)

Check if billing service is available for given session

Returns:

{Integer} 0 - N/A, -1 - available, but no more services of given type, 1 - available and more services can be requested

createUnit

public void createUnit(User creator,
              java.lang.String name,
              long hwTypeId,
              long dataFlags,
              SearchResponseHandler callback)

Create new unit

Parameters:

creator - user-creator, either current user nor one of its descendants

name - unit name

hwTypeId - hardware type id, see getHwTypes() for full list of hw types

dataFlags - which flags initially to return

callback - callback function that is called after remote call with new Unit object, important: obj is not loaded into session

createUser

public void createUser(User creator,
              java.lang.String name,
              java.lang.String password,
              long dataFlags,
              SearchResponseHandler callback)

Create new user

Parameters:

creator - user-creator, either current user nor one of its descendants

name - unit name

password - user password

dataFlags - which flags initially to return

callback - callback function that is called after remote call with new User object, important: obj is not loaded into session

createUnitGroup

public void createUnitGroup(User creator,
                   java.lang.String name,
                   long dataFlags,
                   SearchResponseHandler callback)

Create new unit group

Parameters:

creator - user-creator, either current user nor one of its descendants

name - unit group name

dataFlags - which flags initially to return

callback - callback function that is called after remote call with new UnitGroup object, important: obj is not loaded into session

createResource

public void createResource(User creator,
                  java.lang.String name,
                  long dataFlags,
                  SearchResponseHandler callback)

Create new resource

Parameters:

creator - user-creator, either current user nor one of its descendants

name - resource name

dataFlags - which flags initially to return

callback - callback function that is called after remote call with new Resource object, important: obj is not loaded into session

updateItem

public void updateItem(Item item,
              com.google.gson.JsonObject itemData)

Update item data

Parameters:

item - {Item} - item

itemData - - object with data from server

deleteItem

public void deleteItem(Item item,
              ResponseHandler callback)

Delete item, require ACL bit Item.accessFlag.deleteItem over item Can't be deleted: current user, users that has other items created com them and billing accounts(resources). After successful deletion item will be removed from session automatically.

Parameters:

item - item

callback - callback that will receive information about item deletion

resetPasswordRequest

public void resetPasswordRequest(User user,
                        java.lang.String email,
                        java.lang.String emailFrom,
                        java.lang.String url,
                        java.lang.String lang,
                        ResponseHandler callback)

Request reset password for Wialon user.

Parameters:

user - Wialon user

email - user e-mail

emailFrom - E-Mail from which confirmation e-mail will be sent

url - url that will be in e-mail reset request, user will be pointed to: ?user=&passcode=

lang - e-mail language

callback - callback function that is called after login

resetPasswordPerform

public void resetPasswordPerform(User user,
                        java.lang.String code,
                        ResponseHandler callback)

Perform password reset for Wialon user.

Parameters:

user - Wialon user

code - code generated com resetPasswordRequest request and sent to user com email

callback - callback function that is called after login and data.newPassword contain new password

sendSms

public void sendSms(java.lang.String phoneNumber,
           java.lang.String smsText,
           ResponseHandler callback)

Send SMS, current user should have flag User.userFlag.canSendSMS and should have enough SMS messages available for account

Parameters:

phoneNumber - phone number in international format

smsText - SMS message text

callback - callback that will receive information about SMS send operation

getAccountData

public void getAccountData(boolean fullInfo,
                  ResponseHandler callback)

Get account information for current user as JSON Object

Parameters:

fullInfo - return all billing account information

callback - function to call with result of remote call and data contain full account information.

checkItemsBilling

public void checkItemsBilling(java.lang.Long[] items,
                     java.lang.String serviceName,
                     java.lang.Long accessFlags,
                     ResponseHandler callback)

Check collection of items for billing service and access level usage possibility

Parameters:

items - array of ID of items to check

serviceName - billing service name

accessFlags - ACL flags to check for

callback - function to call with result of remote call and data contain collection of items IDs that can be used for such billing service.

getReportTables

public void getReportTables(ResponseHandler callback)

Get report tables available for current user as JSON Object

Parameters:

callback - function to call with result of remote call and data contain full report tables information.

getBaseGisUrl

public java.lang.String getBaseGisUrl(Session.GisType gisType)

Get base URL for GIS service

Parameters:

gisType - {GisType} type of GIS function: render, search, geocode

Returns:

{String} base URL suitable for prepending GIS requests of given type