Package com.amazonaws.kinesisvideo.internal.service

Class DefaultServiceCallbacksImpl

java.lang.Object

com.amazonaws.kinesisvideo.internal.service.DefaultServiceCallbacksImpl

All Implemented Interfaces:

ServiceCallbacks

Direct Known Subclasses:

CachedInfoMultiAuthServiceCallbacksImpl, MultiAuthServiceCallbacksImpl

public class DefaultServiceCallbacksImpl
extends Object
implements ServiceCallbacks

Implementation of ServiceCallbacks

Field Summary

Fields

Modifier and Type	Field	Description
protected KinesisVideoClientConfiguration	configuration	Store the configuration
protected ScheduledExecutorService	executor	Task executor to schedule long-running tasks in an async way.
protected KinesisVideoProducer	kinesisVideoProducer	Implementation of the KinesisVideoProducer object.
protected KinesisVideoServiceClient	kinesisVideoServiceClient	Kinesis video service client to make the service calls with.
protected org.apache.logging.log4j.Logger	log	Logger to use

Constructor Summary

Constructors

Constructor	Description
DefaultServiceCallbacksImpl(org.apache.logging.log4j.Logger log, ScheduledExecutorService executor, KinesisVideoClientConfiguration configuration, KinesisVideoServiceClient kinesisVideoServiceClient)

Method Summary

