Package com.wowza.wms.transport.media
Interface IMediaTransportResponse
public interface IMediaTransportResponse
IMediaTransportResponse
This object is provided as part of the IMediaTransportProviderListener callback.
This is an internal object/class.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addSuccessData
(String key, byte[] data) In order to provide as much flexibility as possible it is possible to add 'success' data to the response object in the form of a key and a byte array.Get the basic message for the response object.Get the command for the response object.Get the content type for the response object.getPath()
Get the path for the response object.boolean
Get the success flag from the response object.byte[]
getSuccessData
(String key) Get the success data availableGet the list of keys that the success data contains.getUUID()
Get the UUID of the object.void
setbasicMessage
(String basicMessage) Set a basic message for the response object.void
setCommand
(String command) Set the command type for the response object.void
setContentType
(String contenttype) Set the content type for the response object.void
Set the path for the response object.void
setSuccess
(boolean success) Set the success flag for the response object.void
Sets the UUID of the response object.
-
Field Details
-
RESPONSE_HEADERS
- See Also:
-
RESPONSE_INDICATOR
- See Also:
-
RESPONSE_DATA
- See Also:
-
-
Method Details
-
setUUID
Sets the UUID of the response object. This should match the IMediaTransportDataObject UUID created when it was initialised.- Parameters:
String
-
-
getUUID
String getUUID()Get the UUID of the object.- Returns:
- String
-
setPath
Set the path for the response object. This should match the IMediaTransportDataObject path setting.- Parameters:
String
-
-
getPath
String getPath()Get the path for the response object.- Returns:
- String
-
setContentType
Set the content type for the response object. This should match the IMediaTransportDataObject content type setting.- Parameters:
String
-
-
getContentType
String getContentType()Get the content type for the response object.- Returns:
- String
-
setCommand
Set the command type for the response object. This should match the IMediaTransportDataObject command setting.- Parameters:
String
-
-
getCommand
String getCommand()Get the command for the response object.- Returns:
- String
-
setbasicMessage
Set a basic message for the response object. This allows basic string messages for state to be available in the IMediaTransportProviderListener callback. A common message would be SUCCESS or FAILED.- Parameters:
String
-
-
getBasicMessage
String getBasicMessage()Get the basic message for the response object.- Returns:
- String
-
setSuccess
void setSuccess(boolean success) Set the success flag for the response object. If the transport was successful then it should be set to true.- Parameters:
boolean
-
-
getSuccess
boolean getSuccess()Get the success flag from the response object.- Returns:
- boolean
-
addSuccessData
In order to provide as much flexibility as possible it is possible to add 'success' data to the response object in the form of a key and a byte array. An example would be as follows MediaTransportConfigurationHTTP.RESPONSE_INDICATOR, String.valueOf("200").getBytes()); This is done within the MediaTransportProviderhHTTP and allows the response code 200 to be added into the success data. There are 3 defined responses, although you can add any you wish IMediaTransportProviderConfiguration.RESPONSE_INDICATOR IMediaTransportProviderConfiguration.RESPONSE_HEADERS IMediaTransportProviderConfiguration.RESPONSE_DATA- Parameters:
key
-data
-
-
getSuccessData
Get the success data available- Parameters:
String
-- Returns:
- byte[]
-
getSuccessKeyList
Get the list of keys that the success data contains.- Returns:
- List
-