Package com.saperion.connector.rmi

Class SaRMIClientCommandImpl

java.lang.Object

com.saperion.connector.rmi.AbstractRMIClientCommand

com.saperion.connector.rmi.AbstractFolderRMIClientCommand

com.saperion.connector.rmi.AbstractDocRMIClientCommand

com.saperion.connector.rmi.AbstractQueryRMIClientCommand

com.saperion.connector.rmi.AbstractWfRMIClientCommand

com.saperion.connector.rmi.SaRMIClientCommandImpl

All Implemented Interfaces:

SaRMIClientCommand

public class SaRMIClientCommandImpl
extends AbstractWfRMIClientCommand

The implementation of the SaRemoteApplication interface. This is the main point of communication between Java kernel and LARIX connector. The essential functionality consists of the documents processing, the transactions handling and log in/of

Field Summary

Fields inherited from class com.saperion.connector.rmi.AbstractRMIClientCommand

APPEND_CONTENT, appl, credentials, LOGGER, props, session, sessionInfo, sysConnector, writeBufferSize

Constructor Summary

Constructors

Constructor	Description
SaRMIClientCommandImpl()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	changePassword(java.lang.String user, java.lang.String oldPassword, java.lang.String client, java.lang.String newPassword)	Changes the password of an existing user.
boolean	closeSession(com.saperion.connector.authentication.Session session)	Close the given Session
boolean	deleteSetting(java.lang.String name, java.lang.String section, boolean isLong)	Deletes a setting in the database.
int	getArchivedSize(java.lang.String hDoc)	Returns the total document size in archive.
java.util.List<UsersRights>	getAuthorizedUsers(java.lang.String hDoc, java.lang.String rights, MatchKind match)	Returns the users, that have specific rights on a document.
int	getCommitMode()
com.lexmark.saperion.administration.RoleType	getCurrentUserRole()
DDC	getDDC(java.lang.String ddcName)	Returns information about the specified DDC.
int	getDeleteMode()
boolean	getEventsEnabled()	Returns whether events (e.g.
SaFeature	getFeatures()	Read the features.
SaFieldDescription[]	getFieldDescriptions(java.lang.String ddcName)	Reads the field descriptions for a given DDC.
SaFieldDescription[]	getFieldDescriptions(java.lang.String ddcName, java.lang.String mandant)	Reads the field descriptions for a given DDC.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	getFullTextFields(java.lang.String ddcName, java.util.List<java.lang.String> fullTextFields, java.lang.String hdoc)	See SaRMIClientCommand.getFullTextFields(String, List, String)
int	getLicenseCount(int type)	Read the licence count for the given user.
java.lang.String	getMandant()
WorkflowMember	getMember(WorkflowMember member, int depth, java.lang.String filter)	Reads the member.
WorkflowMember	getMembers()	Reads the member.
java.lang.String	getRealDBName(java.lang.String ddcName, java.lang.String field, java.lang.String mandant)	returns the real database table name for a given DDC.
java.lang.String	getRMIVersion()	Get the RMI interface version from java core server.
java.util.List<SaRMIServerInfo>	getServerInfos()	Returns a list of objects describing the servers this connector is connected to.
com.saperion.connector.authentication.Session	getSession()
Setting	getSetting(java.lang.String name, java.lang.String section, boolean isLong)	Retrieves a setting from the database.
SaRMISystemConnector	getSystemConnector()
java.util.List<java.lang.String>	getSystemFiles(SystemFileKind kind, java.lang.String filter)	Gets the system files of a specific kind.
SaSystemInfo	getSystemInfo()	Reads system info.
SaSystemSetting	getSystemSetting(java.lang.String accessKey)	Retrieves a system setting object.
int	getToken()
int[]	getUserIdsForQuery()	Read the userids.
SaUserSetting	getUserSetting(java.lang.String accessKey)	Retrieves a user setting object.
<T extends java.io.Serializable> T	invoke(com.lexmark.saperion.remote.common.operations.Operation<T,SaBasicException,LegacyConnection> operation)	This method invokes a Operation on the backend.
boolean	isAlive()	Test the lifetime of this token.
boolean	isRevisionEnabled(int mandant, java.lang.String ddcName)	Gets the information whether the provided ddc table contains the fields required for revisions.
java.util.List<com.saperion.connector.authentication.Session>	listActiveSessions()	List the active sessions of the logged in user.
java.lang.String[]	loadDDCNames()	Retrieves the available DDC names.
java.lang.String[]	loadFolderDDCNames()	Retrieves the available folder DDC names.
java.util.Properties	loadSettings(java.lang.String section)	Load settings from backend.
java.io.InputStream	loadSystemFile(SystemFileKind kind, java.lang.String name)	Loads a system file of a specific kind.
java.lang.String	loadWorkflowDDCName()	Retrieves the workflow DDC name.
boolean	logoff()	Log off the user from the server instance.
com.saperion.connector.authentication.Session	logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)	Logon with the passed credentials.
com.saperion.connector.authentication.Session	logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials, com.saperion.connector.authentication.SessionInfo sessionInfo)	Logon with the passed credentials and associate the given session information.
<ResultType extends java.io.Serializable,ExceptionType extends com.lexmark.saperion.exceptions.EcmException> ResultType	newInvoke(com.lexmark.saperion.remote.common.operations.EcmOperation<ResultType,ExceptionType> operation)	This method invokes a EcmOperation in the backend.
protected void	performLogonAfterFailure(java.lang.Exception e)	Performs relogon in the backend.
java.lang.String	resolveLatestHdoc(java.lang.String oldHdoc)	Resolves the hdoc of the latest version of the document identified by the given hdoc.
SettingSearchResult	searchSettings(SettingSearchInfo searchInfo)	Searches for settings.
void	sendBarcode(java.lang.String indexMask, java.lang.String docUid, java.lang.String contentRep, java.lang.String sid, java.lang.String docType, java.lang.String value, int mandant)	Send barcode to SAP.
void	setEventsEnabled(boolean enabled)	Sets whether events (e.g.
void	setLocale(java.util.Locale local)	Set the locale for localization.
void	setSetting(Setting setting)	Persists a setting in the database.
boolean	setUsedLicense(int type, int count)	Set the count of used licenses.
void	setUserSetting(SaUserSetting setting)	Persists a user setting object.
void	storeSystemFile(SystemFileKind kind, java.lang.String name, java.io.InputStream data)	Stores a system file of a specific kind.

Methods inherited from class com.saperion.connector.rmi.AbstractWfRMIClientCommand

addComment, addHistory, executeCommand, getBoxCount, getBoxDefinitions, getCommandInfos, getCommandInfos, getCommentInfos, getCompleteHistoryInfos, getHistoryInfos, getOutOfOffice, getParentTask, getSubstitute, getTask, getTaskAuditList, getTaskList, getUsers, getWorkflowDefinitions, setOutOfOffice, setSubstitute

Methods inherited from class com.saperion.connector.rmi.AbstractQueryRMIClientCommand

finishSQLTransaction, getFulltext, getHDocForSysRowId, getIdsFromQuery, getStringQueryResult, getVersionList, readDocumentMetadata, startSQLTransaction

Methods inherited from class com.saperion.connector.rmi.AbstractDocRMIClientCommand

cacheDocument, checkoutDocument, checkoutDocument, checkSapUrl, clearContent, closeDocument, createDocument, createExternalStorageFolderMapping, createLink, deleteDocument, deleteExternalStorageFolderMapping, discardDocument, dsicardCheckout, finishTransaction, getACLNames, getACLRights, getAcls, getAllACLs, getAnnotations, getExternalStorageFoldersForUpload, getExternalStorageFoldersForUpload, getExternalStorageMapping, getInvolvedUsers, getLockInfo, getLocks, getLocks, getNodeAccessData, getThumbnail, lockNode, logClientEvent, readDocumentFirst, readDocumentFirst, readDocumentNext, readVersionMetadata, readVersionMetadata, releaseDocument, removeElement, removeElement, restoreVersion, saveDocument, saveDocument, setACLName, setAnnotations, setElementMark, setVariables, startTransaction, storeDocument, storeDocument, unlockNode, updateExternalStorageUploadStatus, writeContent, writeContent, writeContent, writeContent

Methods inherited from class com.saperion.connector.rmi.AbstractFolderRMIClientCommand

addToFolder, copyFolder, createFolder, deleteFolder, getDocumentFolderCount, getDocumentFolders, getFolderChildren, getFolderClass, getFolderFromPath, getFolderInfo, getFolderParent, getFolderRights, getFolderUpdateInfo, moveFolder, moveToFolder, removeFromFolder, searchFolderClass, searchFolderDocuments, setFolderAcl, updateFolder

Methods inherited from class com.saperion.connector.rmi.AbstractRMIClientCommand

getRemoteCommand, init, reLogon, reLogonAfterConnectionFailure

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

logon

Constructor Detail

SaRMIClientCommandImpl

public SaRMIClientCommandImpl()
                       throws java.rmi.RemoteException,
                              java.rmi.NotBoundException

Constructor.

Throws:

java.rmi.RemoteException - RemoteException

java.rmi.NotBoundException - Server not found

Method Detail

performLogonAfterFailure

protected void performLogonAfterFailure(java.lang.Exception e)
                                 throws SaSystemException

Performs relogon in the backend. If relogon fails a SaSystemException is thrown.

Throws:

SaSystemException

getToken

public int getToken()

Returns:

Token

See Also:

SaRMIClientCommand.getToken()

getSession

public com.saperion.connector.authentication.Session getSession()

Returns:

the actual valid session

See Also:

SaRMIClientCommand.getSession()

getSystemConnector

public SaRMISystemConnector getSystemConnector()

Returns:

System connector

See Also:

SaRMIClientCommand.getSystemConnector()

getMandant

public java.lang.String getMandant()

Returns:

Mandant name

See Also:

SaRMIClientCommand.getMandant()

getCommitMode

public int getCommitMode()

Returns:

Commitmode from the configuration.

See Also:

SaRMIClientCommand.getCommitMode()

getDeleteMode

public int getDeleteMode()

Returns:

Deletemode from the configuration.

See Also:

SaRMIClientCommand.getDeleteMode()

logoff

public boolean logoff()
               throws SaSystemException,
                      SaAuthenticationException

Log off the user from the server instance.

Returns:

True, if done. False if session is not alive.

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.logoff()

logon

public com.saperion.connector.authentication.Session logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials)
                                                    throws SaSystemException,
                                                           SaAuthenticationException

