oracle.ifs.core.tools.script.test

Class RandomAccessOperations

java.lang.Object

oracle.ifs.core.tools.script.ScriptOperations

oracle.ifs.core.tools.script.test.BaseTestOperations

oracle.ifs.core.tools.script.test.RandomAccessOperations

All Implemented Interfaces:

AttributeValueGetter, Logger

public class RandomAccessOperations
extends BaseTestOperations

RandomAccessOperations contains operations used to test document functionality, including previous subclasses of BaseTest.

Version:

1.0

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RandomAccessOperations.ContentObjectUpdateTest ContentObjectUpdateTest performs tests related to updating ContentObejcts.
class	RandomAccessOperations.DocBfilePartialTest DocBfilePartialTest performs tests for RACI access to documents when BFILE storage is involved.
class	RandomAccessOperations.DocPartialTest DocPartialTest performs tests for RACI access to documents.
class	RandomAccessOperations.RandomAccessorReadTest RandomAccessorReadTest performs tests for RACI read operations.
class	RandomAccessOperations.RandomAccessorWriteTest RandomAccessorWriteTest performs tests for RACI write operations.

Nested classes/interfaces inherited from class oracle.ifs.core.tools.script.test.BaseTestOperations

BaseTestOperations.TestAction

Nested classes/interfaces inherited from class oracle.ifs.core.tools.script.ScriptOperations

ScriptOperations.ClassObjectOptions, ScriptOperations.JdbcExecutor, ScriptOperations.SavedSearchResult, ScriptOperations.ServerDefinition, ScriptOperations.ServiceDefinition

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable	m_BufferTable
protected String	m_Encoding
protected Hashtable	m_RaciTable

Fields inherited from class oracle.ifs.core.tools.script.test.BaseTestOperations

m_CleanupList

Fields inherited from class oracle.ifs.core.tools.script.ScriptOperations

INDENT

Constructor Summary

Constructors

Constructor and Description
RandomAccessOperations(ScriptDriver driver) Constructs a RandomAccessOperations.

Method Summary

Modifier and Type	Method and Description
void	canonWriteFromBuffer(String buftag, String boffsetVal, String lengthVal) Write to the Canons from the buffer and the length
void	canonWriteFromFileUsingBufferPosition(String filename, String bufnoVal, String foffsetVal, String lengthVal) Write to the test output from the file using buffer no, offset and the length to write to
void	canonWriteFromFileUsingOffset(String fname, String foffsetVal, String lengthVal) Write to the Canons from the RACI using offset, and the length to write to
void	clearSessionContext(String racitag) Clear session context for a RACI.
void	close(String racitag) Close the RACI given a racitag
void	createDocument(String objname, String fileName) Create a document.
protected void	createDocument(String objname, String content, boolean isfile) Create a document.
void	createPatternedDocument(String objname, String pattern, String lengthVal) Create a patterned document.
void	createRACI(String racitag, String objname, String writeable) Create a raci from a given document tag.
void	dispose(String racitag) Dispose the RACI given a racitag
void	dumpContent(String objname, String fileName) Dump the content of a Document to a file.
protected void	dumpData(byte[] pkt, int offset, int len) Output a byte array to the debug stream in a readable format.
void	flush(String racitag) Flush the RACI given a racitag
void	freeDocument(String objname) Frees a document.
protected int	getBlobBufferSize()
protected String	getCharacterEncoding(LibrarySession session)
protected long	getLength(String racitag) Gets the RACI length.
protected Byte[]	lookupBuffer(String buffertag) look up a buffer that has data given a buffertag.
protected RandomAccessContentInterface	lookupRACI(String racitag) look up a RACI given a Racitag
protected String	padBinString(int intVal, int pad) Converts an integer into its hexadecimal representation pre-padding with 0's.
protected String	padHexString(int intVal, int pad) Converts an integer into its hexadecimal representation pre-padding with 0's.
protected String	padHexString(long longVal, int pad) Converts a long integer into its hexadecimal representation pre-padding with 0's.
void	performDocBfilePartialTest() Performs actions for DocBfilePartialTest.
void	performDocPartialTest() Performs actions for DocPartialTest.
void	performRandomAccessorReadTest() Performs actions for RandomAccessorReadTest.
void	performRandomAccessorWriteTest() Performs actions for RandomAccessorWriteTest.
int	read(String racitag, String foffsetVal, String lengthVal, String buftag) Read from the given raci and return a array of bytes read.
int	readFromBuffer(String racitag, String buffnoVal, String boffsetVal, String lengthVal, String buftag) Read from the given raci and return a array of bytes read
void	reestablishSessionContext(String racitag) Re-establish session context for a RACI.
void	showDocument(String objname) Shows a document.
void	showLength(String racitag) Shows the RACI length.
void	truncate(String racitag, String foffsetVal) Truncate the RACI at the given buffer position and offset for the length given
void	truncateFromBuffer(String racitag, String buffnoVal, String boffsetVal) Truncate the RACI at the given buffer position and offset for the length given.
void	write(String racitag, String foffsetVal, String value, String countVal) Write to a given raci from a array of bytes.
void	writeToBuffer(String racitag, String buffnoVal, String boffsetVal, String value, String countVal) Write to the given RACI.
protected String	zeroPad(String str, int pad) Pre-pad a string with 0's.

