com.viaoa.sync

Class OASyncServer

java.lang.Object

com.viaoa.sync.OASyncServer

public class OASyncServer
extends Object

Server used to work with 1+ OASyncClients so that all OAObjects stay in sync. This allows OASyncClients to connect and lookup remote objects and have a server side session.

Author:

vvia

See Also:

OASync

Field Summary

Fields

Modifier and Type	Field and Description
static int	QueueSize
static String	ServerLookupName
static String	SyncLookupName
static String	SyncQueueName

Constructor Summary

Constructors

Constructor and Description
OASyncServer(int port)
OASyncServer(Package packagex, int port)

Method Summary

Modifier and Type	Method and Description
protected void	_runLoadDataInBackground()
protected void	afterInvokeRemoteMethod(RequestInfo ri)
Object	createBroadcast(String bindName, Class interfaceClass, String queueName, int queueSize)
Object	createBroadcast(String bindName, Object callback, Class interfaceClass, String queueName, int queueSize)
void	createLookup(String name, Object obj, Class interfaceClass)
void	createLookup(String name, Object obj, Class interfaceClass, String queueName, int queueSize)
Object	createSyncBroadcast(String bindName, Class interfaceClass)
Object	createSyncBroadcast(String bindName, Object callback, Class interfaceClass)
void	createSyncLookup(String name, Object obj, Class interfaceClass) use the same queue that is used by sync remote object.
ClientInfo	getClientInfo()
String	getDisplayMessage()
String	getInvalidConnectionMessage(String defaultMsg)
protected String	getLogFileName()
OAMultiplexerServer	getMultiplexerServer() Used to manage multiplexed socket connections from client computers.
protected RemoteClientInterface	getRemoteClient(ClientInfo ci)
protected RemoteClientInterface	getRemoteClientForServer()
OARemoteMultiplexerServer	getRemoteMultiplexerServer()
RemoteServerImpl	getRemoteServer()
protected RemoteSessionInterface	getRemoteSession(ClientInfo ci, RemoteClientCallbackInterface callback)
protected RemoteSessionInterface	getRemoteSessionForServer()
RemoteSyncImpl	getRemoteSync()
ServerFile	getServerFile()
ServerInfo	getServerInfo()
int	getSessionCount()
Socket	getSocket(int connectionId)
protected void	loadDataInBackground(OAObject obj, String property) called when props or sibling data cant be loaded for client getDetail request, because of timeout.
protected void	logRequest(RequestInfo ri)
protected void	onClientConnect(Socket socket, int connectionId)
protected void	onClientDisconnect(int connectionId)
protected void	onClientException(ClientInfo ci, String msg, Throwable ex)
protected void	onSessionCreated(int connectionId, Socket socket)
protected void	onSessionRemoved(int connectionId)
void	onUpdate(ClientInfo ci) This can be overwritten to capture info about the server and client connections.
void	performDGC()
void	saveCache(OACascade cascade, int iCascadeRule) Saved serverSide cached objects from clients.
void	setInvalidConnectionMessage(String msg)
void	start()
protected void	startLoadDataInBackgroundThread()
void	startUpdateThread(int seconds) updates ClientInfo
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

ServerLookupName

public static final String ServerLookupName

See Also:

Constant Field Values

SyncLookupName

public static final String SyncLookupName

See Also:

Constant Field Values

SyncQueueName

public static final String SyncQueueName

See Also:

Constant Field Values

QueueSize

public static final int QueueSize

See Also:

Constant Field Values

Constructor Detail

OASyncServer

public OASyncServer(int port)

OASyncServer

public OASyncServer(Package packagex,
                    int port)

Method Detail

getRemoteSync

public RemoteSyncImpl getRemoteSync()

getRemoteServer

public RemoteServerImpl getRemoteServer()

getClientInfo

public ClientInfo getClientInfo()

getRemoteSessionForServer

protected RemoteSessionInterface getRemoteSessionForServer()

getRemoteClientForServer

protected RemoteClientInterface getRemoteClientForServer()

getRemoteSession

protected RemoteSessionInterface getRemoteSession(ClientInfo ci,
                                                  RemoteClientCallbackInterface callback)

startUpdateThread

public void startUpdateThread(int seconds)

updates ClientInfo

onUpdate

public void onUpdate(ClientInfo ci)

This can be overwritten to capture info about the server and client connections. see #startServerUpdateThread(int) see OASyncClient#startClientUpdateThread(int)

getRemoteClient

protected RemoteClientInterface getRemoteClient(ClientInfo ci)

saveCache

public void saveCache(OACascade cascade,
                      int iCascadeRule)

Saved serverSide cached objects from clients.

getServerInfo

public ServerInfo getServerInfo()

setInvalidConnectionMessage

public void setInvalidConnectionMessage(String msg)

getInvalidConnectionMessage

public String getInvalidConnectionMessage(String defaultMsg)

getMultiplexerServer

public OAMultiplexerServer getMultiplexerServer()

Used to manage multiplexed socket connections from client computers.

Returns:

onClientConnect

protected void onClientConnect(Socket socket,
                               int connectionId)

onClientDisconnect

protected void onClientDisconnect(int connectionId)

getSocket

public Socket getSocket(int connectionId)

onClientException

protected void onClientException(ClientInfo ci,
                                 String msg,
                                 Throwable ex)

getDisplayMessage

public String getDisplayMessage()

getRemoteMultiplexerServer

public OARemoteMultiplexerServer getRemoteMultiplexerServer()

getSessionCount

public int getSessionCount()

onSessionCreated

protected void onSessionCreated(int connectionId,
                                Socket socket)

onSessionRemoved

protected void onSessionRemoved(int connectionId)

createLookup

public void createLookup(String name,
                         Object obj,
                         Class interfaceClass)

createSyncLookup

public void createSyncLookup(String name,
                             Object obj,
                             Class interfaceClass)

use the same queue that is used by sync remote object.

createLookup

public void createLookup(String name,
                         Object obj,
                         Class interfaceClass,
                         String queueName,
                         int queueSize)

createBroadcast

public Object createBroadcast(String bindName,
                              Class interfaceClass,
                              String queueName,
                              int queueSize)

createBroadcast

public Object createBroadcast(String bindName,
                              Object callback,
                              Class interfaceClass,
                              String queueName,
                              int queueSize)

createSyncBroadcast

public Object createSyncBroadcast(String bindName,
                                  Class interfaceClass)

createSyncBroadcast

public Object createSyncBroadcast(String bindName,
                                  Object callback,
                                  Class interfaceClass)

afterInvokeRemoteMethod

protected void afterInvokeRemoteMethod(RequestInfo ri)

logRequest

protected void logRequest(RequestInfo ri)
                   throws Exception

Throws:

Exception

getLogFileName

protected String getLogFileName()

start

public void start()
           throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

performDGC

public void performDGC()

getServerFile

public ServerFile getServerFile()

loadDataInBackground

protected void loadDataInBackground(OAObject obj,
                                    String property)

called when props or sibling data cant be loaded for client getDetail request, because of timeout. This can be overwritten to have it done in a background thread.

startLoadDataInBackgroundThread

protected void startLoadDataInBackgroundThread()
                                        throws Exception

Throws:

Exception

_runLoadDataInBackground

protected void _runLoadDataInBackground()