org.granite.client.tide.server

Class ServerSession

java.lang.Object

org.granite.client.tide.server.ServerSession

All Implemented Interfaces:

ContextAware

@Named
public class ServerSession
extends java.lang.Object
implements ContextAware

ServerSession provides an API to manage all communications with the server It can be setup as a managed bean with Spring or CDI or created manually and attached to a Tide context

 ServerSession serverSession = tideContext.set(new ServerSession("/myapp", "localhost", 8080));
 
 

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerSession.DefaultStatus
static interface	ServerSession.ServiceFactory Internal SPI to define how remoting/messaging elements are created
static interface	ServerSession.Status Status notified of network related events
static interface	ServerSession.TransportExceptionListener
static interface	ServerSession.TransportIOListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_FAULT
static java.lang.String	CONTEXT_RESULT
static java.lang.String	LOGIN
static java.lang.String	LOGOUT
protected java.util.Map<java.lang.String,org.granite.client.messaging.RemoteService>	remoteServices
static java.lang.String	SERVER_TIME_TAG
static java.lang.String	SESSION_EXP_TAG
static java.lang.String	SESSION_EXPIRED
static java.lang.String	SESSION_ID_TAG
protected java.util.Map<java.lang.String,org.granite.client.messaging.TopicAgent>	topicAgents

Constructor Summary

Constructors

Constructor and Description
ServerSession()
ServerSession(org.granite.client.messaging.ServerApp serverApp) Create a server session for the specified server app
ServerSession(java.lang.String contextRoot, boolean secure, java.lang.String serverName, int serverPort) Create a server session for the specified context root and server
ServerSession(java.lang.String contextRoot, java.lang.String serverName, int serverPort) Create a server session for the specified context root and server

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ServerSession.TransportExceptionListener listener)
void	addListener(ServerSession.TransportIOListener listener)
void	addRemoteAliasPackage(java.lang.String packageName) Add a package name to scan for remote aliases
void	afterLogin() Called by Identity after login has succeeded
void	checkWaitForLogout() Notify the framework that it should wait for a async operation before effectively logging out.
java.lang.Object	convert(java.lang.Object value, java.lang.reflect.Type expectedType)
org.granite.client.messaging.ClientAliasRegistry	getAliasRegistry() Return the current alias registry for this session
org.granite.client.messaging.Consumer	getConsumer(java.lang.String destination, java.lang.String topic) Build a consumer for the default channel type and destination
org.granite.client.messaging.Consumer	getConsumer(java.lang.String destination, java.lang.String topic, java.lang.String channelType) Build a consumer for the specified channel type and destination
org.granite.util.ContentType	getContentType() Serialization type (default is JMF)
Context	getContext() Current Tide context
org.granite.client.messaging.channel.MessagingChannel	getMessagingChannel(java.lang.String channelType) Return a messaging channel for the specified type
org.granite.client.messaging.transport.Transport	getMessagingTransport() Current messaging transport
org.granite.client.messaging.Producer	getProducer(java.lang.String destination, java.lang.String topic) Build a producer for the default channel type and destination
org.granite.client.messaging.Producer	getProducer(java.lang.String destination, java.lang.String topic, java.lang.String channelType) Build a producer for the specified channel type and destination
org.granite.client.messaging.RemoteService	getRemoteService() Returns remote service for the internal destination Should generally not be used except for very advanced use, use Component instead
org.granite.client.messaging.RemoteService	getRemoteService(java.lang.String destination) Returns a remote service for the specified destination Should generally not be used except for very advanced use, use Component instead
org.granite.client.messaging.transport.Transport	getRemotingTransport() Current remoting transport
java.lang.String	getSessionId() Current remote session id
ServerSession.Status	getStatus() Status implementation
boolean	isLogoutInProgress() Is logging out ?
void	login(java.lang.String username, java.lang.String password) Implementation of login Should not be called directly, called by Identity.login(java.lang.String, java.lang.String, org.granite.client.tide.server.TideResponder<java.lang.String>)
void	login(java.lang.String username, java.lang.String password, java.nio.charset.Charset charset) Implementation of login using a specific charset for username/password encoding Should not be called directly, called by Identity.login(java.lang.String, java.lang.String, org.granite.client.tide.server.TideResponder<java.lang.String>)
void	logout(java.util.Observer logoutObserver) Implementation of logout Should not be called directly, called by Identity.logout()
void	notifyExceptionListeners(org.granite.client.messaging.transport.TransportException e)
void	notifyIOListeners(boolean busy)
void	onFaultEvent(org.granite.client.messaging.events.FaultEvent event, org.granite.client.messaging.messages.responses.FaultMessage emsg) Callback called when a remoting fault is received
void	onIssueEvent(org.granite.client.messaging.events.IssueEvent event) Callback called when a remoting failure is received
void	onResultEvent(org.granite.client.messaging.events.Event event) Callback called when a remoting response is received
void	removeConsumer(org.granite.client.messaging.Consumer consumer) Detach a consumer from the session
void	removeListener(ServerSession.TransportExceptionListener listener)
void	removeListener(ServerSession.TransportIOListener listener)
void	removeProducer(org.granite.client.messaging.Producer producer) Detach a producer from the session
void	sessionExpired() Called by Identity after session has expired
void	setChannelFactoryClass(java.lang.Class<? extends org.granite.client.messaging.channel.ChannelFactory> channelFactoryClass) Set a custom channel factory class
void	setContentType(org.granite.util.ContentType contentType) Set the serialization type
void	setContext(Context context) Set the Tide context for this server session (internal method, should be set by the context itself)
void	setDefaultChannelBuilder(org.granite.client.messaging.channel.ChannelBuilder channelBuilder) Set the default channel builder
void	setDefaultChannelType(java.lang.String channelType) Set the default channel type for messaging
void	setDefaultTimeToLive(long timeToLive) Set default time to live on all channels
void	setLogoutTimeout(long timeout)
void	setMessagingTransport(java.lang.String channelType, org.granite.client.messaging.transport.Transport transport) Set the messaging transport for the specified channel type
void	setMessagingTransport(org.granite.client.messaging.transport.Transport transport) Set the default messaging transport
void	setPlatformContext(java.lang.Object platformContext) Set the platform context for this server session
void	setRemoteAliasPackages(java.util.Set<java.lang.String> packageNames) Reset all package names to scan for remote aliases
void	setRemotingTransport(org.granite.client.messaging.transport.Transport transport) Set the remoting transport
void	setServerApp(org.granite.client.messaging.ServerApp serverApp) Set the server app for this server session
void	setServiceFactory(ServerSession.ServiceFactory serviceFactory) Set a custom service factory to create producer/consumers and remote services
void	setStatus(ServerSession.Status status) Set an implementation of the Status interface to be notified of server related information
void	start() Configure and start the server session
void	stop() Stop the server session and cleanup resources
void	tryLogout() Called after all remote operations on a component are finished.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_TIME_TAG

