Package org.alfresco.ftp

Class FTPWrapper

java.lang.Object

org.alfresco.utility.dsl.DSLWrapper<Client>

org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

org.alfresco.ftp.FTPWrapper

All Implemented Interfaces:

org.alfresco.utility.dsl.DSL<FTPWrapper>, org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>, org.alfresco.utility.dsl.DSLFile<FTPWrapper>, org.alfresco.utility.dsl.DSLFolder<FTPWrapper>

@Service
@Scope("prototype")
public class FTPWrapper
extends org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>
implements org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>, org.alfresco.utility.dsl.DSLFolder<FTPWrapper>, org.alfresco.utility.dsl.DSLFile<FTPWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
protected FTPProperties	fTPProperties
java.io.File	lastDownloadedFile
int	replyCode
static java.lang.String	STEP_PREFIX
protected org.alfresco.utility.TasProperties	tasProperties

Fields inherited from class org.alfresco.utility.dsl.DSLWrapper

contentService, dataContent, jmxBuilder, LOG

Constructor Summary

Constructors

Constructor	Description
FTPWrapper()

Method Summary

Modifier and Type	Method	Description
FTPWrapper	appendContent(java.lang.String content)	Append content to file
FTPAssertion	assertThat()
FTPWrapper	authenticateUser(org.alfresco.utility.model.UserModel userModel)
FTPWrapper	authenticateUser(org.alfresco.utility.model.UserModel userModel, int fileTransferMode)	Authenticate user and set the file transfer mode (use FTP) codes: 10 - FTP.STREAM_TRANSFER_MODE, 11 - FTP.BLOCK_TRANSFER_MODE, 12 - FTP.COMPRESSED_TRANSFER_MODE)
FTPWrapper	authenticateUser(org.alfresco.utility.model.UserModel userModel, java.lang.String server, int port)
FTPWrapper	changeWorkingDirectory(java.lang.String newFolder)
FTPWrapper	copyTo(org.alfresco.utility.model.ContentModel destination)
FTPWrapper	createFile(org.alfresco.utility.model.FileModel fileModel)
FTPWrapper	createFile(org.alfresco.utility.model.FileModel fileModel, int fileSize)
FTPWrapper	createFolder(org.alfresco.utility.model.FolderModel folderModel)
FTPWrapper	createOfficeFile(org.alfresco.utility.model.FileModel fileModel)	Create Office file which will be used in Integration tests by AOS
FTPWrapper	delete()
FTPWrapper	delete(java.lang.String path)
FTPWrapper	disconnect()
FTPWrapper	downloadFileTo(org.alfresco.utility.model.FolderModel destination)	Download file locally, returning the new location
org.apache.commons.net.ftp.FTPClient	getClient()
java.lang.String	getCurrentDirectory()
java.lang.String	getDataDictionaryPath()
java.lang.String	getDocumentLibraryPath(org.alfresco.utility.model.SiteModel siteModel)
java.util.List<org.alfresco.utility.model.FileModel>	getFiles()
java.util.List<org.alfresco.utility.model.FolderModel>	getFolders()
java.lang.String	getModificationTime()	Get modification time of last resource
java.lang.String	getPrefixSpace()
protected java.lang.String	getProtocolJMXConfigurationStatus()
java.lang.String	getRootPath()
java.lang.String	getSitesPath()
java.lang.String	getUserHomesPath()
FTPWrapper	moveTo(org.alfresco.utility.model.ContentModel destination)
FTPWrapper	rename(java.lang.String newName)
FTPWrapper	update(java.lang.String newContent)
FTPWrapper	uploadFile(java.io.File file)	Upload file from disk via FTP protocol
FTPWrapper	uploadFile(java.lang.String pathToFile)	Upload file from disk via FTP protocol
FTPWrapper	usingResource(org.alfresco.utility.model.ContentModel model)
FTPWrapper	usingRoot()
FTPWrapper	usingSite(java.lang.String siteId)
FTPWrapper	usingSite(org.alfresco.utility.model.SiteModel siteModel)
FTPWrapper	usingUserHome()
FTPWrapper	usingUserHome(java.lang.String username)
FTPUtil	withFtpUtil()
JmxUtil	withJMX()

Methods inherited from class org.alfresco.utility.dsl.DSLProtocol

and, buildPath, buildSiteDocumentLibraryPath, buildUserHomePath, closeJmxConnection, getCurrentSpace, getCurrentUser, getLastContentModel, getLastResource, getLastResourceWithoutPrefix, getProtocolName, isProtocolEnabled, setCurrentSpace, setLastContentModel, setLastResource, then, usingAdmin, usingUser, waitSeconds, when

