com.kaazing.net.sse

Class SseEventSourceFactory

java.lang.Object

com.kaazing.net.sse.SseEventSourceFactory

public abstract class SseEventSourceFactory
extends Object

SseEventSourceFactory is an abstract class that can be used to create SseEventSources by specifying the end-point. It may be extended to instantiate particular subclasses of SseEventSource and thus provide a general framework for the addition of public SSE-level functionality.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SseEventSourceFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract SseEventSource	createEventSource(URI location) Creates a SseEventSource to connect to the target location.
static SseEventSourceFactory	createEventSourceFactory() Creates and returns a new instance of the default implementation of the SseEventSourceFactory.
abstract HttpRedirectPolicy	getDefaultFollowRedirect() Returns the default HttpRedirectPolicy that was specified at on the factory.
abstract long	getDefaultRetryTimeout() Returns the default retry timeout.
abstract void	setDefaultFollowRedirect(HttpRedirectPolicy option) Sets the default HttpRedirectPolicy that is to be inherited by all the EventSources created using this factory instance.
abstract void	setDefaultRetryTimeout(long millis) Sets the default retry timeout that is to be inherited by all the EventSources created using this factory instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

SseEventSourceFactory

protected SseEventSourceFactory()

Method Detail

createEventSourceFactory

public static SseEventSourceFactory createEventSourceFactory()

Creates and returns a new instance of the default implementation of the SseEventSourceFactory.

Returns:

SseEventSourceFactory

createEventSource

public abstract SseEventSource createEventSource(URI location)
                                          throws URISyntaxException

Creates a SseEventSource to connect to the target location.

Parameters:

location - URI of the SSE provider for the connection

Throws:

URISyntaxException

getDefaultFollowRedirect

public abstract HttpRedirectPolicy getDefaultFollowRedirect()

Returns the default HttpRedirectPolicy that was specified at on the factory. ### TODO: If this wasn't set, should we return HttpRedirectOption.NONE or null.

Returns:

HttpRedirectOption

getDefaultRetryTimeout

public abstract long getDefaultRetryTimeout()

Returns the default retry timeout. The default is 3000 milliseconds.

Returns:

retry timeout in milliseconds

setDefaultFollowRedirect

public abstract void setDefaultFollowRedirect(HttpRedirectPolicy option)

Sets the default HttpRedirectPolicy that is to be inherited by all the EventSources created using this factory instance.

Parameters:

option - HttpRedirectOption

setDefaultRetryTimeout

public abstract void setDefaultRetryTimeout(long millis)

Sets the default retry timeout that is to be inherited by all the EventSources created using this factory instance.

Parameters:

millis - retry timeout