public static final java.lang.String SERVER_TIME_TAG

See Also:

Constant Field Values

SESSION_ID_TAG

public static final java.lang.String SESSION_ID_TAG

See Also:

Constant Field Values

SESSION_EXP_TAG

public static final java.lang.String SESSION_EXP_TAG

See Also:

Constant Field Values

CONTEXT_RESULT

public static final java.lang.String CONTEXT_RESULT

See Also:

Constant Field Values

CONTEXT_FAULT

public static final java.lang.String CONTEXT_FAULT

See Also:

Constant Field Values

LOGIN

public static final java.lang.String LOGIN

See Also:

Constant Field Values

LOGOUT

public static final java.lang.String LOGOUT

See Also:

Constant Field Values

SESSION_EXPIRED

public static final java.lang.String SESSION_EXPIRED

See Also:

Constant Field Values

remoteServices

protected java.util.Map<java.lang.String,org.granite.client.messaging.RemoteService> remoteServices

topicAgents

protected java.util.Map<java.lang.String,org.granite.client.messaging.TopicAgent> topicAgents

Constructor Detail

ServerSession

public ServerSession()
              throws java.lang.Exception

Throws:

java.lang.Exception

ServerSession

public ServerSession(java.lang.String contextRoot,
             java.lang.String serverName,
             int serverPort)

Create a server session for the specified context root and server

Parameters:

contextRoot - context root

serverName - server host name

serverPort - server port

Throws:

java.lang.Exception

ServerSession

public ServerSession(java.lang.String contextRoot,
             boolean secure,
             java.lang.String serverName,
             int serverPort)

Create a server session for the specified context root and server

Parameters:

contextRoot - context root

secure - server app is secured (https/wss/...)

serverName - server host name

serverPort - server port

Throws:

java.lang.Exception

ServerSession

public ServerSession(org.granite.client.messaging.ServerApp serverApp)

Create a server session for the specified server app

Parameters:

serverApp - server application definition

Method Detail

getContentType

public org.granite.util.ContentType getContentType()

Serialization type (default is JMF)

Returns:

content type

setContentType

public void setContentType(org.granite.util.ContentType contentType)

Set the serialization type

Parameters:

contentType - serialization type

setDefaultChannelBuilder

public void setDefaultChannelBuilder(org.granite.client.messaging.channel.ChannelBuilder channelBuilder)

Set the default channel builder

Parameters:

channelBuilder - channel builder

setDefaultChannelType

public void setDefaultChannelType(java.lang.String channelType)

Set the default channel type for messaging

Parameters:

channelType - channel type

setChannelFactoryClass

public void setChannelFactoryClass(java.lang.Class<? extends org.granite.client.messaging.channel.ChannelFactory> channelFactoryClass)

Set a custom channel factory class

Parameters:

channelFactoryClass - channel factory class

setServerApp

public void setServerApp(org.granite.client.messaging.ServerApp serverApp)

Set the server app for this server session

Parameters:

serverApp - server application definition

setLogoutTimeout

public void setLogoutTimeout(long timeout)

setContext

public void setContext(Context context)

Set the Tide context for this server session (internal method, should be set by the context itself)

Specified by:

setContext in interface ContextAware

Parameters:

context - Tide context

See Also:

ContextAware

getContext

public Context getContext()

Current Tide context

Returns:

Tide context

setPlatformContext

public void setPlatformContext(java.lang.Object platformContext)

Set the platform context for this server session

Parameters:

platformContext -

setStatus

public void setStatus(ServerSession.Status status)

Set an implementation of the Status interface to be notified of server related information

Parameters:

status - status

getStatus

public ServerSession.Status getStatus()

Status implementation

Returns:

status

setRemotingTransport

public void setRemotingTransport(org.granite.client.messaging.transport.Transport transport)

Set the remoting transport

Parameters:

transport - remoting transport

setMessagingTransport

public void setMessagingTransport(org.granite.client.messaging.transport.Transport transport)

Set the default messaging transport

Parameters:

transport - messaging transport

setMessagingTransport

public void setMessagingTransport(java.lang.String channelType,
                         org.granite.client.messaging.transport.Transport transport)

Set the messaging transport for the specified channel type

Parameters:

channelType - channel type

addRemoteAliasPackage

public void addRemoteAliasPackage(java.lang.String packageName)

Add a package name to scan for remote aliases

Parameters:

packageName - package name

setRemoteAliasPackages

public void setRemoteAliasPackages(java.util.Set<java.lang.String> packageNames)

Reset all package names to scan for remote aliases

Parameters:

packageNames - package names

getAliasRegistry

public org.granite.client.messaging.ClientAliasRegistry getAliasRegistry()

Return the current alias registry for this session

Returns:

alias registry

convert

public java.lang.Object convert(java.lang.Object value,
                       java.lang.reflect.Type expectedType)

start

public void start()

Configure and start the server session

stop

public void stop()

Stop the server session and cleanup resources

setServiceFactory

public void setServiceFactory(ServerSession.ServiceFactory serviceFactory)

Set a custom service factory to create producer/consumers and remote services

Parameters:

serviceFactory - service factory

getRemoteService

public org.granite.client.messaging.RemoteService getRemoteService()

Returns remote service for the internal destination Should generally not be used except for very advanced use, use Component instead

Returns:

internal remote service

getRemoteService

public org.granite.client.messaging.RemoteService getRemoteService(java.lang.String destination)

Returns a remote service for the specified destination Should generally not be used except for very advanced use, use Component instead

Parameters:

destination - destination name

Returns:

remote service

getMessagingChannel

public org.granite.client.messaging.channel.MessagingChannel getMessagingChannel(java.lang.String channelType)

Return a messaging channel for the specified type

Parameters:

channelType - channel type

Returns:

messaging channel

See Also:

ChannelType

getConsumer

public org.granite.client.messaging.Consumer getConsumer(java.lang.String destination,
                                                java.lang.String topic,
                                                java.lang.String channelType)

