de.ipcon.db.protocol

Interface ServerConnectionI

All Superinterfaces:

ExpiringTokenStorageProviderI, FTSTermInfoProviderI, FulltextSearcherI, L10nPackProviderI

All Known Implementing Classes:

AbstractBackendConnection, BackendConnection

public interface ServerConnectionI
extends L10nPackProviderI, FulltextSearcherI, FTSTermInfoProviderI, ExpiringTokenStorageProviderI

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0
static ServerConnectionI[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
Anmeldung	authenticate(java.lang.String username, java.lang.String pass)
void	cancelForcedClientDisconnect()
void	cancelForcedClientDisconnect(java.util.Map msgClients)
boolean	checkServerConnectivity()
boolean	checkServerConnectivity(boolean force)
void	connect() This method is called when connecting or reconnecting to a server.
void	copyRemoteBLOBsToLocalFileVault(ServerFileVaultI serverFileVault, java.util.List<java.lang.Long> pendingBLOBChangeBOIdsLocal, java.lang.Long lastAuthNodeBTId)
void	demandForcedClientDisconnect(int cSecsDelay)
void	demandForcedClientDisconnect(int cSecsDelay, java.lang.String msg)
void	demandForcedClientDisconnect(int cSecsDelay, java.lang.String msg, java.util.Map msgClients)
void	disconnect()
BatchedBackendRequestI	execute(BatchedBackendRequestI sr)
void	execute(BatchedBackendRequestI[] srs)
boolean	exists(java.lang.Long id)
boolean	exists(java.lang.Long id, java.lang.Class<? extends BOI> classtip)
java.lang.String	getAddress()
java.lang.String[]	getAvailableLocalesForUserInterface()
byte[]	getBLOB(java.lang.Long id)
long	getBLOB(java.lang.Long id, java.io.DataOutput os)
long	getBLOB(java.lang.Long id, java.io.DataOutput os, boolean closeOS)
long	getBLOB(java.lang.Long id, java.io.DataOutput os, boolean closeOS, java.lang.Long backuppingBPId)
byte[]	getBLOB(java.lang.Long id, java.lang.Long backuppingBPId)
long	getBLOB(java.lang.Long id, java.io.OutputStream os)
long	getBLOB(java.lang.Long id, java.io.OutputStream os, boolean closeOS)
long	getBLOB(java.lang.Long id, java.io.OutputStream os, boolean closeOS, java.lang.Long backuppingBPId)
VFile	getBLOBInfo(java.lang.Long id)
VFile	getBLOBInfo(java.lang.Long id, java.lang.Long backuppingBPId)
BO	getBO(java.lang.Long id)
BO	getBO(java.lang.Long id, java.lang.Class<? extends BOI> classtip)
BO[]	getBOs(long[] ids)
BO[]	getBOs(java.lang.Long[] ids)
BO[]	getBOs(long[] ids, java.lang.Class<? extends BOI> classtip)
BO[]	getBOs(java.lang.Long[] ids, java.lang.Class<? extends BOI> classtip)
ClientSessionInfo[]	getClientSessionInfos()
int	getComplexCommandsTimeoutSeconds()
int	getConciseCommandsTimeoutSeconds()
CryptoHandlerI	getCryptoHandler()
DBManInfo	getDBManInfo()
java.lang.String	getDomain()
KeyRange	getIdRange(long size)
java.lang.String[]	getInitialAvailableLocalesForUserInterface()
java.lang.String	getInstanceName()
L10nInfoContainer	getL10nPackPreload(java.lang.String locale)
java.lang.String	getL10nViaString()
Struktur[]	getLazyStruktur(java.lang.Long botId)
Benutzer	getLoggedInUser()
BackendConnectionManagerI	getManager()
int	getMaxPool()
int	getMediumCommandsTimeoutSeconds()
int	getMinPool()
java.lang.Long	getNextId()
java.lang.Long	getNodeNumber()
PermissionHandlerWithUserI	getPermissionHandler()
int	getPort()
BO[]	getRelationBOs(java.lang.Long id, java.lang.Class<? extends BOI> classtip, java.lang.String attributeName)
SchemaI	getRemoteSchema()
java.lang.String	getRemoteSchemaFingerprint()
java.lang.String	getRemoteSchemaUIDs()
java.lang.String	getRemoteSchemaVersion()
int	getRoundTrips()
ServerConnectionInfoReceiverI	getServerConnectionInfoReceiver()
java.net.InetAddress	getServerInetAddress()
java.lang.String	getServerName()
java.lang.String	getServerName(boolean evenIfNoActiveConnection)
java.lang.String	getServerUrl()
java.lang.Long	getSessionId(boolean blockUntilAvailable)
BackendSessionInfo[]	getSessionInfos()
int	getSimpleCommandsTimeoutSeconds()
java.lang.String	getSubVersion()
long	getToken()
java.lang.String	getURLPrefix()
void	handleDBManEvent(DBManEvent evt)
boolean	hasBLOB(java.lang.Long id)
boolean	hasBLOB(java.lang.Long id, java.lang.Long backuppingBPId)
boolean	hasIncompatibleServerProtocolVersion()
java.util.BitSet	haveBLOB(long[] ids)
void	initiateServerShutdown()
void	initiateServerShutdown(int cSecsDelay)
void	initiateServerShutdown(int cSecsDelay, java.lang.String msg)
void	initSession()
boolean	isConnected()
boolean	isDead()
boolean	isFTSAvailable()
boolean	isLoggedIn()
boolean	isMemoryTightClient()
boolean	isNotificationSystemActivated()
boolean	isServerAuthoritativeSyncServer()
boolean	isTls()
void	lockServer()
void	markDead()
BatchedBackendRequestI	prepareQuery(java.lang.String s)
BatchedBackendRequestI	prepareQuery(java.lang.String s, java.lang.Object[] o)
de.ipcon.db.core.QueryResultsI	query(BOQuery eq)
de.ipcon.db.core.QueryResultsI	query(java.lang.String s)
de.ipcon.db.core.QueryResultsI	query(java.lang.String s, java.lang.Object[] o)
java.util.List	queryBO(BOQuery eq)
java.util.List	queryBO(java.lang.String s)
java.util.List	queryBO(java.lang.String s, java.lang.Object[] o)
de.ipcon.db.core.QueryResultsI	queryRelation(long id, java.lang.Class<? extends BOI> classtip, java.lang.String attributeName)
void	reregisterEventsAtBackend()
void	resetPassword(java.lang.String username)
TransactionAnswer	saveBO(Transaction tx) Persists the changes recorded in the passed Transaction tx to the database.
TransactionAnswer	saveBO(Transaction tx, int lockTimeout) Persists the changes recorded in the passed Transaction tx to the database.
TransactionAnswer	saveBO(Transaction tx, int lockTimeout, int retries) Persists the changes recorded in the passed Transaction tx to the database.
void	sendSystemMessage(java.lang.String msg)
void	sendSystemMessage(java.lang.String msg, java.util.Map msgClients)
void	setProgressAnimator(ProgressAnimatorI pa)
void	setSessionLocale(java.util.Locale locale) Marks a client-side locale change on the server, so the server sends messages and exceptions in the correct locale to the client.
void	skipRecheckConnection()
void	stopServerShutdown()
void	subscribeEventsAtBackend(DBManEventSubscriptionI sub)
java.lang.Long	testAuth(Anmeldung a)
boolean	testAuth(de.ipcon.db.core.PasswortUeberpruefung a)
java.lang.String	toString()
void	unlockServer()
void	unsubscribeEvents(DBManEventListenerI listener, DBManEventFilter filter)
void	unsubscribeEventsAtBackend(DBManEventSubscriptionI[] removed)
ServerConnectionInfo	updateServerConnectionInfo()
void	updateStructureReadAccessStatistics(java.util.Map<java.lang.Long,java.lang.Integer> statistics) Pushes the passed read access statistics for structures to the server This method pushes the passed read access statistics map to the server, where the keys are structure Ids and the values are read access counts.
boolean	useOnlyDefaultPlafThemes()

Methods inherited from interface de.ipcon.tools.L10nPackProviderI

getL10nPack, getL10nPacks, getL10nPath, isOperational, prefetchL10nPacks

Methods inherited from interface de.ipcon.db.fulltext.FulltextSearcherI

getIdList, getIdList, getIdListAsString, getIdListAsString, getTerms, getTerms, getTerms, getTerms, getTerms, getTerms, getTerms, getTerms, getTermSuggestions, getTermSuggestions, getTermSuggestions, getTermSuggestions, getTermSuggestions, getTermSuggestions, getTermSuggestions, isFTSActive

Methods inherited from interface de.ipcon.db.fulltext.FTSTermInfoProviderI

getTermsRaw, getTermsRaw, getTermsRaw, getTermsRaw, getTermsRaw, getTermsRaw, getTermsRaw, isFTSActive

Methods inherited from interface de.ipcon.db.core.ExpiringTokenStorageProviderI

createExpiringToken, createExpiringToken, destroyExpiringToken, retrieveExpiringToken

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

EMPTY_ARRAY

static final ServerConnectionI[] EMPTY_ARRAY

Method Detail

getServerConnectionInfoReceiver

ServerConnectionInfoReceiverI getServerConnectionInfoReceiver()

getToken

long getToken()

hasIncompatibleServerProtocolVersion

boolean hasIncompatibleServerProtocolVersion()

getServerUrl

java.lang.String getServerUrl()

getServerName

java.lang.String getServerName()

getServerName

java.lang.String getServerName(boolean evenIfNoActiveConnection)

getInstanceName

java.lang.String getInstanceName()

getDBManInfo

DBManInfo getDBManInfo()

getNodeNumber

java.lang.Long getNodeNumber()

isServerAuthoritativeSyncServer

boolean isServerAuthoritativeSyncServer()

isNotificationSystemActivated

boolean isNotificationSystemActivated()

getSessionInfos

BackendSessionInfo[] getSessionInfos()

updateServerConnectionInfo

ServerConnectionInfo updateServerConnectionInfo()

initSession

void initSession()
          throws ServerConnectionException

Throws:

ServerConnectionException

connect

void connect()

This method is called when connecting or reconnecting to a server. It initializes a new session on the server and connects to it. In case it is a reconnect, the method will also log in and reregister for all previously registered server-side events.

isConnected

boolean isConnected()

disconnect

void disconnect()

getSessionId

java.lang.Long getSessionId(boolean blockUntilAvailable)

isDead

boolean isDead()

checkServerConnectivity

boolean checkServerConnectivity()

checkServerConnectivity

boolean checkServerConnectivity(boolean force)

skipRecheckConnection

void skipRecheckConnection()

markDead

void markDead()

authenticate

Anmeldung authenticate(java.lang.String username,
                       java.lang.String pass)
                throws AuthenticationException

Throws:

AuthenticationException

isLoggedIn

boolean isLoggedIn()

getLoggedInUser

Benutzer getLoggedInUser()

resetPassword

void resetPassword(java.lang.String username)

testAuth

java.lang.Long testAuth(Anmeldung a)

testAuth

boolean testAuth(de.ipcon.db.core.PasswortUeberpruefung a)

subscribeEventsAtBackend

void subscribeEventsAtBackend(DBManEventSubscriptionI sub)

unsubscribeEvents

void unsubscribeEvents(DBManEventListenerI listener,
                       DBManEventFilter filter)

unsubscribeEventsAtBackend

void unsubscribeEventsAtBackend(DBManEventSubscriptionI[] removed)

reregisterEventsAtBackend

void reregisterEventsAtBackend()

getCryptoHandler

CryptoHandlerI getCryptoHandler()

getPermissionHandler

PermissionHandlerWithUserI getPermissionHandler()

getRemoteSchema

SchemaI getRemoteSchema()

getRemoteSchemaFingerprint

java.lang.String getRemoteSchemaFingerprint()

getRemoteSchemaVersion

java.lang.String getRemoteSchemaVersion()

getRemoteSchemaUIDs

java.lang.String getRemoteSchemaUIDs()

getLazyStruktur

Struktur[] getLazyStruktur(java.lang.Long botId)

getAvailableLocalesForUserInterface

java.lang.String[] getAvailableLocalesForUserInterface()

getInitialAvailableLocalesForUserInterface

java.lang.String[] getInitialAvailableLocalesForUserInterface()

getL10nPackPreload

L10nInfoContainer getL10nPackPreload(java.lang.String locale)

getL10nViaString

java.lang.String getL10nViaString()

Specified by:

getL10nViaString in interface L10nPackProviderI

useOnlyDefaultPlafThemes

boolean useOnlyDefaultPlafThemes()

updateStructureReadAccessStatistics

void updateStructureReadAccessStatistics(java.util.Map<java.lang.Long,java.lang.Integer> statistics)

Pushes the passed read access statistics for structures to the server

This method pushes the passed read access statistics map to the server, where the keys are structure Ids and the values are read access counts.

Parameters:

statistics - a map containing structure Ids as keys and their read access counts as values.

setSessionLocale

void setSessionLocale(java.util.Locale locale)

Marks a client-side locale change on the server, so the server sends messages and exceptions in the correct locale to the client.

getBLOB

byte[] getBLOB(java.lang.Long id)
        throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getBLOB

byte[] getBLOB(java.lang.Long id,
               java.lang.Long backuppingBPId)
        throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getBLOB

long getBLOB(java.lang.Long id,
             java.io.OutputStream os)

getBLOB

long getBLOB(java.lang.Long id,
             java.io.OutputStream os,
             boolean closeOS)

getBLOB

long getBLOB(java.lang.Long id,
             java.io.OutputStream os,
             boolean closeOS,
             java.lang.Long backuppingBPId)

getBLOB

long getBLOB(java.lang.Long id,
             java.io.DataOutput os)

getBLOB

long getBLOB(java.lang.Long id,
             java.io.DataOutput os,
             boolean closeOS)

getBLOB

long getBLOB(java.lang.Long id,
             java.io.DataOutput os,
             boolean closeOS,
             java.lang.Long backuppingBPId)

getBLOBInfo

VFile getBLOBInfo(java.lang.Long id)

getBLOBInfo

VFile getBLOBInfo(java.lang.Long id,
                  java.lang.Long backuppingBPId)

hasBLOB

boolean hasBLOB(java.lang.Long id)

hasBLOB

boolean hasBLOB(java.lang.Long id,
                java.lang.Long backuppingBPId)

haveBLOB

java.util.BitSet haveBLOB(long[] ids)

copyRemoteBLOBsToLocalFileVault

void copyRemoteBLOBsToLocalFileVault(ServerFileVaultI serverFileVault,
                                     java.util.List<java.lang.Long> pendingBLOBChangeBOIdsLocal,
                                     java.lang.Long lastAuthNodeBTId)

saveBO

TransactionAnswer saveBO(Transaction tx,
                         int lockTimeout,
                         int retries)

Persists the changes recorded in the passed Transaction tx to the database.

Parameters:

tx - the Transaction to save

lockTimeout - time to wait in seconds until a locking error is reported in case some object is already locked by another thread; defaults to -1. Zero or less for no waiting, i.e. immediate timeout (or rather the defined lock-timeout of JDO, which defaults to 30s), an infinite value for no timeout.

retries - an int reflecting the number of retries that shall be attempted before saving is aborted

Returns:

the TransactionAnswer resulting from the save process, or null if no saving was actually done for some reason

saveBO

TransactionAnswer saveBO(Transaction tx,
                         int lockTimeout)

Persists the changes recorded in the passed Transaction tx to the database.

Parameters:

tx - the Transaction to save

lockTimeout - time to wait in seconds until a locking error is reported in case some object is already locked by another thread; defaults to -1. Zero or less for no waiting, i.e. immediate timeout (or rather the defined lock-timeout of JDO, which defaults to 30s), an infinite value for no timeout.

Returns:

the TransactionAnswer resulting from the save process, or null if no saving was actually done for some reason

saveBO

TransactionAnswer saveBO(Transaction tx)

Persists the changes recorded in the passed Transaction tx to the database.

Parameters:

tx - the Transaction to save

Returns:

the TransactionAnswer resulting from the save process, or null if no saving was actually done for some reason

getIdRange

KeyRange getIdRange(long size)

getNextId

java.lang.Long getNextId()

query

de.ipcon.db.core.QueryResultsI query(java.lang.String s)

query

de.ipcon.db.core.QueryResultsI query(java.lang.String s,
                                     java.lang.Object[] o)

query

de.ipcon.db.core.QueryResultsI query(BOQuery eq)

queryRelation

de.ipcon.db.core.QueryResultsI queryRelation(long id,
                                             java.lang.Class<? extends BOI> classtip,
                                             java.lang.String attributeName)

prepareQuery

BatchedBackendRequestI prepareQuery(java.lang.String s)

prepareQuery

BatchedBackendRequestI prepareQuery(java.lang.String s,
                                    java.lang.Object[] o)

execute

BatchedBackendRequestI execute(BatchedBackendRequestI sr)

execute

void execute(BatchedBackendRequestI[] srs)

queryBO

java.util.List queryBO(java.lang.String s)

queryBO

java.util.List queryBO(java.lang.String s,
                       java.lang.Object[] o)

queryBO

java.util.List queryBO(BOQuery eq)

exists

boolean exists(java.lang.Long id)

exists

boolean exists(java.lang.Long id,
               java.lang.Class<? extends BOI> classtip)

getBO

BO getBO(java.lang.Long id)

getBO

BO getBO(java.lang.Long id,
         java.lang.Class<? extends BOI> classtip)

getBOs

BO[] getBOs(java.lang.Long[] ids)

getBOs

BO[] getBOs(java.lang.Long[] ids,
            java.lang.Class<? extends BOI> classtip)

getBOs

BO[] getBOs(long[] ids)

getBOs

BO[] getBOs(long[] ids,
            java.lang.Class<? extends BOI> classtip)

getRelationBOs

BO[] getRelationBOs(java.lang.Long id,
                    java.lang.Class<? extends BOI> classtip,
                    java.lang.String attributeName)

lockServer

void lockServer()

unlockServer

void unlockServer()

initiateServerShutdown

void initiateServerShutdown()

initiateServerShutdown

void initiateServerShutdown(int cSecsDelay)

initiateServerShutdown

void initiateServerShutdown(int cSecsDelay,
                            java.lang.String msg)

stopServerShutdown

void stopServerShutdown()

sendSystemMessage

void sendSystemMessage(java.lang.String msg)

sendSystemMessage

void sendSystemMessage(java.lang.String msg,
                       java.util.Map msgClients)

demandForcedClientDisconnect

void demandForcedClientDisconnect(int cSecsDelay)

demandForcedClientDisconnect

void demandForcedClientDisconnect(int cSecsDelay,
                                  java.lang.String msg)

demandForcedClientDisconnect

void demandForcedClientDisconnect(int cSecsDelay,
                                  java.lang.String msg,
                                  java.util.Map msgClients)

cancelForcedClientDisconnect

void cancelForcedClientDisconnect()

cancelForcedClientDisconnect

void cancelForcedClientDisconnect(java.util.Map msgClients)

isFTSAvailable

boolean isFTSAvailable()

getClientSessionInfos

ClientSessionInfo[] getClientSessionInfos()

getRoundTrips

int getRoundTrips()

getURLPrefix

java.lang.String getURLPrefix()

getAddress

java.lang.String getAddress()

getServerInetAddress

java.net.InetAddress getServerInetAddress()

getDomain

java.lang.String getDomain()

getPort

int getPort()

getMinPool

int getMinPool()

getMaxPool

int getMaxPool()

getSubVersion

java.lang.String getSubVersion()

isTls

boolean isTls()

setProgressAnimator

void setProgressAnimator(ProgressAnimatorI pa)

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

handleDBManEvent

void handleDBManEvent(DBManEvent evt)

getManager

BackendConnectionManagerI getManager()

isMemoryTightClient

boolean isMemoryTightClient()

getConciseCommandsTimeoutSeconds

int getConciseCommandsTimeoutSeconds()

getSimpleCommandsTimeoutSeconds

int getSimpleCommandsTimeoutSeconds()

getMediumCommandsTimeoutSeconds

int getMediumCommandsTimeoutSeconds()

getComplexCommandsTimeoutSeconds

int getComplexCommandsTimeoutSeconds()