Auth (JNaviCore SDK Documentation)

java.lang.Object
- com.mapbar.mapdal.Auth

```
public final class Auth
extends java.lang.Object
```
授权验证相关接口

Notice:

注意：
Auth的接口应该仅在主线程中调用

嵌套类概要

嵌套类
限定符和类型	类和说明
`class`	`Auth.AuthDisable` 授权不验证项，只在Debug模式下有效，即`JNaviCoreConfig.DEBUG`为true时有效
`class`	`Auth.Error` 授权验证错误码
`class`	`Auth.Limitations`
`static interface`	`Auth.Listener` 更新授权文件的回调接口

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`int`	`checkLicense()` 检查授权文件状态，返回`Auth.Error`信息返回结果仅可能是如下值： `Auth.Error.none` `Auth.Error.deviceIdReaderError` `Auth.Error.licenseIoError` `Auth.Error.licenseFormatError` `Auth.Error.licenseMissing` `Auth.Error.licenseIncompatible` `Auth.Error.licenseDeviceIdMismatch` `Auth.Error.otherError`
`void`	`cleanup()` 清理所有授权模块使用的资源
`boolean`	`dataIsAvailable(java.lang.String id)` 根据Id返回数据是否有权限，仅是简单地返回当前数据权限的可用状态，如果不可用，不会返回错误原因。
`void`	`enable(int enabled)` 开启/关闭授权验证模块
`DataInfo[]`	`getAllDataInfo()` 返回所有已经存在授权信息的数据信息
`int`	`getDataInfo(java.lang.String id, DataInfo info)` 获取制定Id的数据相关信息
`int`	`getDataPermissionState(java.lang.String id)` 获取给定Id的数据的权限状态`Auth.Error`
`static Auth`	`getInstance()` 获取单例类的实例
`java.lang.String`	`getLicenseUpdateTime()` 获取授权文件更新时间
`Auth.Limitations`	`getLimitations()` 获取数据授权中版本限制信息`Auth.Limitations`
`int`	`init(java.lang.String deviceId, java.lang.String model)` 初始化授权模块，返回基础license文件状态返回结果仅可能是如下值： `Auth.Error.none` `Auth.Error.deviceIdReaderError` `Auth.Error.licenseIoError` `Auth.Error.licenseFormatError` `Auth.Error.licenseMissing` `Auth.Error.licenseIncompatible` `Auth.Error.licenseDeviceIdMismatch` `Auth.Error.otherError`
`int`	`isEnabled()` 判断授权验证模块当前是否开启
`boolean`	`isInited()` 该单例类是否已被初始化
`boolean`	`reloadLicense(java.lang.String path)` 设置授权文件保存路径
`void`	`setListener(Auth.Listener listener)` 设置更新授权文件的回调函数
`void`	`setServerUrlBase(java.lang.String url)` 设置更新license.dat文件的服务器地址
`void`	`updateLicense()` 更新授权文件如果在调用此方法之前调用了`setListener(Auth.Listener)`，那么更新之后将通过 `Auth.Listener.onCompletion(int, int)`返回调用结果。
`void`	`updateLicenseWithParamString(java.lang.String params)` 根据用户输入的参数来请求授权文件此API是`updateLicense()`的高级版本，支持自定义请求参数。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getInstance
```
public static Auth getInstance()
```
    获取单例类的实例
    
    返回:
    
    该单例类Auth的实例
  - isInited
```
public boolean isInited()
```
    该单例类是否已被初始化
    
    返回:
    
    true:已初始化;false:未初始化
  - init
```
public int init(java.lang.String deviceId,
                java.lang.String model)
         throws java.lang.Exception
```
    初始化授权模块，返回基础license文件状态
    返回结果仅可能是如下值：
    Auth.Error.none
    Auth.Error.deviceIdReaderError
    Auth.Error.licenseIoError
    Auth.Error.licenseFormatError
    Auth.Error.licenseMissing
    Auth.Error.licenseIncompatible
    Auth.Error.licenseDeviceIdMismatch
    Auth.Error.otherError
    
    参数:
    
    deviceId - 设备的IMEI
    
    model - 设备型号或渠道号
    
    返回:
    
    返回基础文件错误信息Auth.Error
    
    抛出:
    
    java.lang.Exception
    
    另请参阅:
    
    Auth.Error
    
    Notice:
    
    注意：应该保证授权模块初始化与情理保持成对，且其他功能应该保证在初始化过之后使用，否则可能失效
    此方法应该在初始化其他模块之前调用
  - cleanup
```
public void cleanup()
```
    清理所有授权模块使用的资源
  - setListener