Methods inherited from class org.alfresco.utility.dsl.DSLWrapper

getDataContentService, getTestUser, setTestUser

Methods inherited from class java.lang.Object

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

Field Detail

fTPProperties

@Autowired
protected FTPProperties fTPProperties

tasProperties

@Autowired
protected org.alfresco.utility.TasProperties tasProperties

STEP_PREFIX

public static java.lang.String STEP_PREFIX

replyCode

public int replyCode

lastDownloadedFile

public java.io.File lastDownloadedFile

Constructor Detail

FTPWrapper

public FTPWrapper()

Method Detail

getClient

public org.apache.commons.net.ftp.FTPClient getClient()

authenticateUser

public FTPWrapper authenticateUser(org.alfresco.utility.model.UserModel userModel)
                            throws java.lang.Exception

Specified by:

authenticateUser in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

authenticateUser

public FTPWrapper authenticateUser(org.alfresco.utility.model.UserModel userModel,
                                   java.lang.String server,
                                   int port)
                            throws java.lang.Exception

Throws:

java.lang.Exception

authenticateUser

public FTPWrapper authenticateUser(org.alfresco.utility.model.UserModel userModel,
                                   int fileTransferMode)
                            throws java.lang.Exception

Authenticate user and set the file transfer mode (use FTP) codes: 10 - FTP.STREAM_TRANSFER_MODE, 11 - FTP.BLOCK_TRANSFER_MODE, 12 - FTP.COMPRESSED_TRANSFER_MODE)

Parameters:

userModel -

fileTransferMode -

Returns:

Throws:

java.lang.Exception

createFolder

public FTPWrapper createFolder(org.alfresco.utility.model.FolderModel folderModel)
                        throws java.lang.Exception

Specified by:

createFolder in interface org.alfresco.utility.dsl.DSLFolder<FTPWrapper>

Throws:

java.lang.Exception

getPrefixSpace

public java.lang.String getPrefixSpace()

Specified by:

getPrefixSpace in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

getProtocolJMXConfigurationStatus

protected java.lang.String getProtocolJMXConfigurationStatus()
                                                      throws java.lang.Exception

Specified by:

getProtocolJMXConfigurationStatus in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

disconnect

public FTPWrapper disconnect()
                      throws java.lang.Exception

Specified by:

disconnect in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

changeWorkingDirectory

public FTPWrapper changeWorkingDirectory(java.lang.String newFolder)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCurrentDirectory

public java.lang.String getCurrentDirectory()
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getRootPath

public java.lang.String getRootPath()
                             throws org.alfresco.utility.exception.TestConfigurationException

Specified by:

getRootPath in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

getRootPath in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

org.alfresco.utility.exception.TestConfigurationException

usingRoot

public FTPWrapper usingRoot()
                     throws org.alfresco.utility.exception.TestConfigurationException,
                            java.lang.Exception

Specified by:

usingRoot in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Overrides:

usingRoot in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

org.alfresco.utility.exception.TestConfigurationException

java.lang.Exception

usingUserHome

public FTPWrapper usingUserHome()
                         throws org.alfresco.utility.exception.TestConfigurationException,
                                java.lang.Exception

Specified by:

usingUserHome in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

usingUserHome in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

org.alfresco.utility.exception.TestConfigurationException

java.lang.Exception

getFiles

public java.util.List<org.alfresco.utility.model.FileModel> getFiles()
                                                              throws java.lang.Exception

Specified by:

getFiles in interface org.alfresco.utility.dsl.DSLFile<FTPWrapper>

Throws:

java.lang.Exception

getFolders

public java.util.List<org.alfresco.utility.model.FolderModel> getFolders()
                                                                  throws java.lang.Exception

Specified by:

getFolders in interface org.alfresco.utility.dsl.DSLFolder<FTPWrapper>

Throws:

java.lang.Exception

getSitesPath

public java.lang.String getSitesPath()
                              throws org.alfresco.utility.exception.TestConfigurationException

Specified by:

getSitesPath in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

getSitesPath in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

org.alfresco.utility.exception.TestConfigurationException

getUserHomesPath

public java.lang.String getUserHomesPath()
                                  throws org.alfresco.utility.exception.TestConfigurationException

Specified by:

getUserHomesPath in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

getUserHomesPath in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

org.alfresco.utility.exception.TestConfigurationException

getDataDictionaryPath