Logon with the passed credentials.

Parameters:

credentials - credentials which should be used for logon

Returns:

Session which holds all information about the created session

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.logon(Credentials)

logon

public com.saperion.connector.authentication.Session logon(com.lexmark.saperion.remote.common.authentication.Credentials credentials,
                                                           com.saperion.connector.authentication.SessionInfo sessionInfo)
                                                    throws SaSystemException,
                                                           SaAuthenticationException

Logon with the passed credentials and associate the given session information.

Parameters:

credentials - credentials which should be used for logon

sessionInfo - The session information like user agent, remote address etc.

Returns:

Session which holds all information about the created session

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.logon(Credentials, SessionInfo)

listActiveSessions

public java.util.List<com.saperion.connector.authentication.Session> listActiveSessions()
                                                                                 throws SaSystemException

List the active sessions of the logged in user.

Returns:

A list of Session

Throws:

SaSystemException

See Also:

SaRMIClientCommand.listActiveSessions()

closeSession

public boolean closeSession(com.saperion.connector.authentication.Session session)
                     throws SaSystemException

Close the given Session

Returns:

true if successful, false otherwise

Throws:

SaSystemException

See Also:

SaRMIClientCommand.closeSession(Session)

getUserIdsForQuery

public int[] getUserIdsForQuery()
                         throws SaSystemException

