com.smartdevicelink.proxy.rpc

Class OnSystemRequest

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnSystemRequest

All Implemented Interfaces:

Cloneable

public class OnSystemRequest
extends RPCNotification

An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud. Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)

Parameter List

Name	Type	Description	Reg.	Notes	Version
requestType	RequestType	The type of system request.	Y		SmartDeviceLink 2.3.2
requestSubType	String	This parameter is filled for supporting OEM proprietary data exchanges.	N	Max Length: 255	SmartDeviceLink 5.0
url	Array of Strings	Optional URL for HTTP requests.If blank, the binary data shall be forwarded to the app.If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.	N	minsize:1;	SmartDeviceLink 2.3.2
timeout	Integer	Optional timeout for HTTP requests;Required if a URL is provided	N	minvalue:0; maxvalue: 2000000000	SmartDeviceLink
fileType	FileType	Optional file type (meant for HTTP file requests).	N		SmartDeviceLink 2.3.2
offset	Float	Optional offset in bytes for resuming partial data chunks	N	minvalue:0; maxvalue:100000000000	SmartDeviceLink 2.3.2
length	Float	Optional length in bytes for resuming partial data chunks	N	minvalue: 0; maxvalue:100000000000	SmartDeviceLink 2.3.2

Since:

SmartDeviceLink 2.3.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BODY
static String	KEY_DATA
static String	KEY_FILE_TYPE
static String	KEY_HEADERS
static String	KEY_LENGTH
static String	KEY_OFFSET
static String	KEY_REQUEST_SUB_TYPE
static String	KEY_REQUEST_TYPE
static String	KEY_TIMEOUT
static String	KEY_TIMEOUT_V1
static String	KEY_URL
static String	KEY_URL_V1

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
OnSystemRequest() Constructs a new OnSystemsRequest object
OnSystemRequest(Hashtable<String,Object> hash)
OnSystemRequest(Hashtable<String,Object> hash, byte[] bulkData)
OnSystemRequest(RequestType requestType) Constructs a new OnSystemsRequest object

Method Summary

Modifier and Type	Method and Description
String	getBody()
FileType	getFileType()
Headers	getHeader()
List<String>	getLegacyData()
Long	getLength()
Long	getOffset()
String	getRequestSubType()
RequestType	getRequestType()
Integer	getTimeout()
String	getUrl()
OnSystemRequest	setBody(String body)
OnSystemRequest	setBulkData(byte[] bulkData)
OnSystemRequest	setFileType(FileType fileType)
OnSystemRequest	setHeaders(Headers header)
OnSystemRequest	setLength(Integer length) Deprecated. as of SmartDeviceLink 4.0. Use setLength(Long) instead.
OnSystemRequest	setLength(Long length)
OnSystemRequest	setOffset(Integer offset) Deprecated. as of SmartDeviceLink 4.0. Use setOffset(Long) instead.
OnSystemRequest	setOffset(Long offset)
OnSystemRequest	setRequestSubType(String requestSubType)
OnSystemRequest	setRequestType(RequestType requestType)
OnSystemRequest	setTimeout(Integer timeout)
OnSystemRequest	setUrl(String url)

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

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

Field Detail

KEY_URL_V1

public static final String KEY_URL_V1

See Also:

Constant Field Values

KEY_URL

public static final String KEY_URL

See Also:

Constant Field Values

KEY_TIMEOUT_V1

public static final String KEY_TIMEOUT_V1

See Also:

Constant Field Values

KEY_TIMEOUT

public static final String KEY_TIMEOUT

See Also:

Constant Field Values

KEY_HEADERS

public static final String KEY_HEADERS

See Also:

Constant Field Values

KEY_BODY

public static final String KEY_BODY

See Also:

Constant Field Values

KEY_FILE_TYPE

public static final String KEY_FILE_TYPE

See Also:

Constant Field Values

KEY_REQUEST_TYPE

public static final String KEY_REQUEST_TYPE

See Also:

Constant Field Values

KEY_REQUEST_SUB_TYPE

public static final String KEY_REQUEST_SUB_TYPE

See Also:

Constant Field Values

KEY_DATA

public static final String KEY_DATA

See Also:

Constant Field Values

KEY_OFFSET

public static final String KEY_OFFSET

See Also:

Constant Field Values

KEY_LENGTH

public static final String KEY_LENGTH

See Also:

Constant Field Values

Constructor Detail

OnSystemRequest

public OnSystemRequest()

Constructs a new OnSystemsRequest object

OnSystemRequest

public OnSystemRequest(Hashtable<String,Object> hash)

OnSystemRequest

public OnSystemRequest(Hashtable<String,Object> hash,
                       byte[] bulkData)

OnSystemRequest

public OnSystemRequest(@NonNull
                       RequestType requestType)

Constructs a new OnSystemsRequest object

Method Detail

setBulkData

public OnSystemRequest setBulkData(byte[] bulkData)

Overrides:

setBulkData in class RPCStruct

getLegacyData

public List<String> getLegacyData()

getBody

public String getBody()

setBody

public OnSystemRequest setBody(String body)

setHeaders

public OnSystemRequest setHeaders(Headers header)

getHeader

public Headers getHeader()

getRequestType

public RequestType getRequestType()

setRequestType

public OnSystemRequest setRequestType(@NonNull
                                      RequestType requestType)

getRequestSubType

public String getRequestSubType()

setRequestSubType

public OnSystemRequest setRequestSubType(String requestSubType)

getUrl

public String getUrl()

setUrl

public OnSystemRequest setUrl(String url)

getFileType

public FileType getFileType()

setFileType

public OnSystemRequest setFileType(FileType fileType)

setOffset

public OnSystemRequest setOffset(Integer offset)

Deprecated. as of SmartDeviceLink 4.0. Use setOffset(Long) instead.

Parameters:

offset - of the data attached

getOffset

public Long getOffset()

setOffset

public OnSystemRequest setOffset(Long offset)

getTimeout

public Integer getTimeout()

setTimeout

public OnSystemRequest setTimeout(Integer timeout)

getLength

public Long getLength()

setLength

public OnSystemRequest setLength(Integer length)

Deprecated. as of SmartDeviceLink 4.0. Use setLength(Long) instead.

Parameters:

length - of the data attached

setLength

public OnSystemRequest setLength(Long length)