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
|
/*
* 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.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCRequest;
import com.smartdevicelink.proxy.rpc.enums.RequestType;
import java.util.Hashtable;
import java.util.List;
/**
* An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)
*
* <p><b>Parameter List</b></p>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>Reg.</th>
* <th>Notes</th>
* <th>Version</th>
* </tr>
* <tr>
* <td>requestType</td>
* <td>RequestType</td>
* <td>The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.</td>
* <td>Y</td>
* <td></td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* <tr>
* <td>requestSubType</td>
* <td>String</td>
* <td>This parameter is filled for supporting OEM proprietary data exchanges.</td>
* <td>N</td>
* <td>Max Length: 255</td>
* <td>SmartDeviceLink 5.0</td>
* </tr>
* <tr>
* <td>fileName</td>
* <td>String</td>
* <td>Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. </td>
* <td>N</td>
* <td>Max Length: 255</td>
* <td>SmartDeviceLink 3.0 </td>
* </tr>
* </table>
*
* @since SmartDeviceLink 3.0
*/
public class SystemRequest extends RPCRequest {
public static final String KEY_FILE_NAME = "fileName";
public static final String KEY_REQUEST_TYPE = "requestType";
public static final String KEY_REQUEST_SUB_TYPE = "requestSubType";
public static final String KEY_DATA = "data";
/**
* Constructs a new SystemRequest object
*/
public SystemRequest() {
super(FunctionID.SYSTEM_REQUEST.toString());
}
public SystemRequest(boolean bLegacy) {
super(FunctionID.ENCODED_SYNC_P_DATA.toString());
}
public SystemRequest(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a new SystemRequest object
*
* @param requestType The type of system request.
*/
public SystemRequest(@NonNull RequestType requestType) {
this();
setRequestType(requestType);
}
@SuppressWarnings("unchecked")
public List<String> getLegacyData() {
return (List<String>) getObject(String.class, KEY_DATA);
}
public SystemRequest setLegacyData(List<String> data) {
setParameters(KEY_DATA, data);
return this;
}
public String getFileName() {
return getString(KEY_FILE_NAME);
}
public SystemRequest setFileName(String fileName) {
setParameters(KEY_FILE_NAME, fileName);
return this;
}
public RequestType getRequestType() {
return (RequestType) getObject(RequestType.class, KEY_REQUEST_TYPE);
}
public SystemRequest setRequestType(@NonNull RequestType requestType) {
setParameters(KEY_REQUEST_TYPE, requestType);
return this;
}
public String getRequestSubType() {
return getString(KEY_REQUEST_SUB_TYPE);
}
public SystemRequest setRequestSubType(String requestSubType) {
setParameters(KEY_REQUEST_SUB_TYPE, requestSubType);
return this;
}
}
|