public java.lang.String getDataDictionaryPath()
                                       throws org.alfresco.utility.exception.TestConfigurationException

Specified by:

getDataDictionaryPath in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

getDataDictionaryPath in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

org.alfresco.utility.exception.TestConfigurationException

usingSite

public FTPWrapper usingSite(java.lang.String siteId)
                     throws java.lang.Exception

Specified by:

usingSite in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

usingSite in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

usingSite

public FTPWrapper usingSite(org.alfresco.utility.model.SiteModel siteModel)
                     throws java.lang.Exception

Specified by:

usingSite in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

usingSite in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

usingUserHome

public FTPWrapper usingUserHome(java.lang.String username)
                         throws java.lang.Exception

Specified by:

usingUserHome in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

usingUserHome in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

usingResource

public FTPWrapper usingResource(org.alfresco.utility.model.ContentModel model)
                         throws java.lang.Exception

Specified by:

usingResource in interface org.alfresco.utility.dsl.DSL<FTPWrapper>

Specified by:

usingResource in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

Throws:

java.lang.Exception

rename

public FTPWrapper rename(java.lang.String newName)
                  throws java.lang.Exception

Specified by:

rename in interface org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>

Throws:

java.lang.Exception

update

public FTPWrapper update(java.lang.String newContent)
                  throws java.lang.Exception

Specified by:

update in interface org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>

Throws:

java.lang.Exception

appendContent

public FTPWrapper appendContent(java.lang.String content)
                         throws java.lang.Exception

Append content to file

Parameters:

content -

Returns:

Throws:

java.lang.Exception

delete

public FTPWrapper delete()
                  throws java.lang.Exception

Specified by:

delete in interface org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>

Throws:

java.lang.Exception

delete

public FTPWrapper delete(java.lang.String path)
                  throws java.lang.Exception

Throws:

java.lang.Exception

copyTo

public FTPWrapper copyTo(org.alfresco.utility.model.ContentModel destination)
                  throws java.lang.Exception

Specified by:

copyTo in interface org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>

Throws:

java.lang.Exception

moveTo

public FTPWrapper moveTo(org.alfresco.utility.model.ContentModel destination)
                  throws java.lang.Exception

Specified by:

moveTo in interface org.alfresco.utility.dsl.DSLContentModelAction<FTPWrapper>

Throws:

java.lang.Exception

createFile

public FTPWrapper createFile(org.alfresco.utility.model.FileModel fileModel)
                      throws java.lang.Exception

Specified by:

createFile in interface org.alfresco.utility.dsl.DSLFile<FTPWrapper>

Throws:

java.lang.Exception

createFile

public FTPWrapper createFile(org.alfresco.utility.model.FileModel fileModel,
                             int fileSize)
                      throws java.lang.Exception

Throws:

java.lang.Exception

createOfficeFile

public FTPWrapper createOfficeFile(org.alfresco.utility.model.FileModel fileModel)
                            throws java.lang.Exception

Create Office file which will be used in Integration tests by AOS

Parameters:

fileModel -

Returns:

Throws:

java.lang.Exception

uploadFile

public FTPWrapper uploadFile(java.lang.String pathToFile)
                      throws java.lang.Exception

Upload file from disk via FTP protocol

Parameters:

pathToFile -

Returns:

Throws:

java.lang.Exception

uploadFile

public FTPWrapper uploadFile(java.io.File file)
                      throws java.lang.Exception

Upload file from disk via FTP protocol

Parameters:

file - File

Returns:

Throws:

java.lang.Exception

withJMX

public JmxUtil withJMX()

Returns:

JMX DSL for this wrapper

withFtpUtil

public FTPUtil withFtpUtil()

assertThat

public FTPAssertion assertThat()

Overrides:

assertThat in class org.alfresco.utility.dsl.DSLProtocol<FTPWrapper>

getDocumentLibraryPath

public java.lang.String getDocumentLibraryPath(org.alfresco.utility.model.SiteModel siteModel)
                                        throws org.alfresco.utility.exception.TestConfigurationException,
                                               java.lang.Exception

Throws:

org.alfresco.utility.exception.TestConfigurationException

java.lang.Exception

downloadFileTo

public FTPWrapper downloadFileTo(org.alfresco.utility.model.FolderModel destination)
                          throws java.lang.Exception

Download file locally, returning the new location

Parameters:

destination -

Returns:

Throws:

java.lang.Exception

getModificationTime

public java.lang.String getModificationTime()
                                     throws java.lang.Exception

Get modification time of last resource

Returns:

Throws:

java.lang.Exception