Read the userids.

Returns:

User ids

Throws:

SaSystemException - SaRMICommandException

See Also:

SaRMIClientCommand.getUserIdsForQuery()

getFieldDescriptions

public SaFieldDescription[] getFieldDescriptions(java.lang.String ddcName)
                                          throws SaSystemException,
                                                 SaAuthenticationException,
                                                 SaDDCException

Reads the field descriptions for a given DDC.

Parameters:

ddcName - DDC name

Returns:

Array of field description objects

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

SaDDCException - SaDDCException

See Also:

SaRMIClientCommand.getFieldDescriptions(String)

getFieldDescriptions

public SaFieldDescription[] getFieldDescriptions(java.lang.String ddcName,
                                                 java.lang.String mandant)
                                          throws SaSystemException

Reads the field descriptions for a given DDC.

Parameters:

ddcName - DDC name

mandant - Mandant

Returns:

Array of field description objects

Throws:

SaSystemException - SaRMICommandException

See Also:

SaRMIClientCommand.getFieldDescriptions(java.lang.String, java.lang.String)

loadDDCNames

public java.lang.String[] loadDDCNames()
                                throws SaSystemException,
                                       SaAuthenticationException

Retrieves the available DDC names.

Returns:

Array of DDC names

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.loadDDCNames()