Modifier and Type	Method	Description
void	addStream(KinesisVideoProducerStream kinesisVideoProducerStream)	Add a producer stream to ongoing stream list
void	createDevice(String deviceName, long callAfter, long timeout, byte[] authData, int authType, long customData)	Asynchronous call to create device
void	createStream(String deviceName, String streamName, String contentType, String kmsKeyId, long retentionPeriod, long callAfter, long timeout, byte[] authData, int authType, KinesisVideoProducerStream stream)	Asynchronous call to create stream with the specified parameters.
void	describeStream(String streamName, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to describe stream with the specified parameters.
void	deviceCertToToken(String deviceName, long callAfter, long timeout, byte[] authData, int authType, long customData)	Asynchronous call to device certificate to token API.
void	free()	Frees the callbacks object.
protected static KinesisVideoCredentialsProvider	getCredentialsProvider(byte[] authData, org.apache.logging.log4j.Logger log)
protected static int	getStatusCodeFromException(Throwable e)	Returns the status code of an exception.
void	getStreamingEndpoint(String streamName, String apiName, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to get streaming endpoint with the specified parameters.
void	getStreamingToken(String streamName, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to get streaming token
void	initialize(KinesisVideoProducer kinesisVideoProducer)	Initializes the object
boolean	isInitialized()	Returns whether the object is initialized
protected void	notifyCallResult(KinesisVideoProducerStream stream, String methodName, ProducerException ex)	Post the exception onto the StreamCallbacks.streamErrorReport(long, long, long) callback so the application can decide what to do with the error.
void	putStream(String streamName, String containerType, long streamStartTime, boolean absoluteFragmentTimes, boolean ackRequired, String dataEndpoint, long callAfter, long timeout, byte[] authData, int authType, KinesisVideoProducerStream kinesisVideoProducerStream)	Asynchronous call to put stream API
void	removeStream(KinesisVideoProducerStream kinesisVideoProducerStream)	Removes a producer stream to ongoing stream list
void	tagResource(String resourceArn, Tag[] tags, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to tag resource API

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

executor

protected final ScheduledExecutorService executor

Task executor to schedule long-running tasks in an async way.

kinesisVideoServiceClient

protected final KinesisVideoServiceClient kinesisVideoServiceClient

Kinesis video service client to make the service calls with.

log

protected final org.apache.logging.log4j.Logger log

Logger to use

configuration

protected final KinesisVideoClientConfiguration configuration

Store the configuration

kinesisVideoProducer

protected KinesisVideoProducer kinesisVideoProducer

Implementation of the KinesisVideoProducer object.

Constructor Detail

DefaultServiceCallbacksImpl

public DefaultServiceCallbacksImpl(@Nonnull
                                   org.apache.logging.log4j.Logger log,
                                   @Nonnull
                                   ScheduledExecutorService executor,
                                   @Nonnull
                                   KinesisVideoClientConfiguration configuration,
                                   @Nonnull
                                   KinesisVideoServiceClient kinesisVideoServiceClient)

Method Detail

initialize

public void initialize(@Nonnull
                       KinesisVideoProducer kinesisVideoProducer)

Initializes the object

Specified by:

initialize in interface ServiceCallbacks

Parameters:

kinesisVideoProducer - Reference to KinesisVideoProducer for the eventing.

isInitialized

public boolean isInitialized()

Description copied from interface: ServiceCallbacks

Returns whether the object is initialized

Specified by:

isInitialized in interface ServiceCallbacks

Returns:

whether the object is initialized

createStream

public void createStream(@Nonnull
                         String deviceName,
                         @Nonnull
                         String streamName,
                         @Nonnull
                         String contentType,
                         @Nullable
                         String kmsKeyId,
                         long retentionPeriod,
                         long callAfter,
                         long timeout,
                         @Nullable
                         byte[] authData,
                         int authType,
                         KinesisVideoProducerStream stream)
                  throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to create stream with the specified parameters. PIC will attempt to schedule stream creation if the ServiceCallbacks.describeStream(String, long, long, byte[], int, long, KinesisVideoProducerStream) posts a KinesisVideoProducer.describeStreamResult(KinesisVideoProducerStream, long, StreamDescription, int) of 404 (Resource Not Found). This call will be skipped if StreamInfo.isAllowStreamCreation() is not allowed.

This method will notify PIC the success or failure of the operation via KinesisVideoProducer.createStreamResult(KinesisVideoProducerStream, String, int).

Specified by:

createStream in interface ServiceCallbacks

Parameters:

deviceName - - Device name

streamName - - Stream name

contentType - - Stream content type

kmsKeyId - - KMS Key Id

retentionPeriod - - Stream retention period - 100ns

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

stream - - stream object for the result event callback

Throws:

ProducerException

See Also:

CreateStream API

describeStream

public void describeStream(@Nonnull
                           String streamName,
                           long callAfter,
                           long timeout,
                           @Nullable
                           byte[] authData,
                           int authType,
                           long streamHandle,
                           KinesisVideoProducerStream stream)
                    throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to describe stream with the specified parameters.

This method will notify PIC the success or failure of the operation via KinesisVideoProducer.describeStreamResult(KinesisVideoProducerStream, long, StreamDescription, int)

Specified by:

describeStream in interface ServiceCallbacks

Parameters:

streamName - - Stream name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

See Also:

DescribeStream API

getStreamingEndpoint

public void getStreamingEndpoint(@Nonnull
                                 String streamName,
                                 @Nonnull
                                 String apiName,
                                 long callAfter,
                                 long timeout,
                                 @Nullable
                                 byte[] authData,
                                 int authType,
                                 long streamHandle,
                                 KinesisVideoProducerStream stream)
                          throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to get streaming endpoint with the specified parameters.

This method will notify PIC the success or failure of the operation via KinesisVideoProducer.getStreamingEndpointResult(KinesisVideoProducerStream, long, String, int).

Specified by:

getStreamingEndpoint in interface ServiceCallbacks

Parameters:

streamName - - Stream name

apiName - - API name to call

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

See Also:

GetDataEndpoint API

getStreamingToken

public void getStreamingToken(@Nonnull
                              String streamName,
                              long callAfter,
                              long timeout,
                              @Nullable
                              byte[] authData,
                              int authType,
                              long streamHandle,
                              KinesisVideoProducerStream stream)
                       throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to get streaming token

Specified by:

getStreamingToken in interface ServiceCallbacks

Parameters:

streamName - - Stream name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

putStream

public void putStream(@Nonnull
                      String streamName,
                      @Nonnull
                      String containerType,
                      long streamStartTime,
                      boolean absoluteFragmentTimes,
                      boolean ackRequired,
                      @Nonnull
                      String dataEndpoint,
                      long callAfter,
                      long timeout,
                      @Nullable
                      byte[] authData,
                      int authType,
                      KinesisVideoProducerStream kinesisVideoProducerStream)
               throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to put stream API

Specified by:

putStream in interface ServiceCallbacks

Parameters:

streamName - - Stream name

containerType - - Container type

streamStartTime - - Stream start timestamp

absoluteFragmentTimes - - Whether to use absolute fragment times

ackRequired - - Whether an application level ACK is required

dataEndpoint - - The streaming endpoint to use

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

kinesisVideoProducerStream - - stream object for the result event callback

Throws:

ProducerException

tagResource

public void tagResource(@Nonnull
                        String resourceArn,
                        @Nullable
                        Tag[] tags,
                        long callAfter,
                        long timeout,
                        @Nullable
                        byte[] authData,
                        int authType,
                        long streamHandle,
                        KinesisVideoProducerStream stream)
                 throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to tag resource API

Specified by:

tagResource in interface ServiceCallbacks

Parameters:

resourceArn - - Resource ARN

tags - - Tags to apply

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

createDevice

public void createDevice(@Nonnull
                         String deviceName,
                         long callAfter,
                         long timeout,
                         @Nullable
                         byte[] authData,
                         int authType,
                         long customData)
                  throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to create device

Specified by:

createDevice in interface ServiceCallbacks

Parameters:

deviceName - - Device name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

customData - - Custom data to use to call the event functions

Throws:

ProducerException

deviceCertToToken

public void deviceCertToToken(@Nonnull
                              String deviceName,
                              long callAfter,
                              long timeout,
                              @Nullable
                              byte[] authData,
                              int authType,
                              long customData)
                       throws ProducerException

Description copied from interface: ServiceCallbacks

Asynchronous call to device certificate to token API. Called when AuthType is AUTH_INFO_TYPE_CERT.

Specified by:

deviceCertToToken in interface ServiceCallbacks

Parameters:

deviceName - - Device name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

customData - - Custom data to use to call the event functions

Throws:

ProducerException

free

public void free()

Description copied from interface: ServiceCallbacks

Frees the callbacks object.

Specified by:

free in interface ServiceCallbacks

addStream

public void addStream(@Nonnull
                      KinesisVideoProducerStream kinesisVideoProducerStream)

Description copied from interface: ServiceCallbacks

Add a producer stream to ongoing stream list

Specified by:

addStream in interface ServiceCallbacks

Parameters:

kinesisVideoProducerStream - producer stream used by PIC

removeStream

public void removeStream(@Nonnull
                         KinesisVideoProducerStream kinesisVideoProducerStream)

Description copied from interface: ServiceCallbacks

Removes a producer stream to ongoing stream list

Specified by:

removeStream in interface ServiceCallbacks

Parameters:

kinesisVideoProducerStream - producer stream used by PIC

getCredentialsProvider

@Nullable
protected static KinesisVideoCredentialsProvider getCredentialsProvider(@Nullable
                                                                        byte[] authData,
                                                                        @Nonnull
                                                                        org.apache.logging.log4j.Logger log)

getStatusCodeFromException

protected static int getStatusCodeFromException(@Nullable
                                                Throwable e)

Returns the status code of an exception.

Parameters:

e - Throwable which was thrown by the service client

Returns:

status code corresponding to the exception

notifyCallResult

protected void notifyCallResult(@Nonnull
                                KinesisVideoProducerStream stream,
                                @Nonnull
                                String methodName,
                                @Nonnull
                                ProducerException ex)

Post the exception onto the StreamCallbacks.streamErrorReport(long, long, long) callback so the application can decide what to do with the error. The upload handle will be ReadResult.INVALID_UPLOAD_HANDLE_VALUE, and the fragment timecode will be ReadResult.ZERO_FRAGMENT_TIMECODE.

Parameters:

stream - stream that encountered the error

methodName - for logging purposes

ex - the exception that occurred

See Also:

Producer-C notifyCallResult