Methods inherited from class oracle.ifs.core.tools.script.test.BaseTestOperations

addObjectForCleanup, assertTrue, cleanup, doCleanup, free, getCurrentUser, getCurrentUserName, launchTestAction

Methods inherited from class oracle.ifs.core.tools.script.ScriptOperations

abortTransaction, acquireLock, acquireManualLock, activateAuditHandlerSpecification, activateAuditSpecification, activateOperationActionSpecification, activateServerSpecification, activateSystemObject, addAttachment, addAttribute, addAuditEventProperty, addAuditType, addAuditTypesForClass, addBooleanHandlerProperty, addCategory, addDefinitionAuditEntryType, addDefinitionAuditEntryTypesForClass, addDefinitionAuditEntryTypesUnderClass, addDefinitionBooleanProperty, addDefinitionDoubleProperty, addDefinitionIntegerProperty, addDefinitionLongProperty, addDefinitionProperties, addDefinitionProperty, addDefinitionStringArrayProperty, addDefinitionStringProperty, addDocumentDefinitionCharacterSet, addDocumentDefinitionContent, addDocumentDefinitionContentBfileReference, addDocumentDefinitionLanguage, addGlobalOperationActionSpecification, addGroupMember, addGroupMembers, addIntegerHandlerProperty, addLifecyclePolicyEntryDefinition, addLifecyclePolicyEntryDefinition, addLongHandlerProperty, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServiceDeclaration, addManagedServiceDeclaration, addPreparedSelectorBindValue, addPreparedSelectorBooleanBindValue, addPreparedSelectorIntegerBindValue, addPreparedSelectorLibraryObjectBindValue, addPreparedSelectorLongBindValue, addPreparedSelectorStringBindValue, addPublicObjectDefinitionCategory, addSchemaObjectDefinitionCategory, addStringArrayHandlerProperty, addStringHandlerProperty, addSystemObjectDefinitionBooleanProperty, addSystemObjectDefinitionCategory, addSystemObjectDefinitionIntegerProperty, addSystemObjectDefinitionLongProperty, addSystemObjectDefinitionStringArrayProperty, addSystemObjectDefinitionStringProperty, addToDocumentDefinition, addToPublicObjectDefinition, applyLogLevelOverride, applyNamedFreezeLock, applySingletonLock, assignClassDomain, assignLifecyclePolicyByCategory, assignValueDefault, assignValueDomain, beginTransaction, businessObjectExists, clearImpersonateUser, clearSharedCaches, cloneCurrentSession, cloneDefinition, cloneDefinition, comment, comment, compareObjects, completeTransaction, concatenateObjectId, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToUpperStrings, concatenateToUpperStrings, concatenateToUpperStrings, connect, connect, constructAuditEvent, constructPreparedSelectorGenerator, constructPreparedSelectorGenerator, convertPropertyDefinitionsToHashtable, convertStringArray, convertToBoolean, convertToBoolean, convertToDouble, convertToDouble, convertToInteger, convertToInteger, convertToLong, convertToLong, convertToRelativePath, copy, create, createAccessControlList, createAndApplyAuditTypeList, createApplicationToken, createApplicationToken, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditTypeList, createAuditTypeList, createAutoFolderingActionSpecification, createAutoFolderingActionSpecification, createCategorizedDocument, createClassDomain, createClassObject, createClassObject, createCustomLockEntry, createCustomMediaDriverSpecification, createCustomMediaDriverSpecification, createDefinition, createDefinitionFromDefinitionObject, createDefinitionFromObject, createDefinitionObject, createDependentView, createDocument, createDocument, createDocument, createDocumentBatch, createDocuments, createEntireAuditSpecification, createExtendedPermission, createExtendedUserProfile, createFolder, createFolder, createFolder, createFolderLink, createFolderTree, createFormat, createGroup, createGuestSession, createLibraryObject, createLibraryObject, createLifecycleDateRuleSpecification, createLifecycleDateRuleSpecification, createLifecyclePolicy, createLifecyclePolicy, createLifecyclePolicyActionSpecification, createLifecyclePolicyActionSpecification, createLifecyclePolicyEntryDefinition, createLink, createLink, createLink, createLockTypeLookupTables, createMedia, createMedia, createNamedFreezeLock, createNamedPropertyBundle, createNodeConfiguration, createNodeConfiguration, createOperationActionSpecification, createOperationActionSpecification, createOrUpdateClassObject, createPermissionBundle, createPolicy, createPolicyList, createPropertyBundle, createQueue, createRetentionPolicy, createServerConfiguration, createServerConfiguration, createServerSpecification, createServiceConfiguration, createServiceConfiguration, createSession, createSession, createSimplePropertyTable, createSimplePropertyTableList, createStorageGroup, createStorageGroup, createSystemLockObject, createUser, createUserSession, createValueDefault, createValueDomain, deactivateAuditHandlerSpecification, deactivateAuditSpecification, deactivateOperationActionSpecification, deactivateServerSpecification, deactivateSystemObject, deactivateUnknownOperationActionSpecifications, defineAttribute, defineAuditHandlerSpecificationDefinition, defineAuditHandlerSpecificationDefinition, defineAuditTargetSpecificationDefinition, defineAuditTypeListDefinition, defineAuditTypeListDefinition, defineClassObject, defineExistingClassObject, definitionExists, deleteAllCategories, deleteAuditSpecification, deleteNamedFreezeLock, deleteRepositoryParameter, deleteUser, deregisterBusinessObject, deregisterCustomLockType, deregisterDefinition, deregisterLockType, deregisterObject, deregisterSession, deregisterTransaction, determinePrimaryObjectColumnAlias, ensureFreed, executeAutocommitSql, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectFromJson, executePreparedSelectResults, exists, existsRelative, extractContentForIndexing, findOrCreateCompositeGroup, freeClassDomain, freeClassObject, freeExtendedPermission, freeFolder, freeFormat, freeNamedPropertyBundle, freeNamedPropertyBundle, freeNodeConfiguration, freeNodeConfiguration, freeObject, freePermissionBundle, freePolicy, freeServerConfiguration, freeServerConfiguration, freeServiceConfiguration, freeServiceConfiguration, freeUnreferencedContent, freeValueDefault, freeValueDomain, generateClassObjectDefinitionTag, getAbsolutePath, getAclValueForConfigurationObjects, getAttributeValue, getAttributeValue, getAttributeValue, getAuditDriverHelper, getAuditEventDispatcher, getAuditingStartingId, getAuxiliaryTargets, getBindValues, getBypassSecurityAliases, getClassObjectCreationMode, getConsoleInputBoolean, getConsoleInputString, getConsoleInputString, getConsoleInputString, getConsoleSecureInputString, getContentPath, getCurrentSession, getDriver, getIncludedFileSettings, getLogWriter, getManagedServerDeclarations, getManagedServiceDeclarations, getParameterTable, getSavedSearchResultPrimaryObjects, getSavedSearchResults, getShowDates, getStringArray, getStringsFromArrayToken, getStripNumbersFromAuditEventProperties, handleEventPostedForCustomAuditHistory, handleTimerExpiredForCustomAuditHistory, identifyAcl, identifyAcl, identifyApplicationToken, identifyAttribute, identifyAttributePropertyBundle, identifyAuditHandlerSpecification, identifyAuditSpecification, identifyAuditTargetSpecification, identifyAuditTypeList, identifyAuditTypeListBySpecification, identifyAutoFolderingActionSpecification, identifyByAttribute, identifyByPath, identifyByRelativePath, identifyCategory, identifyCategory, identifyClassAcl, identifyClassDomain, identifyClassObject, identifyClassPolicyBundle, identifyClassPropertyBundle, identifyCompositeGroup, identifyCustomLock, identifyCustomMediaDriverSpecification, identifyDependentView, identifyExtendedPermission, identifyFormat, identifyGlobalAuditSpecification, identifyGlobalAuditTypeList, identifyGroup, identifyGuestUser, identifyInstancePropertyBundle, identifyLibraryObject, identifyLifecycleDateRuleSpecification, identifyLifecyclePolicy, identifyLifecyclePolicyActionSpecification, identifyLifecyclePolicyEntry, identifyMedia, identifyMessageEntry, identifyMessageList, identifyNamedFreezeLock, identifyNamedPropertyBundle, identifyNodeConfiguration, identifyObjectAuditSpecification, identifyObjectProperty, identifyOperationActionSpecification, identifyPermissionBundle, identifyPolicy, identifyPolicyList, identifyPrimaryUserProfile, identifyPropertyBundle, identifyQueue, identifyQueueTypeMapBundle, identifyRetentionPolicy, identifyServerConfiguration, identifyServerSpecification, identifyServiceConfiguration, identifySingletonLockType, identifyStorageGroup, identifySystemAcl, identifySystemLockObject, identifySystemUser, identifyUser, identifyValueDefault, identifyValueDomain, identifyWorldGroup, impersonateUser, impersonateUser, initializeManualTextIndexingRetainedEvents, isBootstrapModeEnabled, isDomainScopeImpliedForSearch, isInArray, log, log, lookupAcl, lookupApplicationToken, lookupAuditDomainContext, lookupAuditSpecification, lookupAutoFolderingActionSpecification, lookupBusinessObject, lookupBusinessObjectHashtable, lookupBusinessObjectList, lookupClassAcl, lookupDatatype, lookupDatatypeString, lookupDefinition, lookupDefinition, lookupDirectoryObject, lookupDocument, lookupFolder, lookupFormat, lookupFormatFromCollection, lookupGroup, lookupMedia, lookupMessageEntry, lookupObject, lookupObject, lookupObjectAttributeValue, lookupObjectId, lookupOperationActionSpecification, lookupPublicObject, lookupQueue, lookupSessionByTag, lookupSystemAcl, lookupSystemLockObject, lookupTagBySessionId, lookupUser, lookupUserFromCollection, makeDefinitionReadOnly, markCurrentAuditingId, modifyClassObject, move, moveCategory, normalizeBooleanString, notifyCustomAuditHistoryHandler, objectExists, postCustomAuditEvent, postCustomAuditEvent, postCustomAuditEvent, postSystemAuditEvent, postSystemAuditEvent, preprocessDocumentSettings, preprocessPublicObjectSettings, printStackTrace, processManualTextIndexingRetainedEvents, processRawAuditEvents, purgeGlobalAuditHistory, reactivateUnknownOperationActionSpecifications, readDocumentContent, refreshDependentView, registerAllNonCustomAuditTypes, registerAuditEventType, registerAuditEventType, registerBusinessObject, registerCustomAuditType, registerCustomLockType, registerDefinition, registerLockType, registerNewSession, registerObject, registerTransaction, releaseLock, releaseManualLock, removeAcesForFreedGrantees, removeAllAttachments, removeAttachment, removeAttribute, removeClassProperty, removeCustomLockEntry, removeGroupMembers, removeNamedFreezeLock, removeProperties, removeServerFromNodeConfiguration, removeServiceFromNodeConfiguration, removeSession, removeSessionState, removeSingletonLock, removeTag, rename, replaceMediaLookupsByFormat, replaceSession, resetFolderCountInfo, restoreGlobalOperationActionSpecification, runSchemaCreator, runScript, saveGlobalOperationActionSpecification, saveSearchResultPrimaryObjects, saveSearchResults, searchAuditHistory, searchAuditHistory, searchAuditHistory, sessionExists, setAdminMode, setAdminMode, setArrayTokenDelimiter, setAuditingStartingId, setAuditSpecificationAuditHandlerSpecificationDefinition, setAuditSpecificationAuditTargetSpecificationDefinition, setAuditSpecificationAuditTypeListDefinition, setAuditTargetSpecificationDefinitionTarget, setBooleanInstanceProperty, setClassObjectCreationMode, setClassPolicyList, setClassProperty, setCreateCategoriesServerSideOption, setCurrentSession, setCurrentSession, setDateFormat, setDefaultAuditEventSortClause, setDefaultMedia, setDefaultScriptOperationsClass, setDefaultStorageGroup, setDefinitionAttribute, setDefinitionAttribute, setDefinitionBooleanAttribute, setDefinitionClassObjectAttribute, setDefinitionDateAttribute, setDefinitionDirectoryObjectArrayAttribute, setDefinitionDirectoryObjectAttribute, setDefinitionDoubleAttribute, setDefinitionIntegerAttribute, setDefinitionLongAttribute, setDefinitionNullStringAttribute, setDefinitionObjectAttribute, setDefinitionSchemaObjectArrayAttribute, setDefinitionSchemaObjectAttribute, setDefinitionStringArrayAttribute, setDefinitionStringAttribute, setDefinitionSystemObjectAttribute, setDocumentDefinitionContentObjectDefinition, setGlobalAuditTypeList, setGlobalOperationActionSpecifications, setInstallationMode, setInstallationMode, setInstanceProperty, setIntegerInstanceProperty, setLifecyclePolicyDefinitionDeleteEntriesOption, setLocale, setLongInstanceProperty, setLongSessionState, setMainSessionAsCurrentSession, setMediaLookupByFormat, setNumberFormat, setObjectProperty, setPreventSessionTimeouts, setPreventSessionTimeouts, setProperty, setPublicObjectInstanceProperty, setRepositoryParameter, setStringInstanceProperty, setStringSessionState, setSubstitutionPrefix, setSystemAdminMode, setSystemAdminMode, setSystemObjectInstanceProperty, setTimeoutPeriodOption, setTimeZone, setUserCreateOptions, setUserDefaultAcl, setUserDeleteOptions, showAcl, showAggregateAuditEventColumns, showAllAutoFolderingActionSpecifications, showAllClassAcls, showAllClassDomains, showAllClassObjects, showAllCustomAuditSpecifications, showAllCustomMediaDriverSpecifications, showAllDependentViews, showAllExtendedPermissions, showAllExternalRetentionPolicies, showAllFormats, showAllLifecycleDateRuleSpecifications, showAllLifecyclePolicies, showAllLifecyclePolicyActionSpecifications, showAllMedias, showAllNodeConfigurations, showAllNodeConfigurations, showAllOperationActionSpecifications, showAllPermissionBundles, showAllPolicies, showAllPolicyLists, showAllRepositoryParameters, showAllRetentionPolicies, showAllServerConfigurations, showAllServerConfigurations, showAllServerSpecifications, showAllServiceConfigurations, showAllServiceConfigurations, showAllStorageGroups, showAllSystemAcls, showAllValueDefaults, showAllValueDomains, showApplicationToken, showApplicationTokens, showAttachments, showAttribute, showAttribute, showAuditCertificates, showAuditEventOperationTypes, showAuditSpecification, showAuditTypeList, showAuditTypesForClass, showAuditTypesForCreateOperations, showAuditTypesForFreeOperations, showAuditTypesUnderClass, showAutoFolderingActionSpecification, showCapabilities, showClassDomain, showClassDomain, showClassObject, showClassObjectAndSubNames, showClassObjectAndSubs, showCompositeGroup, showCreateClassObjectScript, showCurrentUser, showCustomAuditHistory, showCustomAuditHistory, showCustomAuditTypes, showCustomMediaDriverSpecification, showDefaultMedia, showDefaultStorageGroup, showDefineAttributeScript, showDefinition, showDefinitionObject, showDependentView, showDocumentCharacterSet, showDocumentContentInfo, showDocumentContents, showDocumentContents, showDocumentContents, showDocumentLanguage, showDocumentsWithLifecyclePolicy, showExpandedAuditTypeList, showExtendedPermission, showFolder, showFolder, showFolderCountInfo, showFormat, showGlobalAuditHistory, showGlobalAuditHistory, showGlobalAuditSpecification, showGlobalAuditTypeList, showGlobalOperationActionSpecifications, showGroup, showInstanceProperty, showInstancePropertyBundle, showLibraryObject, showLibraryObject, showLifecycleDateRuleSpecification, showLifecyclePolicy, showLifecyclePolicyActionSpecification, showLifecyclePolicyEntry, showLink, showLocalizer, showLockEntry, showLockEntryInfo, showLockTypeLookupTables, showMedia, showMediaLookupByFormatMappings, showMessageEntry, showMessageList, showNamedPropertyBundle, showNodeConfiguration, showNodeConfiguration, showObject, showObjectAuditHistory, showObjectAuditHistory, showObjectAuditSpecification, showOperationActionSpecification, showParsedArrayToken, showParsedOperationString, showPermissionBundle, showPolicy, showPolicyList, showPreparedSelector, showPreparedSelector, showProperty, showPropertyBundle, showRepositoryParameter, showRetentionPolicy, showRuntimeStatistics, showSavedSearchResultPrimaryObjects, showSavedSearchResults, showServerConfiguration, showServerConfiguration, showServerSpecification, showServiceConfiguration, showServiceConfiguration, showServiceStatistics, showSessionCacheStatistics, showSessionState, showSimplePropertyTable, showSimplePropertyTableList, showStorageGroup, showUser, showValueDefault, showValueDefault, showValueDomain, showValueDomain, sleep, syncContentIndex, syncIndex, testJsonString, tokenToDirectoryObjectArray, tokenToDirectoryUserArray, tokenToDocumentArray, transactionExists, unregisterAuditEventType, unregisterCustomAuditType, update, updateAccessControlList, updateClassDomain, updateDefinitionObject, updateLibraryObject, updateLibraryObject, updateLibraryObject, updateNodeConfiguration, updateNodeConfiguration, updateServerConfiguration, updateServerConfiguration, updateServiceConfiguration, updateServiceConfiguration, updateUserPassword, updateValueDefault, updateValueDomain, verifyBusinessObjectTagNotExists, verifyDefinitionTagNotExists, verifyDefinitionWriteable, verifyObjectTagNotExists, writeConsoleOutputString, writeConsoleOutputString, writeDocumentContentToFile

