com.smartdevicelink.proxy.rpc

Class PermissionItem

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.PermissionItem

All Implemented Interfaces:

Cloneable

public class PermissionItem
extends RPCStruct

Change in permissions for a given set of RPCs

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
rpcName	String	Name of the individual RPC in the policy table.		maxlength:100	SmartDeviceLink 2.0
hmiPermissions	HMIPermissions	Sets of parameters, which are permitted or prohibited for the given RPC.			SmartDeviceLink 2.0
parameterPermissions	ParameterPermissions	Sets of parameters, which are permitted or prohibited for the given RPC.			SmartDeviceLink 2.0

Since:

SmartDeviceLink 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_HMI_PERMISSIONS
static String	KEY_PARAMETER_PERMISSIONS
static String	KEY_REQUIRE_ENCRYPTION
static String	KEY_RPC_NAME

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
PermissionItem() Constructs a new PermissionItem object
PermissionItem(Hashtable<String,Object> hash) Constructs a new PermissionItem object indicated by the Hashtable parameter
PermissionItem(String rpcName, HMIPermissions hmiPermissions, ParameterPermissions parameterPermissions) Constructs a new PermissionItem object

Method Summary

Modifier and Type	Method and Description
HMIPermissions	getHMIPermissions()
ParameterPermissions	getParameterPermissions()
Boolean	getRequireEncryption() Gets the encryption requirement for this item
String	getRpcName()
PermissionItem	setHMIPermissions(HMIPermissions hmiPermissions)
PermissionItem	setParameterPermissions(ParameterPermissions parameterPermissions)
PermissionItem	setRequireEncryption(Boolean isRequired) Sets the encryption requirement for this item
PermissionItem	setRpcName(String rpcName)

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_RPC_NAME

public static final String KEY_RPC_NAME

See Also:

Constant Field Values

KEY_HMI_PERMISSIONS

public static final String KEY_HMI_PERMISSIONS

See Also:

Constant Field Values

KEY_PARAMETER_PERMISSIONS

public static final String KEY_PARAMETER_PERMISSIONS

See Also:

Constant Field Values

KEY_REQUIRE_ENCRYPTION

public static final String KEY_REQUIRE_ENCRYPTION

See Also:

Constant Field Values

Constructor Detail

PermissionItem

public PermissionItem(@NonNull
                      String rpcName,
                      @NonNull
                      HMIPermissions hmiPermissions,
                      @NonNull
                      ParameterPermissions parameterPermissions)

Constructs a new PermissionItem object

PermissionItem

public PermissionItem(Hashtable<String,Object> hash)

Constructs a new PermissionItem object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

PermissionItem

public PermissionItem()

Constructs a new PermissionItem object

Method Detail

getRpcName

public String getRpcName()

setRpcName

public PermissionItem setRpcName(@NonNull
                                 String rpcName)

getHMIPermissions

public HMIPermissions getHMIPermissions()

setHMIPermissions

public PermissionItem setHMIPermissions(@NonNull
                                        HMIPermissions hmiPermissions)

getParameterPermissions

public ParameterPermissions getParameterPermissions()

setParameterPermissions

public PermissionItem setParameterPermissions(@NonNull
                                              ParameterPermissions parameterPermissions)

getRequireEncryption

public Boolean getRequireEncryption()

Gets the encryption requirement for this item

Returns:

true is encryption is required, false otherwise

setRequireEncryption

public PermissionItem setRequireEncryption(Boolean isRequired)

Sets the encryption requirement for this item

Parameters:

isRequired - the boolean requirement to be set