com.viaoa.sync

Class OASyncDelegate

java.lang.Object

com.viaoa.sync.OASyncDelegate

Direct Known Subclasses:

OASync

public class OASyncDelegate
extends Object

OASync is a group of classes that use OAObject/Hub (observable) and RemoteMultiplexer classes (distributed) to perform remote updating. Used for the OA distributed, synchronization that keeps OAObject/Models/Hubs/etc in sync across multiple servers. This is used to: determine if an app is a client or server, to know it's connection information, used by OAObject for prop changes, etc, used by Hub for add/remove/etc changes, to know if the current thread is an OARemoteThread that is processing a sync message, to get the current RequestInfo, which is the currently executing remote method call This is internally used by OA to keep application models synchronized between the server and 0 or more clients.

Author:

vvia

Field Summary

Fields

Modifier and Type	Field and Description
static Package	ObjectPackage

Constructor Summary

Constructors

Constructor and Description
OASyncDelegate()

Method Summary

Modifier and Type	Method and Description
static int	getConnectionId()
static int	getConnectionId(Package p) The connectionId (multiplexer)
static int	getObjectGuid(Class c) Used by OAObject so that object guid is created/managed on the server.
static int	getObjectGuid(Package p)
static Package	getPackage(Class c)
static RemoteClientInterface	getRemoteClient()
static RemoteClientInterface	getRemoteClient(Class c)
static RemoteClientInterface	getRemoteClient(Hub h)
static RemoteClientInterface	getRemoteClient(OAObject obj)
static RemoteClientInterface	getRemoteClient(Package p)
static RemoteServerInterface	getRemoteServer()
static RemoteServerInterface	getRemoteServer(Class c)
static RemoteServerInterface	getRemoteServer(Hub h)
static RemoteServerInterface	getRemoteServer(OAObject obj)
static RemoteServerInterface	getRemoteServer(Package p)
static RemoteSessionInterface	getRemoteSession()
static RemoteSessionInterface	getRemoteSession(Class c)
static RemoteSessionInterface	getRemoteSession(Hub h)
static RemoteSessionInterface	getRemoteSession(OAObject obj)
static RemoteSessionInterface	getRemoteSession(Package p)
static RemoteSyncInterface	getRemoteSync()
static RemoteSyncInterface	getRemoteSync(Class c)
static RemoteSyncInterface	getRemoteSync(Hub h)
static RemoteSyncInterface	getRemoteSync(OAObject obj)
static RemoteSyncInterface	getRemoteSync(Package p)
static int	getRequestConnectionId() If the current thread is an OARemoteThread, then this will return the connection Id of the client.
static RequestInfo	getRequestInfo() If the current thread is an OARemoteThread, then this will return information about the currently processed sync message.
static boolean	getSuppressCSMessages()
static OASyncClient	getSyncClient()
static OASyncClient	getSyncClient(Class c)
static OASyncClient	getSyncClient(Hub h)
static OASyncClient	getSyncClient(OAObject obj)
static OASyncClient	getSyncClient(Package p)
static OASyncServer	getSyncServer()
static OASyncServer	getSyncServer(Class c)
static OASyncServer	getSyncServer(Hub h)
static OASyncServer	getSyncServer(OAObject obj)
static OASyncServer	getSyncServer(Package p)
static boolean	isClient(Class c)
static boolean	isClient(OAObject obj)
static boolean	isClient(Package p)
static boolean	isConnected()
static boolean	isConnected(Class c)
static boolean	isConnected(OAObject obj)
static boolean	isConnected(Package p)
static boolean	isRemoteThread() Used to determine if the current thread is OARemoteThread, which is used to process sync messages.
static boolean	isServer()
static boolean	isServer(Class c)
static boolean	isServer(Hub h)
static boolean	isServer(OAObject obj)
static boolean	isServer(Package p)
static boolean	isSingleUser()
static boolean	isSingleUser(Class c)
static boolean	isSingleUser(Hub h)
static boolean	isSingleUser(Package p)
static boolean	sendMessages() If the currentThread is an OARemoteThead, then this is used to have sync changes (OAObject/Hub) sent to other computers.
static boolean	sendMessages(boolean b)
static void	setLoading()
static void	setLoading(boolean b)
static void	setRemoteClient(Package p, RemoteClientInterface rc)
static void	setRemoteClient(RemoteClientInterface rc)
static void	setRemoteServer(Package p, RemoteServerInterface rs)
static void	setRemoteServer(RemoteServerInterface rs)
static void	setRemoteSession(Package p, RemoteSessionInterface rs)
static void	setRemoteSession(RemoteSessionInterface rs)
static void	setRemoteSync(Package p, RemoteSyncInterface rs)
static void	setRemoteSync(RemoteSyncInterface rs)
static void	setSuppressCSMessages(boolean b)
static void	setSyncClient(OASyncClient sc)
static void	setSyncClient(Package p, OASyncClient sc)
static void	setSyncServer(OASyncServer ss)
static void	setSyncServer(Package p, OASyncServer ss)
static boolean	shouldSendMessages() Checks to see if any sync changes will be sent to other computers.

Methods inherited from class java.lang.Object

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

Field Detail

ObjectPackage

public static final Package ObjectPackage

Constructor Detail

OASyncDelegate

public OASyncDelegate()

Method Detail

getPackage

public static Package getPackage(Class c)

getSyncServer

public static OASyncServer getSyncServer()

getSyncServer

public static OASyncServer getSyncServer(Class c)

getSyncServer

public static OASyncServer getSyncServer(OAObject obj)

getSyncServer

public static OASyncServer getSyncServer(Hub h)

getSyncServer

