oracle.ifs.core.tools.script.test

Class CommandProcessorOperations

java.lang.Object

oracle.ifs.core.tools.script.ScriptOperations

oracle.ifs.core.tools.script.test.CommandProcessorOperations

All Implemented Interfaces:

AttributeValueGetter, Logger

public class CommandProcessorOperations
extends ScriptOperations

CommandProcessorOperations contains operations used to test CUP functionality.

Version:

1.0

Author:

Dave Long

(Published)

Nested Class Summary

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 static String	INDENT
protected byte[]	m_ByteBuffer
protected AccessControlList	m_DefaultAcl
protected String	m_Delim
protected int	m_FolderDeleteMode
protected FolderPathResolver	m_FolderPathResolver
protected boolean	m_Verbose

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	acl(String aclname)
void	addproperty(String path, String propName, String propType, String propValue)
void	admin()
void	cd() Change current working directory.
void	cd(String dir) Change current working directory.
void	check_exists(String path)
void	checkin(String path) Updates the previously checked out version of the object at the specified path.
void	checkout(String path) Reserve a version of the Document object at the given path for a update.
protected void	createDocument(String name, Folder parent, String filename)
protected Folder	createFolder(String name, Folder parent) Create a folder under the parent specified.
void	delim()
void	delim(String newDelim)
protected Format	deriveDocumentFormat(String filename)
void	folder_count(String path)
void	folder_delete_mode(String mode)
void	folder(String objPath, String targetPath)
void	get(String filename)
void	get(String filename, String path)
protected byte[]	getByteBuffer()
protected int	getDesiredBufferSize()
protected FolderPathResolver	getFolderPathResolver()
void	getproperty(String path, String propertyName)
void	link_count(String path)
void	link(String objPath, String linkName, String targetPath)
void	linkfolder(String folderPath, String linkName, String targetPath)
protected DirectoryUser	lookupDirectoryUser(String username)
void	ls() Displays the contents of the current folder.
void	ls(String name) Displays the contents of the current folder.
protected AttributeValue	makeAttributeValue(String type, String value)
void	mkdir(String name) Creates a new folder.
void	noacl()
void	noadmin()
void	noverbose()
void	promote_folder(String path, String level) Promotes a folder to a new level in the folder index.
void	put(String filename)
void	put(String filename, String name)
void	pwd() Shows the current Directory path.
void	rename(String oldName, String newName) Rename a LibraryObject.
protected void	resetFolderPathResolver()
void	revert(String path) Cancels the checkout on a previously reserved document.
void	rm(String name)
void	rmdir(String foldername)
protected void	setAdminMode(boolean mode)
void	setattribute(String path, String attrName, String attrType, String attrValue)
void	setcontent(String filename)
void	setcontent(String filename, String path)
protected void	setDocumentContent(DocumentDefinition def, String filename)
void	setroot() Change the top-most root directory in the FolderPathResolver instance.
void	setroot(String dir) Change the top-most root directory in the FolderPathResolver instance.
protected void	setVerboseMode(boolean mode)
void	show_all_paths(String name)
void	show_all_paths(String name, String referencePath)
void	show_any_path(String name)
void	show_any_path(String name, String referencePath)
protected void	showFolder(String path, Folder folder, String match)
void	showhistory(String path) Shows the revision history of a given Document object.
protected void	showPublicObject(String path, PublicObject po)
void	su()
void	su(String username)
protected void	transferContent(InputStream iss, OutputStream os) transfer content from an inputstream to an outputstream.
void	unfolder(String objPath, String targetPath)
void	updatelink(String linkPath)
void	updatelink(String linkPath, String objPath)
void	verbose()
void	version(String path) Makes any document object versionable.
void	whoami()
protected void	writeContentToFile(Document doc, String filename)

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, 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, showDocument, 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, zeroPad

Methods inherited from class java.lang.Object

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

Field Detail

INDENT

protected static final String INDENT

See Also:

Constant Field Values

m_Verbose

protected boolean m_Verbose

m_FolderDeleteMode

protected int m_FolderDeleteMode

m_Delim

protected String m_Delim

m_FolderPathResolver

protected FolderPathResolver m_FolderPathResolver

m_DefaultAcl

protected AccessControlList m_DefaultAcl

m_ByteBuffer

protected byte[] m_ByteBuffer

Constructor Detail

CommandProcessorOperations