Methods inherited from class java.lang.Object

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

Field Detail

m_RaciTable

protected Hashtable m_RaciTable

m_BufferTable

protected Hashtable m_BufferTable

m_Encoding

protected String m_Encoding

Constructor Detail

RandomAccessOperations

public RandomAccessOperations(ScriptDriver driver)

Constructs a RandomAccessOperations.

Parameters:

driver - the main script driver instance

Method Detail

createPatternedDocument

public void createPatternedDocument(String objname,
                                    String pattern,
                                    String lengthVal)
                             throws IfsException

Create a patterned document.

Parameters:

objname - name for the new document

pattern - the pattern to be in the document

lengthVal - the number of times pattern has to repeat

Throws:

IfsException - if the operation fails

createDocument

public void createDocument(String objname,
                           String fileName)
                    throws IfsException

Create a document.

Parameters:

objname - name for the new document

fileName - the content file (relative to IFSROOT)

Throws:

IfsException - if the operation fails

createDocument

protected void createDocument(String objname,
                              String content,
                              boolean isfile)
                       throws IfsException

Create a document.

Parameters:

objname - name for the new document

isfile - whether the content is in a file

content - the string content

Throws:

IfsException - if the operation fails

showDocument

public void showDocument(String objname)
                  throws IfsException

Shows a document.

