org.semanticdesktop.aperture.datasource.imap
Class ImapDataSource

java.lang.Object
  org.semanticdesktop.aperture.datasource.base.DataSourceBase
      org.semanticdesktop.aperture.datasource.config.DomainBoundableDataSource
          org.semanticdesktop.aperture.datasource.imap.ImapDataSource

All Implemented Interfaces:

DomainBoundable, DataSource

public class ImapDataSource
extends DomainBoundableDataSource

Data source class file. Created by org.semanticdesktop.aperture.datasource.mojo.DataSourceClassGenerator on Thu Jul 01 14:28:15 CEST 2010 input file: D:\intella\aperture-trunk\target\checkout\core\src\main\resources\org\semanticdesktop\aperture\datasource\imap\imapDataSource.ttl class uri: http://aperture.semanticdesktop.org/ontology/2007/08/12/imapds#ImapDataSource

Nested Class Summary

static class

ImapDataSource.ConnectionSecurity Enum of possible values of the connectionSecurity property

Constructor Summary

ImapDataSource()

Method Summary

Collection<String>	getAllBasepaths() Returns a collection of all values of The base path of the IMAP data source
ImapDataSource.ConnectionSecurity	getConnectionSecurity() Returns the The level of security for the connection
String	getHostname() Returns the The host name of the IMAP server
Boolean	getIgnoreUidValidity() Returns the Should the crawler ignore the UID validity?
Boolean	getIncludeInbox() Returns the Should the inbox itself be included in the crawl results?
Integer	getMaximumDepth() Returns the Maximum depth of the crawl
Long	getMaximumSize() Returns the Maximum size (in bytes) of the attachments that are to be reported by the crawler
String	getPassword() Returns the The Password used to access this datasource.
Integer	getPort() Returns the The port number where the IMAP server is listening for connections
String	getSslFileName() Returns the The path to the ssl keyfile
String	getSslFilePassword() Returns the Keyphrase for the SSL keyfile
URI	getType() Returns a URI that indicates the DataSource type in a platform- and programming language-independent way.
Boolean	getUseHeadersHash() Returns the On mh-backed IMAP folders the crawler doesn't use the UID as part of the URI.
String	getUsername() Returns the Username used for authentication in a data source
void	setAllBasepaths(List<String> basepath) Sets all The base path of the IMAP data sources at once
void	setBasepath(String basepath) Sets the The base path of the IMAP data source
void	setConnectionSecurity(ImapDataSource.ConnectionSecurity connectionSecurity) Sets the The level of security for the connection
void	setHostname(String hostname) Sets the The host name of the IMAP server
void	setIgnoreUidValidity(Boolean ignoreUidValidity) Sets the Should the crawler ignore the UID validity?
void	setIncludeInbox(Boolean includeInbox) Sets the Should the inbox itself be included in the crawl results?
void	setMaximumDepth(Integer maximumDepth) Sets the Maximum depth of the crawl
void	setMaximumSize(Long maximumSize) Sets the Maximum size (in bytes) of the attachments that are to be reported by the crawler
void	setPassword(String password) Sets the The Password used to access this datasource.
void	setPort(Integer port) Sets the The port number where the IMAP server is listening for connections
void	setSslFileName(String sslFileName) Sets the The path to the ssl keyfile
void	setSslFilePassword(String sslFilePassword) Sets the Keyphrase for the SSL keyfile
void	setUseHeadersHash(Boolean useHeadersHash) Sets the On mh-backed IMAP folders the crawler doesn't use the UID as part of the URI.
void	setUsername(String username) Sets the Username used for authentication in a data source

Methods inherited from class org.semanticdesktop.aperture.datasource.config.DomainBoundableDataSource

getDomainBoundaries, setDomainBoundaries

Methods inherited from class org.semanticdesktop.aperture.datasource.base.DataSourceBase

dispose, getComment, getConfiguration, getID, getName, getTimeout, setComment, setConfiguration, setName, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

ImapDataSource

public ImapDataSource()

Method Detail

getType

public URI getType()

Description copied from interface: DataSource

Returns a URI that indicates the DataSource type in a platform- and programming language-independent way.

Returns:

A URI indicating the DataSource type

See Also:

DataSource.getType()

getHostname

public String getHostname()

Returns the The host name of the IMAP server