public CommandProcessorOperations(ScriptDriver driver)

Constructs a CommandProcessorOperations.

Parameters:

driver - the main script driver instance

Method Detail

pwd

public void pwd()
         throws IfsException

Shows the current Directory path. If no path set shows null.

Throws:

IfsException - If the operation fails.

cd

public void cd()
        throws IfsException

Change current working directory.

Throws:

IfsException - if the operation fails

cd

public void cd(String dir)
        throws IfsException

Change current working directory.

Parameters:

dir - New working directory.

Throws:

IfsException - if the operation fails

setroot

public void setroot()
             throws IfsException

Change the top-most root directory in the FolderPathResolver instance.

Throws:

IfsException - if the operation fails

setroot

public void setroot(String dir)
             throws IfsException

Change the top-most root directory in the FolderPathResolver instance.

Parameters:

dir - the path to the new root folder.

Throws:

IfsException - if the operation fails

resetFolderPathResolver

protected void resetFolderPathResolver()
                                throws IfsException

Throws:

IfsException

mkdir

public void mkdir(String name)
           throws IfsException

Creates a new folder. This is the top level function. This calls other variant of same name once it finds the directory under which new folder needs to be created.

Parameters:

name - Name of the new folder to be created

Throws:

IfsException - If the operation fails

promote_folder

public void promote_folder(String path,
                           String level)
                    throws IfsException

Promotes a folder to a new level in the folder index.

Parameters:

path - path of the folder

level - folder index level to promote to

Throws:

IfsException - If the operation fails.

ls

public void ls()
        throws IfsException

Displays the contents of the current folder.

Throws:

IfsException - if the operation fails.

ls

public void ls(String name)
        throws IfsException

Displays the contents of the current folder.

Parameters:

name - path to show

Throws:

IfsException - if the operation fails.

addproperty

public void addproperty(String path,
                        String propName,
                        String propType,
                        String propValue)
                 throws IfsException

Throws:

IfsException

setattribute

public void setattribute(String path,
                         String attrName,
                         String attrType,
                         String attrValue)
                  throws IfsException

Throws:

IfsException

setcontent

public void setcontent(String filename)
                throws IfsException

Throws:

IfsException

setcontent

public void setcontent(String filename,
                       String path)
                throws IfsException

Throws:

IfsException

rename

public void rename(String oldName,
                   String newName)
            throws IfsException

Description copied from class: ScriptOperations

Rename a LibraryObject.

Overrides:

rename in class ScriptOperations

Parameters:

oldName - the tag that identifes the object to be updated

newName - the new name for the specified object

Throws:

IfsException - if the operation fails

rm

public void rm(String name)
        throws IfsException

Throws:

IfsException

rmdir

public void rmdir(String foldername)
           throws IfsException

Throws:

IfsException

folder_delete_mode

public void folder_delete_mode(String mode)
                        throws IfsException

Throws:

IfsException

checkout

public void checkout(String path)
              throws IfsException

Reserve a version of the Document object at the given path for a update. This operation succeeds only if the Document object is Versionable. Always reserves the new version on the primary Version series. This method doe not copy the document on to the local file system.

Parameters:

path - Directory path of the document.

Throws:

IfsException - if the operation fails.

checkin

public void checkin(String path)
             throws IfsException

Updates the previously checked out version of the object at the specified path. Always works on the Primary version series. Needs to have the document checked out prior to this operation.

Parameters:

path - the path to the object both on the server and local file system

Throws:

IfsException - if the operation fails

revert

public void revert(String path)
            throws IfsException

Cancels the checkout on a previously reserved document.

Always assumes primary version series.

Parameters:

path - Directory path of the object.

Throws:

IfsException - if the operation fails

version

public void version(String path)
             throws IfsException

Makes any document object versionable. This is an internal operation. This is useful in test situations when documents are loaded using FTP and need to have versioning abilities. This works only once on a given Document object. A repeat call wil fail.

Parameters:

path - Directory path of the object.

Throws:

IfsException - if the operation fails.

showhistory

public void showhistory(String path)
                 throws IfsException

Shows the revision history of a given Document object. Assumes we are only interested in Primary Version Series.

Parameters:

path - Directory path of the object.

Throws:

IfsException - if the operation fails

folder_count

public void folder_count(String path)
                  throws IfsException

Throws:

IfsException

link_count

public void link_count(String path)
                throws IfsException

Throws:

IfsException

