oracle.wsc.android.session

Class WSCSession.Builder

java.lang.Object

oracle.wsc.android.session.WSCSession.Builder

Enclosing class:

WSCSession

public static class WSCSession.Builder
extends Object

Builder for WSCSession class.

Method Summary

Modifier and Type	Method and Description
WSCSession	build() Build a session which will start the connection process.
static WSCSession.Builder	create(URI webSocketURI) Creates a new WSCSession.Builder.
WSCSession.Builder	withConnectionCallback(WSCSession.ConnectionCallback value) With connection callback listener.
WSCSession.Builder	withContext(Object context) With android application Context.
WSCSession.Builder	withDeviceToken(String token) With device token obtained from GCM.
WSCSession.Builder	withExtHeaders(Map value) With extension headers which will be sent as part of session connect.
WSCSession.Builder	withHibernationHandler(HibernationHandler handler) With hibernation handler.
WSCSession.Builder	withHttpContext(HttpContext value) With HTTP context.
WSCSession.Builder	withIceServerConfig(IceServerConfig config) With ICE server configuration.
WSCSession.Builder	withObserver(WSCSession.Observer value) With observer.
WSCSession.Builder	withPackage(Package value) With package.
WSCSession.Builder	withProperty(String name, Object value) With property that allows configuration of various internal behaviors.
WSCSession.Builder	withServiceAuthHandler(ServiceAuthHandler handler) With service authentication handler.
WSCSession.Builder	withSessionId(String value) With session id.
WSCSession.Builder	withStateInfo(String stateInfo) With a StateInfo configuration.
WSCSession.Builder	withUserName(String value) With username which will be sent with the session connect message.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WSCSession.Builder create(URI webSocketURI)

Creates a new WSCSession.Builder.

Returns:

Builder

withConnectionCallback

public WSCSession.Builder withConnectionCallback(WSCSession.ConnectionCallback value)

With connection callback listener.

Parameters:

value - Callback object

Returns:

Builder

withHttpContext

public WSCSession.Builder withHttpContext(HttpContext value)

With HTTP context.

Parameters:

value - HTTP context

Returns:

Builder

withObserver

public WSCSession.Builder withObserver(WSCSession.Observer value)

With observer.

Parameters:

value - Observer

Returns:

Builder

withSessionId

public WSCSession.Builder withSessionId(String value)

With session id. Should only be set when attempting to rehydrate an existing session.

Parameters:

value - Session id value

Returns:

Builder

withUserName

public WSCSession.Builder withUserName(String value)

With username which will be sent with the session connect message.

Parameters:

value - Username value

Returns:

Builder

withExtHeaders

public WSCSession.Builder withExtHeaders(Map value)

With extension headers which will be sent as part of session connect.

Parameters:

value - Headers

Returns:

Builder

withProperty

public WSCSession.Builder withProperty(String name,
                                       Object value)

With property that allows configuration of various internal behaviors.

Parameters:

name - Property name; see WSCSession.PROP_* for list of properties, for example WSCSession.PROP_RECONNECT_TIME

value - Property value

Returns:

Builder

withPackage

public WSCSession.Builder withPackage(Package value)

With package.

Parameters:

value - Package

Returns:

Builder

withServiceAuthHandler

public WSCSession.Builder withServiceAuthHandler(ServiceAuthHandler handler)

With service authentication handler.

Parameters:

handler - Authentication handler

Returns:

Builder

withIceServerConfig

public WSCSession.Builder withIceServerConfig(IceServerConfig config)

With ICE server configuration.

Parameters:

config - ICE server config

Returns:

Builder

withHibernationHandler

public WSCSession.Builder withHibernationHandler(HibernationHandler handler)

With hibernation handler.

Parameters:

handler - Hibernation handler

Returns:

Builder

withContext

public WSCSession.Builder withContext(Object context)

With android application Context.

Parameters:

context - android.content.Context object from the Application

Returns:

Builder

withDeviceToken

public WSCSession.Builder withDeviceToken(String token)

With device token obtained from GCM.

Parameters:

token - unique token id

Returns:

Builder

withStateInfo

public WSCSession.Builder withStateInfo(String stateInfo)

With a StateInfo configuration.

Parameters:

stateInfo - JSON format session data String

Returns:

Builder

build

public final WSCSession build()

Build a session which will start the connection process. Success or failure will be asynchronously messaged to the WSCSession.ConnectionCallback if set.

Returns:

built session