loadFolderDDCNames

public java.lang.String[] loadFolderDDCNames()
                                      throws SaSystemException,
                                             SaAuthenticationException

Retrieves the available folder DDC names.

Returns:

Array of folder DDC names

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.loadFolderDDCNames()

loadWorkflowDDCName

public java.lang.String loadWorkflowDDCName()
                                     throws SaSystemException

Retrieves the workflow DDC name.

Returns:

workflow DDC name

Throws:

SaSystemException - SaRMICommandException

See Also:

SaRMIClientCommand.loadWorkflowDDCName()

isAlive

public boolean isAlive()
                throws SaSystemException

Test the lifetime of this token. 1. Check if session is set, if not -> return false 2. If session is set, check if session is still alive via SaRMIServerCommand.isAlive(int)

Returns:

if session is set and alive return true otherwise false

Throws:

SaSystemException - System exception

See Also:

(int)

isRevisionEnabled

public boolean isRevisionEnabled(int mandant,
                                 java.lang.String ddcName)
                          throws SaSystemException,
                                 SaAuthenticationException

Gets the information whether the provided ddc table contains the fields required for revisions.

Parameters:

mandant - mandant number

ddcName - table/jcr workspace name

Returns:

true, if the revision fields are present. False otherwise.

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.isRevisionEnabled(int, String)

loadSettings

public final java.util.Properties loadSettings(java.lang.String section)
                                        throws SaSystemException

Load settings from backend.

Parameters:

section - Section

Returns:

Settings

Throws:

SaSystemException - Exception

getRealDBName

public java.lang.String getRealDBName(java.lang.String ddcName,
                                      java.lang.String field,
                                      java.lang.String mandant)
                               throws SaSystemException

returns the real database table name for a given DDC.

Parameters:

ddcName - DDC name

field - field name

mandant - Mandant

Returns:

Array of field description objects

Throws:

SaSystemException - SaRMICommandException

See Also:

SaRMIClientCommand.getRealDBName(java.lang.String, java.lang.String, java.lang.String)

getSystemSetting

public SaSystemSetting getSystemSetting(java.lang.String accessKey)
                                 throws SaSystemException

Retrieves a system setting object.

Parameters:

accessKey - key to get associated system setting

Returns:

SaSystemSetting

Throws:

SaSystemException - System exception

getSystemInfo

public SaSystemInfo getSystemInfo()
                           throws SaSystemException

Reads system info.

Returns:

System info

Throws:

SaSystemException - System exception

See Also:

SaRMIClientCommand.getSystemInfo()

getFeatures

public SaFeature getFeatures()
                      throws SaSystemException

Read the features.

Returns:

Features

Throws:

SaSystemException - System exception

See Also:

SaRMIClientCommand.getFeatures()

getUserSetting

public final SaUserSetting getUserSetting(java.lang.String accessKey)
                                   throws SaSystemException,
                                          SaAuthenticationException

Retrieves a user setting object.

Parameters:

accessKey - key to get associated user setting

Returns:

SaUserSetting

Throws:

SaSystemException - System exception

SaAuthenticationException - authentication exception

setUserSetting

public final void setUserSetting(SaUserSetting setting)
                          throws SaSystemException,
                                 SaAuthenticationException