public static OASyncServer getSyncServer(Package p)

setSyncServer

public static void setSyncServer(OASyncServer ss)

setSyncServer

public static void setSyncServer(Package p,
                                 OASyncServer ss)

getSyncClient

public static OASyncClient getSyncClient()

getSyncClient

public static OASyncClient getSyncClient(Class c)

getSyncClient

public static OASyncClient getSyncClient(OAObject obj)

getSyncClient

public static OASyncClient getSyncClient(Hub h)

getSyncClient

public static OASyncClient getSyncClient(Package p)

setSyncClient

public static void setSyncClient(OASyncClient sc)

setSyncClient

public static void setSyncClient(Package p,
                                 OASyncClient sc)

getRemoteServer

public static RemoteServerInterface getRemoteServer()

getRemoteServer

public static RemoteServerInterface getRemoteServer(Class c)

getRemoteServer

public static RemoteServerInterface getRemoteServer(OAObject obj)

getRemoteServer

public static RemoteServerInterface getRemoteServer(Hub h)

getRemoteServer

public static RemoteServerInterface getRemoteServer(Package p)

setRemoteServer

public static void setRemoteServer(RemoteServerInterface rs)

setRemoteServer

public static void setRemoteServer(Package p,
                                   RemoteServerInterface rs)

getRemoteSession

public static RemoteSessionInterface getRemoteSession()

getRemoteSession

public static RemoteSessionInterface getRemoteSession(Class c)

getRemoteSession

public static RemoteSessionInterface getRemoteSession(OAObject obj)

getRemoteSession

public static RemoteSessionInterface getRemoteSession(Hub h)

getRemoteSession

public static RemoteSessionInterface getRemoteSession(Package p)

setRemoteSession

public static void setRemoteSession(RemoteSessionInterface rs)

setRemoteSession

public static void setRemoteSession(Package p,
                                    RemoteSessionInterface rs)

getRemoteClient

public static RemoteClientInterface getRemoteClient()

getRemoteClient

public static RemoteClientInterface getRemoteClient(Class c)

getRemoteClient

public static RemoteClientInterface getRemoteClient(OAObject obj)

getRemoteClient

public static RemoteClientInterface getRemoteClient(Hub h)

getRemoteClient

public static RemoteClientInterface getRemoteClient(Package p)

setRemoteClient

public static void setRemoteClient(RemoteClientInterface rc)

setRemoteClient

public static void setRemoteClient(Package p,
                                   RemoteClientInterface rc)

getRemoteSync

public static RemoteSyncInterface getRemoteSync()

getRemoteSync

public static RemoteSyncInterface getRemoteSync(Class c)

getRemoteSync

public static RemoteSyncInterface getRemoteSync(OAObject obj)

getRemoteSync

public static RemoteSyncInterface getRemoteSync(Hub h)

getRemoteSync

public static RemoteSyncInterface getRemoteSync(Package p)

setRemoteSync

public static void setRemoteSync(RemoteSyncInterface rs)

setRemoteSync

public static void setRemoteSync(Package p,
                                 RemoteSyncInterface rs)

getConnectionId

public static int getConnectionId(Package p)

The connectionId (multiplexer)

getConnectionId

public static int getConnectionId()

isServer

public static boolean isServer()

Returns:

if OASyncServer has been created.

isServer

public static boolean isServer(Class c)

isServer

public static boolean isServer(OAObject obj)

isServer

public static boolean isServer(Hub h)

isServer

public static boolean isServer(Package p)

isClient

public static boolean isClient(Class c)

Returns:

if OASyncClient has been created.

isClient

public static boolean isClient(Package p)

isClient

public static boolean isClient(OAObject obj)

isSingleUser

public static boolean isSingleUser()

isSingleUser

public static boolean isSingleUser(Class c)

isSingleUser

public static boolean isSingleUser(Hub h)

isSingleUser

public static boolean isSingleUser(Package p)

isConnected

public static boolean isConnected()

isConnected

public static boolean isConnected(Class c)

isConnected

public static boolean isConnected(OAObject obj)

isConnected

public static boolean isConnected(Package p)

Returns:

true if OASyncClient has been created and is connected to the server.

getObjectGuid

public static int getObjectGuid(Class c)

Used by OAObject so that object guid is created/managed on the server.

getObjectGuid

public static int getObjectGuid(Package p)

sendMessages

public static boolean sendMessages()

If the currentThread is an OARemoteThead, then this is used to have sync changes (OAObject/Hub) sent to other computers. By default, all msgs processed by OARemoteThreads will not send out any sync changes to other computers (since they will receive the same msg). This will set a flag in the current OARemoteThread to allow any further changes during the current msg processing to be sent to the server/other clients. see OARemoteThread

sendMessages

public static boolean sendMessages(boolean b)

isRemoteThread

public static boolean isRemoteThread()

Used to determine if the current thread is OARemoteThread, which is used to process sync messages.

shouldSendMessages

public static boolean shouldSendMessages()

Checks to see if any sync changes will be sent to other computers. This will be true if the current thread is not an OARemoteThread, or if sendMessages([true]) was set.

setSuppressCSMessages

public static void setSuppressCSMessages(boolean b)

getSuppressCSMessages

public static boolean getSuppressCSMessages()

getRequestInfo

public static RequestInfo getRequestInfo()

If the current thread is an OARemoteThread, then this will return information about the currently processed sync message.

getRequestConnectionId

public static int getRequestConnectionId()

If the current thread is an OARemoteThread, then this will return the connection Id of the client. If not, then -1 is returned.

setLoading

public static void setLoading()

setLoading

public static void setLoading(boolean b)