java.lang.Object
- com.logicaldoc.core.PersistentObject
- - com.logicaldoc.importfolder.ImportFolder

```
public class ImportFolder
extends com.logicaldoc.core.PersistentObject
```
A local or remote importFolder such as a samba directory

Since:

2.0

Author:

Marco Meschieri - LogicalDOC

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`POLICY_NEW_DOCUMENT`
`static int`	`POLICY_NEW_VERSION`
`static String`	`PROVIDER_FILE`
`static String`	`PROVIDER_FTP`
`static String`	`PROVIDER_FTPS`
`static String`	`PROVIDER_SFTP`
`static String`	`PROVIDER_SMB`
`static String`	`PROVIDER_SMB2`
`static String`	`PROVIDER_SMB3`

Fields inherited from class com.logicaldoc.core.PersistentObject
DELETED_CODE_DEFAULT, DELETED_CODE_STRONG

Constructor Summary

Constructors
Constructor Description

ImportFolder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static String`	`decryptPassword(String password)`
`long`	`getBatch()`
`int`	`getDelImport()`
`int`	`getDepth()`
`String`	`getDisplayUrl()`	Composes the displayable importFolder's url
`String`	`getDomain()`
`int`	`getEnabled()`
`String`	`getExcludes()`
`String`	`getHost()`
`int`	`getImportEmpty()`
`String`	`getIncludes()`
`int`	`getInheritRights()`
`String`	`getLanguage()`
`Locale`	`getLocale()`
`Integer`	`getMaxSize()`	The maximum file size, expressed in bytes
`String`	`getPassword()`
`String`	`getPasswordDecrypted()`
`String`	`getPath()`
`String`	`getPort()`
`String`	`getProvider()`
`Date`	`getStartDate()`
`String`	`getTags()`
`Long`	`getTargetFolderId()`
`Long`	`getTemplateId()`
`int`	`getUpdatePolicy()`
`String`	`getUrl()`	Composes the complete importFolder's url
`String`	`getUsername()`
`boolean`	`isAllowed(String filename)`	Check if the specified filename is allowed or not.
`void`	`setBatch(long batch)`
`void`	`setDelImport(int delImport)`
`void`	`setDepth(int depth)`
`void`	`setDomain(String domain)`
`void`	`setEnabled(int enabled)`
`void`	`setExcludes(String excludes)`
`void`	`setHost(String host)`
`void`	`setImportEmpty(int importEmpty)`
`void`	`setIncludes(String includes)`
`void`	`setInheritRights(int inheritRights)`
`void`	`setLanguage(String language)`
`void`	`setLocale(Locale locale)`
`void`	`setMaxSize(Integer maxSize)`
`void`	`setPassword(String password)`
`void`	`setPath(String url)`
`void`	`setPort(String port)`
`void`	`setProvider(String provider)`
`void`	`setStartDate(Date startDate)`
`void`	`setTags(String tags)`
`void`	`setTargetFolderId(Long targetFolderId)`
`void`	`setTemplateId(Long templateId)`
`void`	`setUpdatePolicy(int updatePolicy)`
`void`	`setUsername(String userName)`

Methods inherited from class com.logicaldoc.core.PersistentObject
equals, getDeleted, getId, getLastModified, getRecordVersion, getTenantId, hashCode, setDeleted, setId, setLastModified, setRecordVersion, setTenantId, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROVIDER_SMB
```
public static String PROVIDER_SMB
```

PROVIDER_SMB2
```
public static String PROVIDER_SMB2
```

PROVIDER_SMB3
```
public static String PROVIDER_SMB3
```

PROVIDER_FILE
```
public static String PROVIDER_FILE
```

PROVIDER_FTP
```
public static String PROVIDER_FTP
```

PROVIDER_FTPS
```
public static String PROVIDER_FTPS
```

PROVIDER_SFTP
```
public static String PROVIDER_SFTP
```

POLICY_NEW_VERSION
```
public static int POLICY_NEW_VERSION
```

POLICY_NEW_DOCUMENT
```
public static int POLICY_NEW_DOCUMENT
```

Constructor Detail
- ImportFolder
```
public ImportFolder()
```

Method Detail

getBatch
```
public long getBatch()
```

setBatch
```
public void setBatch(long batch)
```

getTemplateId
```
public Long getTemplateId()
```

setTemplateId

public void setTemplateId(Long templateId)

getLanguage
```
public String getLanguage()
```

setLanguage

public void setLanguage(String language)

getProvider
```
public String getProvider()
```

setProvider

public void setProvider(String provider)

getPath
```
public String getPath()
```

setPath
```
public void setPath(String url)
```

getUsername
```
public String getUsername()
```

setUsername

public void setUsername(String userName)

getDepth
```
public int getDepth()
```

setDepth
```
public void setDepth(int depth)
```

getHost
```
public String getHost()
```

setHost
```
public void setHost(String host)
```

getPort
```
public String getPort()
```

setPort
```
public void setPort(String port)
```

getPassword
```
public String getPassword()
```

getPasswordDecrypted
```
public String getPasswordDecrypted()
```

setPassword

public void setPassword(String password)

decryptPassword

public static String decryptPassword(String password)

getUrl
```
public String getUrl()
```
Composes the complete importFolder's url

Returns:

url of the import folder

getDisplayUrl
```
public String getDisplayUrl()
```
Composes the displayable importFolder's url

Returns:

the display url

isAllowed
```
public boolean isAllowed(String filename)
```
Check if the specified filename is allowed or not.

Parameters:

filename - The filename to check

Returns:

True if filename matches the includes and not the excludes

getEnabled
```
public int getEnabled()
```

setEnabled

public void setEnabled(int enabled)

getMaxSize
```
public Integer getMaxSize()
```
The maximum file size, expressed in bytes

Returns:

the maximum size

setMaxSize

public void setMaxSize(Integer maxSize)

getTags
```
public String getTags()
```

setTags
```
public void setTags(String tags)
```

getLocale
```
public Locale getLocale()
```

setLocale

public void setLocale(Locale locale)

getTargetFolderId
```
public Long getTargetFolderId()
```

setTargetFolderId

public void setTargetFolderId(Long targetFolderId)

getDelImport
```
public int getDelImport()
```

setDelImport

public void setDelImport(int delImport)

getIncludes
```
public String getIncludes()
```

setIncludes

public void setIncludes(String includes)

getExcludes
```
public String getExcludes()
```

setExcludes

public void setExcludes(String excludes)

getDomain
```
public String getDomain()
```

setDomain

public void setDomain(String domain)

getStartDate
```
public Date getStartDate()
```

setStartDate

public void setStartDate(Date startDate)

getUpdatePolicy
```
public int getUpdatePolicy()
```

setUpdatePolicy

public void setUpdatePolicy(int updatePolicy)

getImportEmpty
```
public int getImportEmpty()
```

setImportEmpty

public void setImportEmpty(int importEmpty)

getInheritRights
```
public int getInheritRights()
```

setInheritRights

public void setInheritRights(int inheritRights)

Class ImportFolder

Field Summary

Fields inherited from class com.logicaldoc.core.PersistentObject

Constructor Summary

Method Summary

Methods inherited from class com.logicaldoc.core.PersistentObject

Methods inherited from class java.lang.Object

Field Detail

PROVIDER_SMB

PROVIDER_SMB2

PROVIDER_SMB3

PROVIDER_FILE

PROVIDER_FTP

PROVIDER_FTPS

PROVIDER_SFTP

POLICY_NEW_VERSION

POLICY_NEW_DOCUMENT

Constructor Detail

ImportFolder

Method Detail

getBatch

setBatch

getTemplateId

setTemplateId

getLanguage

setLanguage

getProvider

setProvider

getPath

setPath

getUsername

setUsername

getDepth

setDepth

getHost

setHost

getPort

setPort

getPassword

getPasswordDecrypted

setPassword

decryptPassword

getUrl

getDisplayUrl

isAllowed

getEnabled

setEnabled

getMaxSize

setMaxSize

getTags

setTags

getLocale

setLocale

getTargetFolderId

setTargetFolderId

getDelImport

setDelImport

getIncludes

setIncludes

getExcludes

setExcludes

getDomain

setDomain

getStartDate

setStartDate

getUpdatePolicy

setUpdatePolicy

getImportEmpty

setImportEmpty

getInheritRights

setInheritRights