Persists a user setting object.

Parameters:

setting - the SaUserSetting object to be stored

Throws:

SaSystemException - System exception

SaAuthenticationException - authentication exception

getSetting

public Setting getSetting(java.lang.String name,
                          java.lang.String section,
                          boolean isLong)
                   throws SaSystemException,
                          SaAuthenticationException

Retrieves a setting from the database.

Parameters:

name - the setting's name

section - the setting's section

isLong - whether this is a setting with a long (>2KB) value or not

Returns:

the setting or null if no setting with the given key and section was found

Throws:

SaSystemException - system error when retrieving the setting

SaAuthenticationException - authentication error

See Also:

SaRMIClientCommand.getSetting(java.lang.String, java.lang.String, boolean)

searchSettings

public SettingSearchResult searchSettings(SettingSearchInfo searchInfo)
                                   throws SaSystemException,
                                          SaAuthenticationException

Searches for settings.

Parameters:

searchInfo - SettingSearchInfo containing information about what to search

Returns:

a SettingSearchResult

Throws:

SaSystemException - system error when searching

SaAuthenticationException - authentication error

See Also:

SaRMIClientCommand.searchSettings(com.saperion.settings.SettingSearchInfo)

setSetting

public void setSetting(Setting setting)
                throws SaSystemException,
                       SaAuthenticationException

Persists a setting in the database.

Parameters:

setting - the setting to persist

Throws:

SaSystemException - system error when persisting the setting

SaAuthenticationException - authenticatin error when persisting the setting

See Also:

SaRMIClientCommand.setSetting(com.saperion.settings.Setting)

deleteSetting

public boolean deleteSetting(java.lang.String name,
                             java.lang.String section,
                             boolean isLong)
                      throws SaSystemException,
                             SaAuthenticationException

Deletes a setting in the database.

Parameters:

name - the name of the setting to delete

section - the section of the setting to delete

isLong - whether this is a setting with a long (>2KB) value or not

Returns:

true if setting was deleted, false if there was no such setting

Throws:

SaSystemException - system error when deleting the setting

SaAuthenticationException - authentication error when deleting the setting

See Also:

SaRMIClientCommand.deleteSetting(java.lang.String, java.lang.String, boolean)

setLocale

public void setLocale(java.util.Locale local)
               throws SaSystemException,
                      SaAuthenticationException

Set the locale for localization.

Parameters:

local - Locale

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.setLocale(java.util.Locale)

getMembers

public WorkflowMember getMembers()
                          throws SaSystemException,
                                 SaAuthenticationException

Reads the member.

Returns:

Member tree

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.getMembers()

getMember

public WorkflowMember getMember(WorkflowMember member,
                                int depth,
                                java.lang.String filter)
                         throws SaSystemException,
                                SaAuthenticationException

Reads the member.

Parameters:

member - workflow member, which direct children have to be returned.

depth - depth of the returned children.

filter - filter for search, only matching members will be found, leave empty to get all members.

Returns:

Member tree

Throws:

SaSystemException - SaRMICommandException

SaAuthenticationException - SaAuthenticationException

See Also:

SaRMIClientCommand.getMember(WorkflowMember, int, String)

getSystemFiles

public java.util.List<java.lang.String> getSystemFiles(SystemFileKind kind,
                                                       java.lang.String filter)
                                                throws SaSystemException,
                                                       SaAuthenticationException

Gets the system files of a specific kind.

Parameters:

kind - the kind of systemfiles to read.

filter - A filter string. Only files will be returned, that match the filter. To get all systemfiles of a kind set filter to the empty string.

Returns:

The system files of a specific kind.

Throws:

SaSystemException - general error

SaAuthenticationException - error on the authentification / insufficient rights

See Also:

SaRMIClientCommand.getSystemFiles(SystemFileKind, String)

changePassword

public void changePassword(java.lang.String user,
                           java.lang.String oldPassword,
                           java.lang.String client,
                           java.lang.String newPassword)
                    throws SaAuthenticationException,
                           SaSystemException

Changes the password of an existing user. This has to be done before a call to SaRMIClientCommand.logon(Credentials) was successfully invoked.