Overrides:

showDocument in class ScriptOperations

Parameters:

objname - Document tag

Throws:

IfsException - if the operation fails

freeDocument

public void freeDocument(String objname)
                  throws IfsException

Frees a document.

Parameters:

objname - Document tag

Throws:

IfsException - if the operation fails

createRACI

public void createRACI(String racitag,
                       String objname,
                       String writeable)
                throws IfsException

Create a raci from a given document tag.

Parameters:

racitag - the tag to the raci in the hashtable

objname - the name of the document from the doctable

writeable - if the RACI is readonly or writeable

Throws:

IfsException - if the operation fails

readFromBuffer

public int readFromBuffer(String racitag,
                          String buffnoVal,
                          String boffsetVal,
                          String lengthVal,
                          String buftag)
                   throws IfsException

Read from the given raci and return a array of bytes read

Parameters:

racitag - the tag to the raci in the hashtable

buffnoVal - integer no of the buffer from which to read

boffsetVal - the offset from the buffer

lengthVal - the length of data to read

buftag - the tag for the buffer in the buffer hashtable

Throws:

IfsException - if the operation fails

read

public int read(String racitag,
                String foffsetVal,
                String lengthVal,
                String buftag)
         throws IfsException

Read from the given raci and return a array of bytes read.

Parameters:

