com.ksc.live

Class KSCLiveClient

java.lang.Object

com.ksc.KscWebServiceClient

com.ksc.live.KSCLiveClient

All Implemented Interfaces:

Live

public class KSCLiveClient
extends KscWebServiceClient
implements Live

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.ksc.KscWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
KSCLiveClient() Constructs a new client to invoke service methods on EIP.
KSCLiveClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on EIP using the specified AWS account credentials.
KSCLiveClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on EIP using the specified AWS account credentials and client configuration options.
KSCLiveClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on EIP using the specified AWS account credentials provider.
KSCLiveClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on EIP using the specified AWS account credentials provider and client configuration options.
KSCLiveClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on EIP using the specified KSC account credentials provider, client configuration options, and request metric collector.
KSCLiveClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on EIP.

Method Summary

Modifier and Type	Method and Description
LiveResult	listPubStreamsInfo(GetListRequest liveRequest)

Methods inherited from class com.ksc.KscWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

KSCLiveClient

public KSCLiveClient()

Constructs a new client to invoke service methods on EIP. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the EIP metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

KSCLiveClient

public KSCLiveClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on EIP. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the EIP metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to KSC (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

KSCLiveClient

public KSCLiveClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on EIP using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

KSCLiveClient

public KSCLiveClient(AWSCredentials awsCredentials,
                     ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on EIP using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to EIP (ex: proxy settings, retry counts, etc.).

KSCLiveClient

public KSCLiveClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on EIP using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with KSC services.

KSCLiveClient

public KSCLiveClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on EIP using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with KSC services.

clientConfiguration - The client configuration options controlling how this client connects to EIP (ex: proxy settings, retry counts, etc.).

KSCLiveClient

public KSCLiveClient(AWSCredentialsProvider awsCredentialsProvider,
                     ClientConfiguration clientConfiguration,
                     RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on EIP using the specified KSC account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with KSC services.

clientConfiguration - The client configuration options controlling how this client connects to EIP (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

listPubStreamsInfo

public LiveResult listPubStreamsInfo(GetListRequest liveRequest)

Specified by:

listPubStreamsInfo in interface Live