Parameters:

user - The name of the user.

oldPassword - The old password. This parameter is required, since the password should only be changed by the user himself

client - The client of the actions

newPassword - The new password

Throws:

SaAuthenticationException

SaSystemException

See Also:

SaRMIClientCommand.changePassword(String, String, String, String)

getAuthorizedUsers

public java.util.List<UsersRights> getAuthorizedUsers(java.lang.String hDoc,
                                                      java.lang.String rights,
                                                      MatchKind match)
                                               throws SaAuthenticationException,
                                                      SaSystemException

Returns the users, that have specific rights on a document.

Parameters:

hDoc - The id of the document.

rights - The rights the requested users should have.

match - How the rights are matched: MKONEOF - find all users that have one of the specified rights MKEXACT - find all users that have exactly the specified rights MKATLEAST - find all users that have at least the specified rights

Returns:

The users, that have specific rights on the document or null if the document has no acl set. In this case everyone has every right on the document.

Throws:

SaAuthenticationException

SaSystemException

See Also:

SaRMIClientCommand.getAuthorizedUsers(String, String, MatchKind)

getArchivedSize

public int getArchivedSize(java.lang.String hDoc)
                    throws SaAuthenticationException,
                           SaSystemException

Returns the total document size in archive.

Parameters:

hDoc - The document whichs size is wanted.

Returns:

The total document size in archive.

Throws:

SaAuthenticationException

SaSystemException

See Also:

SaRMIClientCommand.getArchivedSize(String)

storeSystemFile

public void storeSystemFile(SystemFileKind kind,
                            java.lang.String name,
                            java.io.InputStream data)
                     throws SaSystemException,
                            SaAuthenticationException

Stores a system file of a specific kind.

Parameters:

kind - The kind of systemfile to store.

name - The name of the file. This has to be a filename without path and extension.

data - The content of the file to save.

Throws:

SaSystemException - Remote exception

SaAuthenticationException - Authentication error

See Also:

SaRMIClientCommand.storeSystemFile(SystemFileKind, String, InputStream)

loadSystemFile

public java.io.InputStream loadSystemFile(SystemFileKind kind,
                                          java.lang.String name)
                                   throws SaSystemException,
                                          SaAuthenticationException

Loads a system file of a specific kind.

Parameters:

kind - The kind of system file to load

name - The name of the file to load.

Returns:

an InputStream that holds the content of the file.

Throws:

SaSystemException - general error

SaAuthenticationException - error on the authentification / insufficient rights

See Also:

SaRMIClientCommand.loadSystemFile(com.saperion.settings.SystemFileKind, java.lang.String)

getRMIVersion

public java.lang.String getRMIVersion()
                               throws SaSystemException

Get the RMI interface version from java core server.

Throws:

SaSystemException

See Also:

SaRMIClientCommand.getRMIVersion()

resolveLatestHdoc

public java.lang.String resolveLatestHdoc(java.lang.String oldHdoc)
                                   throws SaSystemException,
                                          SaAuthenticationException

Resolves the hdoc of the latest version of the document identified by the given hdoc.

Parameters:

oldHdoc - the old hdoc

Returns:

the hdoc of the latest version of the document identified by the given hdoc.

Throws:

SaSystemException - the system error exception

SaAuthenticationException - the authentication error exception

See Also:

SaRMIClientCommand.resolveLatestHdoc(java.lang.String)

invoke

public <T extends java.io.Serializable> T invoke(com.lexmark.saperion.remote.common.operations.Operation<T,SaBasicException,LegacyConnection> operation)
                                          throws SaSystemException,
                                                 SaAuthenticationException

This method invokes a Operation on the backend.

Type Parameters:

T - The return type

Parameters:

operation - The operation to invoke

Returns:

The result of the invocation

Throws:

SaSystemException

SaAuthenticationException

See Also:

SaRMIClientCommand.invoke(Operation)

newInvoke

public <ResultType extends java.io.Serializable,ExceptionType extends com.lexmark.saperion.exceptions.EcmException> ResultType newInvoke(com.lexmark.saperion.remote.common.operations.EcmOperation<ResultType,ExceptionType> operation)
                                                                                                                                        throws SaSystemException,
                                                                                                                                               SaAuthenticationException