racitag - the tag to the raci in the hashtable

foffsetVal - the absolute fileoffset at which to begin reading

lengthVal - the length of data to read

buftag - the tag for the buffer in the buffer hashtable

Throws:

IfsException - if the operation fails

writeToBuffer

public void writeToBuffer(String racitag,
                          String buffnoVal,
                          String boffsetVal,
                          String value,
                          String countVal)
                   throws IfsException

Write to the given RACI.

Parameters:

racitag - the tag to the raci in the hashtable

buffnoVal - integer no of the buffer into which to write

boffsetVal - offset into the buffer at which to write

value - the data to write in a byte array

countVal - the no of times the data pattern is to repeat

Throws:

IfsException - if the operation fails

write

public void write(String racitag,
                  String foffsetVal,
                  String value,
                  String countVal)
           throws IfsException

Write to a given raci from a array of bytes.

Parameters:

racitag - the tag to the raci in the hashtable

foffsetVal - offset into the buffer at which to write

value - the data to write in a byte array

countVal - the no of times to repeat the data to write

Throws:

IfsException - if the operation fails

truncateFromBuffer

public void truncateFromBuffer(String racitag,
                               String buffnoVal,
                               String boffsetVal)
                        throws IfsException

Truncate the RACI at the given buffer position and offset for the length given.