Returns:

the The host name of the IMAP server or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setHostname

public void setHostname(String hostname)

Sets the The host name of the IMAP server

Parameters:

hostname - The host name of the IMAP server, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getPort

public Integer getPort()

Returns the The port number where the IMAP server is listening for connections

Returns:

the The port number where the IMAP server is listening for connections or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setPort

public void setPort(Integer port)

Sets the The port number where the IMAP server is listening for connections

Parameters:

port - The port number where the IMAP server is listening for connections, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getUsername

public String getUsername()

Returns the Username used for authentication in a data source

Returns:

the Username used for authentication in a data source or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setUsername

public void setUsername(String username)

Sets the Username used for authentication in a data source

Parameters:

username - Username used for authentication in a data source, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getPassword

public String getPassword()

Returns the The Password used to access this datasource.

Returns:

the The Password used to access this datasource. or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setPassword

public void setPassword(String password)

Sets the The Password used to access this datasource.

Parameters:

password - The Password used to access this datasource., can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getAllBasepaths

public Collection<String> getAllBasepaths()

Returns a collection of all values of The base path of the IMAP data source

Returns:

a collection of all values of The base path of the IMAP data source the collection may be empty if no values have been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setBasepath

public void setBasepath(String basepath)

Sets the The base path of the IMAP data source

Parameters:

basepath - The base path of the IMAP data source, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

MultipleValuesException - if this property had more that one value before this method was called

setAllBasepaths

public void setAllBasepaths(List<String> basepath)

Sets all The base path of the IMAP data sources at once

Parameters:

basepath - The base path of the IMAP data source, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getIncludeInbox

public Boolean getIncludeInbox()

Returns the Should the inbox itself be included in the crawl results?

Returns:

the Should the inbox itself be included in the crawl results? or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setIncludeInbox

public void setIncludeInbox(Boolean includeInbox)

Sets the Should the inbox itself be included in the crawl results?

Parameters:

includeInbox - Should the inbox itself be included in the crawl results?, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getMaximumSize

public Long getMaximumSize()

Returns the Maximum size (in bytes) of the attachments that are to be reported by the crawler

Returns:

the Maximum size (in bytes) of the attachments that are to be reported by the crawler or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setMaximumSize

public void setMaximumSize(Long maximumSize)

Sets the Maximum size (in bytes) of the attachments that are to be reported by the crawler

Parameters:

maximumSize - Maximum size (in bytes) of the attachments that are to be reported by the crawler, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getMaximumDepth

public Integer getMaximumDepth()

Returns the Maximum depth of the crawl

Returns:

the Maximum depth of the crawl or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setMaximumDepth

public void setMaximumDepth(Integer maximumDepth)

Sets the Maximum depth of the crawl

Parameters:

maximumDepth - Maximum depth of the crawl, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getIgnoreUidValidity

public Boolean getIgnoreUidValidity()

Returns the Should the crawler ignore the UID validity? THIS OPTION MAY BE DANGEROUS, USE AT YOUR OWN RISK, ONLY ON FAULTY SERVERS THAT DON'T PERSIST EMAIL IDs, ONLY IF YOU DON'T DELETE ANY EMAILS AND ONLY IF YOU REALLY NEED IT!!!! IF YOU DO DELETE AN EMAIL FROM SUCH A SERVER, THE CRAWLER WILL RETURN WRONG RESULTS

Returns:

the Should the crawler ignore the UID validity? THIS OPTION MAY BE DANGEROUS, USE AT YOUR OWN RISK, ONLY ON FAULTY SERVERS THAT DON'T PERSIST EMAIL IDs, ONLY IF YOU DON'T DELETE ANY EMAILS AND ONLY IF YOU REALLY NEED IT!!!! IF YOU DO DELETE AN EMAIL FROM SUCH A SERVER, THE CRAWLER WILL RETURN WRONG RESULTS or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setIgnoreUidValidity

public void setIgnoreUidValidity(Boolean ignoreUidValidity)

Sets the Should the crawler ignore the UID validity? THIS OPTION MAY BE DANGEROUS, USE AT YOUR OWN RISK, ONLY ON FAULTY SERVERS THAT DON'T PERSIST EMAIL IDs, ONLY IF YOU DON'T DELETE ANY EMAILS AND ONLY IF YOU REALLY NEED IT!!!! IF YOU DO DELETE AN EMAIL FROM SUCH A SERVER, THE CRAWLER WILL RETURN WRONG RESULTS

