1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
import com.smartdevicelink.proxy.RPCStruct;
import java.util.Hashtable;
/**
* Change in permissions for a given set of RPCs
*
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Param Name</th>
* <th>Type</th>
* <th>Description</th>
* <th> Req.</th>
* <th>Notes</th>
* <th>Version Available</th>
* </tr>
* <tr>
* <td>rpcName</td>
* <td>String</td>
* <td>Name of the individual RPC in the policy table.</td>
* <td></td>
* <td>maxlength:100</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* <tr>
* <td>hmiPermissions</td>
* <td>HMIPermissions</td>
* <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
* <td></td>
* <td></td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
*
* <tr>
* <td>parameterPermissions</td>
* <td>ParameterPermissions</td>
* <td>Sets of parameters, which are permitted or prohibited for the given RPC.</td>
* <td></td>
* <td></td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
*
* @since SmartDeviceLink 2.0
*/
public class PermissionItem extends RPCStruct {
public static final String KEY_RPC_NAME = "rpcName";
public static final String KEY_HMI_PERMISSIONS = "hmiPermissions";
public static final String KEY_PARAMETER_PERMISSIONS = "parameterPermissions";
public static final String KEY_REQUIRE_ENCRYPTION = "requireEncryption";
/**
* Constructs a new PermissionItem object
*/
public PermissionItem(@NonNull String rpcName, @NonNull HMIPermissions hmiPermissions, @NonNull ParameterPermissions parameterPermissions) {
this();
setRpcName(rpcName);
setHMIPermissions(hmiPermissions);
setParameterPermissions(parameterPermissions);
}
/**
* Constructs a new PermissionItem object indicated by the Hashtable
* parameter
*
* @param hash The Hashtable to use
*/
public PermissionItem(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a new PermissionItem object
*/
public PermissionItem() {
}
public String getRpcName() {
return getString(KEY_RPC_NAME);
}
public PermissionItem setRpcName(@NonNull String rpcName) {
setValue(KEY_RPC_NAME, rpcName);
return this;
}
public HMIPermissions getHMIPermissions() {
return (HMIPermissions) getObject(HMIPermissions.class, KEY_HMI_PERMISSIONS);
}
public PermissionItem setHMIPermissions(@NonNull HMIPermissions hmiPermissions) {
setValue(KEY_HMI_PERMISSIONS, hmiPermissions);
return this;
}
public ParameterPermissions getParameterPermissions() {
return (ParameterPermissions) getObject(ParameterPermissions.class, KEY_PARAMETER_PERMISSIONS);
}
public PermissionItem setParameterPermissions(@NonNull ParameterPermissions parameterPermissions) {
setValue(KEY_PARAMETER_PERMISSIONS, parameterPermissions);
return this;
}
/**
* Gets the encryption requirement for this item
*
* @return true is encryption is required, false otherwise
*/
public Boolean getRequireEncryption() {
return (Boolean) getValue(KEY_REQUIRE_ENCRYPTION);
}
/**
* Sets the encryption requirement for this item
*
* @param isRequired the boolean requirement to be set
*/
public PermissionItem setRequireEncryption(Boolean isRequired) {
setValue(KEY_REQUIRE_ENCRYPTION, isRequired);
return this;
}
}
|