Parameters:

racitag - the tag to the raci in the hashtable

buffnoVal - integer no of the buffer into which to truncate

boffsetVal - offset into the buffer at which to truncate

Throws:

IfsException - if the operation fails

truncate

public void truncate(String racitag,
                     String foffsetVal)
              throws IfsException

Truncate the RACI at the given buffer position and offset for the length given

Parameters:

racitag - the tag to the raci in the hashtable

foffsetVal - offset into the buffer at which to truncate

Throws:

IfsException - if the operation fails

canonWriteFromBuffer

public void canonWriteFromBuffer(String buftag,
                                 String boffsetVal,
                                 String lengthVal)
                          throws IfsException

Write to the Canons from the buffer and the length

Parameters:

buftag - the tag to the buffer in the hashtable

boffsetVal - in the buffer from which to write

lengthVal - the desired length to write to the canon

Throws:

IfsException - if the operation fails

canonWriteFromFileUsingBufferPosition

public void canonWriteFromFileUsingBufferPosition(String filename,
                                                  String bufnoVal,
                                                  String foffsetVal,
                                                  String lengthVal)
                                           throws IfsException

Write to the test output from the file using buffer no, offset and the length to write to

Parameters:

filename - the file to read from

bufnoVal - the buffer index

foffsetVal - the offset in the buffer