Build a consumer for the specified channel type and destination

Parameters:

destination - destination name

topic - subtopic

channelType - channel type

Returns:

consumer

getConsumer

public org.granite.client.messaging.Consumer getConsumer(java.lang.String destination,
                                                java.lang.String topic)

Build a consumer for the default channel type and destination

Parameters:

destination - destination name

topic - subtopic

Returns:

consumer

removeConsumer

public void removeConsumer(org.granite.client.messaging.Consumer consumer)

Detach a consumer from the session

Parameters:

consumer - consumer

Throws:

java.lang.IllegalArgumentException - when the consumer has not been created from the session

getProducer

public org.granite.client.messaging.Producer getProducer(java.lang.String destination,
                                                java.lang.String topic,
                                                java.lang.String channelType)

Build a producer for the specified channel type and destination

Parameters:

destination - destination name

topic - subtopic

channelType - channel type

Returns:

producer

getProducer

public org.granite.client.messaging.Producer getProducer(java.lang.String destination,
                                                java.lang.String topic)

Build a producer for the default channel type and destination

Parameters:

destination - destination name

topic - subtopic

Returns:

producer

removeProducer

public void removeProducer(org.granite.client.messaging.Producer producer)

Detach a producer from the session

Parameters:

producer - producer

Throws:

java.lang.IllegalArgumentException - when the producer has not been created from the session

getSessionId

public java.lang.String getSessionId()

Current remote session id

Returns:

session id

isLogoutInProgress

public boolean isLogoutInProgress()

Is logging out ?

Returns:

true if logout in progress

onResultEvent

public void onResultEvent(org.granite.client.messaging.events.Event event)

Callback called when a remoting response is received

Parameters:

event - event

onFaultEvent

public void onFaultEvent(org.granite.client.messaging.events.FaultEvent event,
                org.granite.client.messaging.messages.responses.FaultMessage emsg)

Callback called when a remoting fault is received

Parameters:

event - fault event

emsg - fault message

onIssueEvent

public void onIssueEvent(org.granite.client.messaging.events.IssueEvent event)

Callback called when a remoting failure is received

Parameters:

event - failure event

getRemotingTransport

public org.granite.client.messaging.transport.Transport getRemotingTransport()

Current remoting transport

Returns:

remoting transport

getMessagingTransport

public org.granite.client.messaging.transport.Transport getMessagingTransport()

Current messaging transport

Returns:

messaging transport

login

public void login(java.lang.String username,
         java.lang.String password)

Implementation of login Should not be called directly, called by Identity.login(java.lang.String, java.lang.String, org.granite.client.tide.server.TideResponder<java.lang.String>)

Parameters:

username - user name

password - password

login

public void login(java.lang.String username,
         java.lang.String password,
         java.nio.charset.Charset charset)

Implementation of login using a specific charset for username/password encoding Should not be called directly, called by Identity.login(java.lang.String, java.lang.String, org.granite.client.tide.server.TideResponder<java.lang.String>)

Parameters:

username - user name

password - password

charset - charset used for encoding

afterLogin

public void afterLogin()

Called by Identity after login has succeeded

sessionExpired

public void sessionExpired()

Called by Identity after session has expired

logout

public void logout(java.util.Observer logoutObserver)

Implementation of logout Should not be called directly, called by Identity.logout()

Parameters:

logoutObserver - observer that will be notified of logout result

checkWaitForLogout

public void checkWaitForLogout()

Notify the framework that it should wait for a async operation before effectively logging out. Only if a logout has been requested.

tryLogout

public void tryLogout()

Called after all remote operations on a component are finished. The actual logout is done when all remote operations on all components have been notified as finished.

setDefaultTimeToLive

public void setDefaultTimeToLive(long timeToLive)

Set default time to live on all channels

Parameters:

timeToLive - time to live in milliseconds

addListener

public void addListener(ServerSession.TransportIOListener listener)

removeListener

public void removeListener(ServerSession.TransportIOListener listener)

addListener

public void addListener(ServerSession.TransportExceptionListener listener)

removeListener

public void removeListener(ServerSession.TransportExceptionListener listener)

notifyIOListeners

public void notifyIOListeners(boolean busy)

notifyExceptionListeners

public void notifyExceptionListeners(org.granite.client.messaging.transport.TransportException e)