com.wialon.item

Class User

java.lang.Object

com.wialon.core.EventProvider

com.wialon.item.Item

com.wialon.item.User

public class User
extends Item

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.accessFlag ACL flags constants
static class	User.dataFlag Data flags constants
static class	User.events
static class	User.logMessageAction Such actions starts with "user_" and looks like "user_update_name" or "user_create_poi".
static class	User.userFlag User flags constants

Nested classes/interfaces inherited from class com.wialon.item.Item

Item.ItemType, Item.measureUnitsFlag, Item.measureUnitsType, Item.UpdateItemProperty

Field Summary

Fields inherited from class com.wialon.item.Item

itemType

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Methods

Modifier and Type	Method and Description
static long	defaultDataFlags() Fetch default current user flags
java.lang.String	getHostsMask() Hosts mask, restrict list of IP addresses from which user can access Wialon, wildcards supported
void	getItemsAccess(boolean directAccess, Item.ItemType itemSuperclass, ResponseHandler callback) Get ACL for this users over all items
void	getLocale(ResponseHandler callback) Get localization settings, remote call, require ACL bit wialon.item.Item.accessFlags.viewProperties over item
ItemProperties	getMobileAppsPlugin()
java.lang.Long	getUserFlags() User flags
void	setHostsMask(java.lang.String hostsMask)
void	updateHostsMask(java.lang.String hostsMask, ResponseHandler callback) Update hosts mask, from which user can access Wialon, require ACL bit User.accessFlag.editUserFlags over user
void	updateItemAccess(Item item, long accessMask, ResponseHandler callback) Update this user access to some other, require ACL bit Item.accessFlag.setItemsAccess over user and Item.accessFlag.setAcl over item
boolean	updateItemData(java.lang.String key, com.google.gson.JsonElement data)
void	updateLocale(java.lang.String locale, ResponseHandler callback) Update this user localization settings
void	updatePassword(java.lang.String oldPassword, java.lang.String newPassword, ResponseHandler callback) Update password require ACL bit User.accessFlag.operateAs over user and correct oldPassword OR User.accessFlag.editUserFlags and empty oldPassword
void	updateUserFlags(long flags, long flagsMask, ResponseHandler callback) Update this user flags, require ACL bit User.accessFlag.editUserFlags over user

Methods inherited from class com.wialon.item.Item

addLogRecord, fireItemPropertyEvent, getAccountId, getAdminFieldsPlugin, getCreatorId, getCustomFieldsPlugin, getCustomProperty, getDataFlags, getId, getItemType, getMeasureUnits, getName, getOnUpdatePropertiesCallback, getUserAccess, handleMessage, onUpdateProperties, registerItemPropertyHandler, setDataFlags, updateCustomProperty, updateMeasureUnits, updateName

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

Constructor Detail

User

public User()

Method Detail

getMobileAppsPlugin

public ItemProperties getMobileAppsPlugin()

getUserFlags

public java.lang.Long getUserFlags()

User flags

Returns:

get user flags

getHostsMask

public java.lang.String getHostsMask()

Hosts mask, restrict list of IP addresses from which user can access Wialon, wildcards supported

Returns:

host mask

getItemsAccess

public void getItemsAccess(boolean directAccess,
                  Item.ItemType itemSuperclass,
                  ResponseHandler callback)

Get ACL for this users over all items

Parameters:

directAccess - return only items with direct access for this user

itemSuperclass - item superclass

callback - callback that will receive information about user ACL result is object {itemId1: accessMask, itemId2: accessMask, ...}

updateItemAccess

public void updateItemAccess(Item item,
                    long accessMask,
                    ResponseHandler callback)

Update this user access to some other, require ACL bit Item.accessFlag.setItemsAccess over user and Item.accessFlag.setAcl over item

Parameters:

item - item which access need to be updated

accessMask - new item ACL

callback - callback that will receive information about access update: callback(code), zero code is success

updateUserFlags

public void updateUserFlags(long flags,
                   long flagsMask,
                   ResponseHandler callback)

Update this user flags, require ACL bit User.accessFlag.editUserFlags over user

Parameters:

flags - flags which to set, see User.userFlag for possible values canSendSMS and canCreateItems flags require all creators of this user to have them enabled

flagsMask - mask of which flags to set to ON/OFF. If mask contain invalid bits, request would be denied

callback - callback that will receive information about flags update

updateHostsMask

public void updateHostsMask(java.lang.String hostsMask,
                   ResponseHandler callback)

Update hosts mask, from which user can access Wialon, require ACL bit User.accessFlag.editUserFlags over user

Parameters:

hostsMask - new wildcard-base hosts mask, use empty value to disable this restriction

callback - callback that will receive information about hosts mask update

getLocale

public void getLocale(ResponseHandler callback)

Get localization settings, remote call, require ACL bit wialon.item.Item.accessFlags.viewProperties over item

Parameters:

callback - callback that get result of server operation in form callback(code, result), where result represents JSON data for localization settings

updateLocale

public void updateLocale(java.lang.String locale,
                ResponseHandler callback)

Update this user localization settings

Parameters:

locale - localization parameters, format: {fd: text, wd: ubyte}

callback - callback that will receive information about localization update

updatePassword

public void updatePassword(java.lang.String oldPassword,
                  java.lang.String newPassword,
                  ResponseHandler callback)

Update password require ACL bit User.accessFlag.operateAs over user and correct oldPassword OR User.accessFlag.editUserFlags and empty oldPassword

Parameters:

oldPassword - old password if only User.accessFlag.operateAs acl bit available

newPassword - new password

callback - callback that will receive information about password update

updateItemData

public boolean updateItemData(java.lang.String key,
                     com.google.gson.JsonElement data)

Overrides:

updateItemData in class Item

setHostsMask

public void setHostsMask(java.lang.String hostsMask)

defaultDataFlags

public static long defaultDataFlags()

Fetch default current user flags

Returns:

default user data flags