Description copied from interface: SaRMIClientCommand

This method invokes a EcmOperation in the backend.

Parameters:

operation - the operation to invoke

Returns:

the result of the operation

Throws:

SaSystemException

SaAuthenticationException

sendBarcode

public void sendBarcode(java.lang.String indexMask,
                        java.lang.String docUid,
                        java.lang.String contentRep,
                        java.lang.String sid,
                        java.lang.String docType,
                        java.lang.String value,
                        int mandant)
                 throws SaSystemException,
                        SaAuthenticationException

Send barcode to SAP.

Parameters:

indexMask - Index mask name

docUid - Document UID

contentRep - SAP Content repository

sid - SAP ID

docType - Document type

value - Value

mandant - Mandant name

Throws:

SaSystemException - when a system error occured

SaAuthenticationException - when the user is not logged in or has insufficient rights

See Also:

SaRMIClientCommand.sendBarcode(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)

getServerInfos

public java.util.List<SaRMIServerInfo> getServerInfos()

Returns a list of objects describing the servers this connector is connected to.

Returns:

set of SaRMIServerInfo

See Also:

SaRMIClientCommand.getServerInfos()

getLicenseCount

public int getLicenseCount(int type)
                    throws SaSystemException

Read the licence count for the given user.

Parameters:

type - Client type

Returns:

License count

Throws:

SaSystemException - Error on the saperion system

See Also:

SaRMIClientCommand.getLicenseCount(int)

setUsedLicense

public boolean setUsedLicense(int type,
                              int count)
                       throws SaSystemException

Set the count of used licenses.

Parameters:

type - Client type

count - Number of licenses

Returns:

True, if success

Throws:

SaSystemException - Error on the saperion system

See Also:

SaRMIClientCommand.setUsedLicense(int, int)

setEventsEnabled

public void setEventsEnabled(boolean enabled)
                      throws SaSystemException,
                             SaAuthenticationException

Description copied from interface: SaRMIClientCommand

Sets whether events (e.g. for the IS) should be enabled for the current session.

Parameters:

enabled - true, if events should be enabled, otherwise false.

Throws:

SaSystemException - when a system error occured.

SaAuthenticationException - when the user is not logged in or has insufficient rights.

getEventsEnabled

public boolean getEventsEnabled()
                         throws SaSystemException,
                                SaAuthenticationException

Description copied from interface: SaRMIClientCommand

Returns whether events (e.g. for the IS) are enabled for the current session.

Returns:

true, if events are enabled, otherwise false.

Throws:

SaSystemException - when a system error occured.

SaAuthenticationException - when the user is not logged in or has insufficient rights.

getDDC

public DDC getDDC(java.lang.String ddcName)
           throws SaSystemException,
                  SaAuthenticationException

Description copied from interface: SaRMIClientCommand

Returns information about the specified DDC.

Parameters:

ddcName - the name of the DDC

Returns:

DDC information

Throws:

SaSystemException - system error when retrieving information about requested DDC

SaAuthenticationException - authentication exception when retrieving information about requested DDC

getFullTextFields

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getFullTextFields(java.lang.String ddcName,
                                                                                                     java.util.List<java.lang.String> fullTextFields,
                                                                                                     java.lang.String hdoc)
                                                                                              throws SaSystemException

See SaRMIClientCommand.getFullTextFields(String, List, String)

Parameters:

ddcName - name of the DDC

fullTextFields - List of Fields which are of Text retrieval type. Make sure to prefix SaConstants.FULL_TEXT_COLUMN_PREFIX

hdoc - hdoc of the document

Returns:

Set of entries containing full text coulmn and corresponding value

Throws:

SaSystemException

getCurrentUserRole

public com.lexmark.saperion.administration.RoleType getCurrentUserRole()
                                                                throws SaSystemException,
                                                                       SaAuthenticationException

Returns:

the effective role (combined rights of all roles / profiles) of the current logged-in user

Throws:

SaSystemException

SaAuthenticationException

See Also:

SaRMIClientCommand.getCurrentUserRole()