Package com.saperion.connector.rmi

Class AbstractRMIClientCommand

java.lang.Object

com.saperion.connector.rmi.AbstractRMIClientCommand

All Implemented Interfaces:

SaRMIClientCommand

Direct Known Subclasses:

AbstractFolderRMIClientCommand

public abstract class AbstractRMIClientCommand
extends Object
implements SaRMIClientCommand

Class representing the base class for all client wrappers for the backend operations.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	APPEND_CONTENT
protected SaRMIServerCommand	appl
protected com.lexmark.saperion.remote.common.authentication.Credentials	credentials	Credentials which were used to logon
protected static final Logger	LOGGER
protected Properties	props
protected com.saperion.connector.authentication.Session	session	Session which is representing the actual logged in user
protected com.saperion.connector.authentication.SessionInfo	sessionInfo	The session information like user agent, remote address etc.
protected SaRMISystemConnector	sysConnector
protected int	writeBufferSize

Constructor Summary

Constructors

Constructor	Description
AbstractRMIClientCommand()

Method Summary

Modifier and Type	Method	Description
SaRMIServerCommand	getRemoteCommand()
protected void	init()
protected void	reLogon()
protected boolean	reLogonAfterConnectionFailure(Exception e)	If the cause of the exception is a connection failure, this methods performs a relogon.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.saperion.connector.rmi.SaRMIClientCommand

addComment, addHistory, addToFolder, cacheDocument, changePassword, checkoutDocument, checkoutDocument, checkSapUrl, clearContent, closeDocument, closeSession, copyFolder, createDocument, createExternalStorageFolderMapping, createFolder, createLink, deleteDocument, deleteExternalStorageFolderMapping, deleteFolder, deleteSetting, discardDocument, dsicardCheckout, executeCommand, finishSQLTransaction, finishTransaction, getACLNames, getACLRights, getAcls, getAllACLs, getAnnotations, getArchivedSize, getAuthorizedUsers, getBoxCount, getBoxDefinitions, getCommandInfos, getCommandInfos, getCommentInfos, getCommitMode, getCompleteHistoryInfos, getCurrentUserRole, getDDC, getDeleteMode, getDocumentFolderCount, getDocumentFolders, getEventsEnabled, getExternalStorageFoldersForUpload, getExternalStorageFoldersForUpload, getExternalStorageMapping, getFeatures, getFieldDescriptions, getFieldDescriptions, getFolderChildren, getFolderClass, getFolderFromPath, getFolderInfo, getFolderParent, getFolderRights, getFolderUpdateInfo, getFulltext, getFullTextFields, getHDocForSysRowId, getHistoryInfos, getIdsFromQuery, getInvolvedUsers, getLicenseCount, getLockInfo, getLocks, getLocks, getMandant, getMember, getMembers, getNodeAccessData, getOutOfOffice, getParentTask, getRealDBName, getRMIVersion, getServerInfos, getSession, getSetting, getStringQueryResult, getSubstitute, getSystemConnector, getSystemFiles, getSystemInfo, getSystemSetting, getTask, getTaskAuditList, getTaskList, getThumbnail, getToken, getUserIdsForQuery, getUsers, getUserSetting, getVersionList, getWorkflowDefinitions, invoke, isAlive, isRevisionEnabled, listActiveSessions, loadDDCNames, loadFolderDDCNames, loadSettings, loadSystemFile, loadWorkflowDDCName, lockNode, logClientEvent, logoff, logon, logon, logon, moveFolder, moveToFolder, newInvoke, readDocumentFirst, readDocumentFirst, readDocumentMetadata, readDocumentNext, readVersionMetadata, readVersionMetadata, releaseDocument, removeElement, removeElement, removeFromFolder, resolveLatestHdoc, restoreVersion, saveDocument, saveDocument, searchFolderClass, searchFolderDocuments, searchSettings, sendBarcode, setACLName, setAnnotations, setElementMark, setEventsEnabled, setFolderAcl, setLocale, setOutOfOffice, setSetting, setSubstitute, setUsedLicense, setUserSetting, setVariables, startSQLTransaction, startTransaction, storeDocument, storeDocument, storeSystemFile, unlockNode, updateExternalStorageUploadStatus, updateFolder, writeContent, writeContent, writeContent, writeContent

Field Details

appl

protected SaRMIServerCommand appl

LOGGER

protected static final Logger LOGGER

sysConnector

protected SaRMISystemConnector sysConnector

session

protected com.saperion.connector.authentication.Session session

Session which is representing the actual logged in user

credentials

protected com.lexmark.saperion.remote.common.authentication.Credentials credentials

Credentials which were used to logon

sessionInfo

protected com.saperion.connector.authentication.SessionInfo sessionInfo

The session information like user agent, remote address etc.

APPEND_CONTENT

protected static final int APPEND_CONTENT

See Also:

• Constant Field Values

props

protected Properties props

writeBufferSize

protected int writeBufferSize

Constructor Details

AbstractRMIClientCommand

public AbstractRMIClientCommand()

Method Details

reLogon

protected void reLogon()
                throws SaSystemException

Throws:

SaSystemException - System exception

reLogonAfterConnectionFailure

protected boolean reLogonAfterConnectionFailure(Exception e)
                                         throws SaSystemException

If the cause of the exception is a connection failure, this methods performs a relogon.

Parameters:

e - the exception caught after first attempting to call a remote-method

Returns:

true if relogon was performed or false if the cause of the exception was no connection failure

Throws:

SaSystemException - if the relogon failed

init

protected void init()
             throws NotBoundException,
RemoteException

Throws:

NotBoundException - Not bound

RemoteException - Remote exception

getRemoteCommand

public SaRMIServerCommand getRemoteCommand()