Parameters:

ignoreUidValidity - Should the crawler ignore the UID validity? THIS OPTION MAY BE DANGEROUS, USE AT YOUR OWN RISK, ONLY ON FAULTY SERVERS THAT DON'T PERSIST EMAIL IDs, ONLY IF YOU DON'T DELETE ANY EMAILS AND ONLY IF YOU REALLY NEED IT!!!! IF YOU DO DELETE AN EMAIL FROM SUCH A SERVER, THE CRAWLER WILL RETURN WRONG RESULTS, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getConnectionSecurity

public ImapDataSource.ConnectionSecurity getConnectionSecurity()

Returns the The level of security for the connection

Returns:

the The level of security for the connection or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setConnectionSecurity

public void setConnectionSecurity(ImapDataSource.ConnectionSecurity connectionSecurity)

Sets the The level of security for the connection

Parameters:

connectionSecurity - The level of security for the connection, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getSslFileName

public String getSslFileName()

Returns the The path to the ssl keyfile

Returns:

the The path to the ssl keyfile or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setSslFileName

public void setSslFileName(String sslFileName)

Sets the The path to the ssl keyfile

Parameters:

sslFileName - The path to the ssl keyfile, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getSslFilePassword

public String getSslFilePassword()

Returns the Keyphrase for the SSL keyfile

Returns:

the Keyphrase for the SSL keyfile or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setSslFilePassword

public void setSslFilePassword(String sslFilePassword)

Sets the Keyphrase for the SSL keyfile

Parameters:

sslFilePassword - Keyphrase for the SSL keyfile, can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

getUseHeadersHash

public Boolean getUseHeadersHash()

Returns the On mh-backed IMAP folders the crawler doesn't use the UID as part of the URI. Instead it uses the value of the Message-ID header combined with a hash of the entire message. This is slow as each incremental crawl requires the crawler do download all messages. Setting this option to true will cause the crawler to use only values of selected headers in hash computation. This increases the incremental crawling speed on mh-backed folders at the expense of overlooking certain messages with the same Message-ID and other headers values, but different content. The default is true for speed. If you need accuracy, to be 100% sure that no near-duplicate message pairs are omitted - set it to false.

Returns:

the On mh-backed IMAP folders the crawler doesn't use the UID as part of the URI. Instead it uses the value of the Message-ID header combined with a hash of the entire message. This is slow as each incremental crawl requires the crawler do download all messages. Setting this option to true will cause the crawler to use only values of selected headers in hash computation. This increases the incremental crawling speed on mh-backed folders at the expense of overlooking certain messages with the same Message-ID and other headers values, but different content. The default is true for speed. If you need accuracy, to be 100% sure that no near-duplicate message pairs are omitted - set it to false. or null if no value has been set

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method

setUseHeadersHash

public void setUseHeadersHash(Boolean useHeadersHash)

Sets the On mh-backed IMAP folders the crawler doesn't use the UID as part of the URI. Instead it uses the value of the Message-ID header combined with a hash of the entire message. This is slow as each incremental crawl requires the crawler do download all messages. Setting this option to true will cause the crawler to use only values of selected headers in hash computation. This increases the incremental crawling speed on mh-backed folders at the expense of overlooking certain messages with the same Message-ID and other headers values, but different content. The default is true for speed. If you need accuracy, to be 100% sure that no near-duplicate message pairs are omitted - set it to false.

Parameters:

useHeadersHash - On mh-backed IMAP folders the crawler doesn't use the UID as part of the URI. Instead it uses the value of the Message-ID header combined with a hash of the entire message. This is slow as each incremental crawl requires the crawler do download all messages. Setting this option to true will cause the crawler to use only values of selected headers in hash computation. This increases the incremental crawling speed on mh-backed folders at the expense of overlooking certain messages with the same Message-ID and other headers values, but different content. The default is true for speed. If you need accuracy, to be 100% sure that no near-duplicate message pairs are omitted - set it to false., can be null in which case any previous setting will be removed

Throws:

NullPointerException - if no configuration has been set, use DataSourceBase.setConfiguration(RDFContainer) before calling this method