```
public void setListener(Auth.Listener listener)
```
    设置更新授权文件的回调函数
    
    参数:
    
    listener - 回调接口对象Auth.Listener
    
    另请参阅:
    
    Auth.Listener
  - updateLicense
```
public void updateLicense()
```
    更新授权文件
    如果在调用此方法之前调用了setListener(Auth.Listener)，那么更新之后将通过 Auth.Listener.onCompletion(int, int)返回调用结果。
    
    另请参阅:
    
    Auth.Listener.onCompletion(int, int)
  - updateLicenseWithParamString
```
public void updateLicenseWithParamString(java.lang.String params)
```
    根据用户输入的参数来请求授权文件
    此API是updateLicense()的高级版本，支持自定义请求参数。
    
    参数:
    
    params - 需要拼接的字符串参数
    格式为param1=1¶m2=2，此参数应该是请求URL的"?"后面的参数部分
    如：https://auth?param1=1¶m2=2, 那么/p params应该为"param1=1¶m2=2"
    
    另请参阅:
    
    updateLicense()
  - setServerUrlBase
```
public void setServerUrlBase(java.lang.String url)
```
    设置更新license.dat文件的服务器地址
    
    参数:
    
    url - 服务器地址
  - dataIsAvailable
```
public boolean dataIsAvailable(java.lang.String id)
```
    根据Id返回数据是否有权限，仅是简单地返回当前数据权限的可用状态，如果不可用，不会返回错误原因。
    
    参数:
    
    id - 数据Id
    
    返回:
    
    true为可用，否则为false
  - getDataPermissionState
```
public int getDataPermissionState(java.lang.String id)
```
    获取给定Id的数据的权限状态Auth.Error
    
    返回:
    
    返回当前数据权限状态
    
    另请参阅:
    
    Auth.Error
  - getDataInfo
```
public int getDataInfo(java.lang.String id,
                       DataInfo info)
```
    获取制定Id的数据相关信息
    
    参数:
    
    id - 数据Id
    
    info - 数据授权信息(输出参数)
    
    返回:
    
    数据当前授权状态Auth.Error
  - getAllDataInfo
```
public DataInfo[] getAllDataInfo()
```
    返回所有已经存在授权信息的数据信息
    
    返回:
    
    所有数据信息DataInfo
    
    另请参阅:
    
    DataInfo
  - checkLicense
```
public int checkLicense()
```
    检查授权文件状态，返回Auth.Error信息
    返回结果仅可能是如下值：
    Auth.Error.none
    Auth.Error.deviceIdReaderError
    Auth.Error.licenseIoError
    Auth.Error.licenseFormatError
    Auth.Error.licenseMissing
    Auth.Error.licenseIncompatible
    Auth.Error.licenseDeviceIdMismatch
    Auth.Error.otherError
    
    另请参阅:
    
    Auth.Error
  - reloadLicense
```
public boolean reloadLicense(java.lang.String path)
```
    设置授权文件保存路径
    
    参数:
    
    path - 授权文件保存路径
    
    返回:
    
    如果设置成功，返回true，否则返回false
    
    Notice:
    
    注意：在设置路径之后，会重新读取授权文件，此时需要调用 checkLicense()重新检查授权文件状态
  - getLicenseUpdateTime
```
public java.lang.String getLicenseUpdateTime()
```
    获取授权文件更新时间
    
    返回:
    
    跟新时间字符串
  - enable
```
public void enable(int enabled)
```
    开启/关闭授权验证模块
    
    参数:
    
    enabled - 不验证部分，见Auth.AuthDisable
    
    另请参阅:
    
    isEnabled()
    
    Notice:
    
    注意：此方法仅在debug模式下可用，即 JNaviCoreConfig.DEBUG为true的情况下可用
  - isEnabled
```
public int isEnabled()
```
    判断授权验证模块当前是否开启
    
    返回:
    
    模块开启状态，见Auth.AuthDisable
    
    另请参阅:
    
    enable(int)
    
    Notice:
    
    注意：此方法仅在debug模式下可用，即 JNaviCoreConfig.DEBUG为true的情况下可用
  - getLimitations
```
public Auth.Limitations getLimitations()
```
    获取数据授权中版本限制信息Auth.Limitations
    
    返回:
    
    如果获取成功则返回Auth.Limitations对象实例，否则返回null

类 Auth

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getInstance

isInited

init

cleanup

setListener

updateLicense

updateLicenseWithParamString

setServerUrlBase

dataIsAvailable

getDataPermissionState

getDataInfo

getAllDataInfo

checkLicense

reloadLicense

getLicenseUpdateTime

enable

isEnabled

getLimitations