lengthVal - the desired length to write to the canon

Throws:

IfsException - if the operation fails

canonWriteFromFileUsingOffset

public void canonWriteFromFileUsingOffset(String fname,
                                          String foffsetVal,
                                          String lengthVal)
                                   throws IfsException

Write to the Canons from the RACI using offset, and the length to write to

Parameters:

fname - the file to read from

foffsetVal - the absolute offset in the raci

lengthVal - the desired length to write to the canon

Throws:

IfsException - if the operation fails

flush

public void flush(String racitag)
           throws IfsException

Flush the RACI given a racitag

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

dispose

public void dispose(String racitag)
             throws IfsException

Dispose the RACI given a racitag

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

close

public void close(String racitag)
           throws IfsException

Close the RACI given a racitag

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

showLength

public void showLength(String racitag)
                throws IfsException

Shows the RACI length.

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

reestablishSessionContext

public void reestablishSessionContext(String racitag)
                               throws IfsException

Re-establish session context for a RACI.

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

clearSessionContext

public void clearSessionContext(String racitag)
                         throws IfsException

Clear session context for a RACI.

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

dumpContent

public void dumpContent(String objname,
                        String fileName)
                 throws IfsException

Dump the content of a Document to a file.

Parameters:

objname - the object tag

fileName - the output file, relative to IFSROOT