show_any_path

public void show_any_path(String name)
                   throws IfsException

Throws:

IfsException

show_any_path

public void show_any_path(String name,
                          String referencePath)
                   throws IfsException

Throws:

IfsException

show_all_paths

public void show_all_paths(String name)
                    throws IfsException

Throws:

IfsException

show_all_paths

public void show_all_paths(String name,
                           String referencePath)
                    throws IfsException

Throws:

IfsException

whoami

public void whoami()
            throws IfsException

Throws:

IfsException

su

public void su()
        throws IfsException

Throws:

IfsException

su

public void su(String username)
        throws IfsException

Throws:

IfsException

admin

public void admin()
           throws IfsException

Throws:

IfsException

noadmin

public void noadmin()
             throws IfsException

Throws:

IfsException

setAdminMode

protected void setAdminMode(boolean mode)
                     throws IfsException

Throws:

IfsException

verbose

public void verbose()
             throws IfsException

Throws:

IfsException

noverbose

public void noverbose()
               throws IfsException

Throws:

IfsException

setVerboseMode

protected void setVerboseMode(boolean mode)
                       throws IfsException

Throws:

IfsException

delim

public void delim()
           throws IfsException

Throws:

IfsException

delim

public void delim(String newDelim)
           throws IfsException

Throws:

IfsException

acl

public void acl(String aclname)
         throws IfsException

Throws:

IfsException

noacl

public void noacl()
           throws IfsException

Throws:

IfsException

get

public void get(String filename)
         throws IfsException

Throws:

IfsException

get

public void get(String filename,
                String path)
         throws IfsException

Throws:

IfsException

folder

public void folder(String objPath,
                   String targetPath)
            throws IfsException

Throws:

IfsException

unfolder

public void unfolder(String objPath,
                     String targetPath)
              throws IfsException

Throws:

IfsException

link

public void link(String objPath,
                 String linkName,
                 String targetPath)
          throws IfsException

Throws:

IfsException

linkfolder

public void linkfolder(String folderPath,
                       String linkName,
                       String targetPath)
                throws IfsException

Throws:

IfsException

updatelink

public void updatelink(String linkPath)
                throws IfsException

Throws:

IfsException

updatelink

public void updatelink(String linkPath,
                       String objPath)
                throws IfsException

Throws:

IfsException

check_exists

public void check_exists(String path)
                  throws IfsException

Throws:

IfsException

put

public void put(String filename)
         throws IfsException

Throws:

IfsException

put

public void put(String filename,
                String name)
         throws IfsException

Throws:

IfsException

getproperty

public void getproperty(String path,
                        String propertyName)
                 throws IfsException

Throws:

IfsException

getFolderPathResolver

protected FolderPathResolver getFolderPathResolver()
                                            throws IfsException

Throws:

IfsException

createFolder

protected Folder createFolder(String name,
                              Folder parent)
                       throws IfsException

Create a folder under the parent specified.

Parameters:

name - Name of the folder to be created.

parent - Name of the parent.

Throws:

IfsException - If the operation fails.

lookupDirectoryUser

protected DirectoryUser lookupDirectoryUser(String username)
                                     throws IfsException

Throws:

IfsException

createDocument

protected void createDocument(String name,
                              Folder parent,
                              String filename)
                       throws IfsException

Throws:

IfsException

setDocumentContent

protected void setDocumentContent(DocumentDefinition def,
                                  String filename)
                           throws IfsException

Throws:

IfsException

deriveDocumentFormat

protected Format deriveDocumentFormat(String filename)
                               throws IfsException

Throws:

IfsException

showPublicObject

protected void showPublicObject(String path,
                                PublicObject po)
                         throws IfsException

Throws:

IfsException

showFolder

protected void showFolder(String path,
                          Folder folder,
                          String match)
                   throws IfsException

Throws:

IfsException

makeAttributeValue

protected AttributeValue makeAttributeValue(String type,
                                            String value)
                                     throws IfsException

Throws:

IfsException

writeContentToFile

protected void writeContentToFile(Document doc,
                                  String filename)
                           throws IfsException

Throws:

IfsException

getDesiredBufferSize

protected int getDesiredBufferSize()

getByteBuffer

protected byte[] getByteBuffer()

transferContent

protected void transferContent(InputStream iss,
                               OutputStream os)
                        throws IOException

transfer content from an inputstream to an outputstream.

Throws:

IOException