Throws:

IfsException - if the operation fails

getLength

protected long getLength(String racitag)
                  throws IfsException

Gets the RACI length.

Parameters:

racitag - the tag to the raci in the hashtable

Throws:

IfsException - if the operation fails

dumpData

protected void dumpData(byte[] pkt,
                        int offset,
                        int len)

Output a byte array to the debug stream in a readable format.

Parameters:

pkt - array to dump

offset - the offset in the stream (for display purposes, not offset into the byte array

len - the number of bytes to display

padHexString

protected String padHexString(int intVal,
                              int pad)

Converts an integer into its hexadecimal representation pre-padding with 0's.

padHexString

protected String padHexString(long longVal,
                              int pad)

Converts a long integer into its hexadecimal representation pre-padding with 0's.

padBinString

protected String padBinString(int intVal,
                              int pad)

Converts an integer into its hexadecimal representation pre-padding with 0's.

zeroPad

protected String zeroPad(String str,
                         int pad)

Pre-pad a string with 0's.

Overrides:

zeroPad in class ScriptOperations

Parameters:

str - the String to pad

pad - the length to pad

Returns:

the padded String

getCharacterEncoding

protected String getCharacterEncoding(LibrarySession session)
                               throws IfsException

Throws:

IfsException

getBlobBufferSize

protected int getBlobBufferSize()

lookupRACI

protected RandomAccessContentInterface lookupRACI(String racitag)
                                           throws IfsException

look up a RACI given a Racitag

Throws:

IfsException

lookupBuffer

protected Byte[] lookupBuffer(String buffertag)
                       throws IfsException

look up a buffer that has data given a buffertag.

Throws:

IfsException

performDocPartialTest

public void performDocPartialTest()
                           throws IfsException

Performs actions for DocPartialTest.

Throws:

IfsException - if the operation fails

performDocBfilePartialTest

public void performDocBfilePartialTest()
                                throws IfsException

Performs actions for DocBfilePartialTest.

Throws:

IfsException - if the operation fails

performRandomAccessorReadTest

public void performRandomAccessorReadTest()
                                   throws IfsException

Performs actions for RandomAccessorReadTest.

Throws:

IfsException - if the operation fails

performRandomAccessorWriteTest

public void performRandomAccessorWriteTest()
                                    throws IfsException

Performs actions for RandomAccessorWriteTest.

Throws:

IfsException - if the operation fails