org.openestate.is24.restapi.utils

Class ExportHandler

java.lang.Object

org.openestate.is24.restapi.utils.ExportHandler

public class ExportHandler
extends Object

Handler for bulk exports.

The ExportHandler is part of the high level API for bulk exports of real estate data.

A previously created ExportPool can be processed with the export(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.utils.ExportPool, boolean, boolean) method. The ExportHandler will launch the required low level operations of the ImportExport-API for each pooled object.

Since:

0.2

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
ExportHandler() Creates a new ExportHandler.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addProgress(long value) Calback method to track progress during the export process.
protected boolean	canIgnoreContact(RealtorContactDetails contact, String poolContactId) Callback method to check, if a contact should be updated in the export process.
protected boolean	canIgnoreObject(RealEstate object, String poolObjectId) Callback method to check, if a real estate should be updated in the export process.
protected void	doArchiveObject(long is24ObjectId, String externalObjectId) Archivates a real estate object at the Webservice.
protected void	doArchiveObject(RealEstate is24Object) Archivates a real estate object at the Webservice.
protected void	doArchiveObject(String externalObjectId) Archivates a real estate object at the Webservice.
protected File	doDownloadFile(URL url) Downloads an URL into a File.
protected Map<Long,String>	doListUntouchedObjects() Returns internal and external ID's of real estates from the Webservice, that were not changed during the current export process.
protected PublishChannels	doLoadPublishChannels() Returns publish channels for the authorized agency.
protected void	doRemoveObject(long is24ObjectId, String externalObjectId) Removes a real estate object from the Webservice.
protected void	doRemoveObject(String externalObjectId) Removes a real estate object from the Webservice.
protected Long	doUpdateContact(RealtorContactDetails contact, String poolContactId) Saves a contact person to the Webservice.
protected Long	doUpdateObject(RealEstate object, PublishChannels is24PublishChannels, String poolObjectId) Saves a real estate to the Webservice.
ExportMessage[]	export(AbstractClient client, ExportPool pool, boolean archivateUnpublishedObjects, boolean unpublishUntouchedObjects) Starts the export of an ExportPool.
protected AbstractClient	getClient() Returns the client of the current export process.
ExportMessage[]	getMessages() Returns messages, that occured during the last export process.
ExportMessage[]	getMessagesForContact(String externalContactId) Returns messages for a certain contact person, that occured during the last export process.
ExportMessage[]	getMessagesForObject(String externalObjectId) Returns messages for a certain real estate, that occured during the last export process.
ExportMessage[]	getMessagesGeneral() Returns general messages, that occured during the last export process.
protected ExportPool	getPool() Returns the pool of the current export process.
protected long	getProgress() Returns the progress of the current export process.
protected long	getTotalProgress() Returns the total progress of the current export process.
boolean	isUseNewEnergySourceEnev2014Values() Checks, if all values for "energySourceEnev2014" are enabled.
protected void	progressUpdated(long progress, long totalProgress) Calback method, that is called after the progress has changed.
protected void	putContactMessage(String externalContactId, ExportMessage.Code code, RequestFailedException ex) Registers error messages for a contact person.
protected void	putContactMessage(String externalContactId, ExportMessage.Code code, String msg) Registers a message for a contact person.
protected void	putContactMessage(String externalContactId, ExportMessage.Code code, String msg, String errorRequestRefNumber) Registers a message for a contact person.
protected void	putGeneralMessage(ExportMessage.Code code, RequestFailedException ex) Registers general error messages.
protected void	putGeneralMessage(ExportMessage.Code code, String msg) Registers a general message.
protected void	putGeneralMessage(ExportMessage.Code code, String msg, String errorRequestRefNumber) Registers a general message.
protected void	putObjectMessage(String externalObjectId, ExportMessage.Code code, RequestFailedException ex) Registers error messages for a real estate.
protected void	putObjectMessage(String externalObjectId, ExportMessage.Code code, String msg) Registers a message for a real estate.
protected void	putObjectMessage(String externalObjectId, ExportMessage.Code code, String msg, String errorRequestRefNumber) Registers a message for a real estate.
protected void	setProgress(long progress) Sets the progress of the current export process.
void	setUseNewEnergySourceEnev2014Values(boolean useNewEnergySourceEnev2014Values) Enables / disables all values for "energySourceEnev2014".

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportHandler

public ExportHandler()

Creates a new ExportHandler.

Method Detail

addProgress

protected final void addProgress(long value)

Calback method to track progress during the export process.

This method may be overridden by inheriting classes in order to track the progress of the export process.

Parameters:

value - value of additional progress

canIgnoreContact

protected boolean canIgnoreContact(RealtorContactDetails contact,
                       String poolContactId)

Callback method to check, if a contact should be updated in the export process.

Parameters:

contact - contact person to update

poolContactId - id of the contact person within export pool

Returns:

true, if the contact person can be ignored in the export process

canIgnoreObject

protected boolean canIgnoreObject(RealEstate object,
                      String poolObjectId)

Callback method to check, if a real estate should be updated in the export process.

Parameters:

object - real estate to update

poolObjectId - id of the real estate within export pool

Returns:

true, if the real estate can be ignored in the export process

doArchiveObject

protected final void doArchiveObject(String externalObjectId)
                              throws IOException

Archivates a real estate object at the Webservice.

Parameters:

externalObjectId - external real estate ID

Throws:

IOException - if the operation failed

doArchiveObject

protected final void doArchiveObject(long is24ObjectId,
                   String externalObjectId)
                              throws IOException

Archivates a real estate object at the Webservice.

Parameters:

is24ObjectId - real estate ID by IS24

externalObjectId - external real estate ID

Throws:

IOException - if the operation failed

doArchiveObject

protected void doArchiveObject(RealEstate is24Object)
                        throws IOException

Archivates a real estate object at the Webservice.

Parameters:

is24Object - real estate to archivate

Throws:

IOException - if the operation failed

doDownloadFile

protected File doDownloadFile(URL url)
                       throws IOException

Downloads an URL into a File.

Parameters:

url - URL to download

Returns:

downloaded file

Throws:

IOException - if the operation failed

doListUntouchedObjects

protected Map<Long,String> doListUntouchedObjects()
                                           throws IOException

Returns internal and external ID's of real estates from the Webservice, that were not changed during the current export process.

Returns:

mapping of internal and external ID's of untouched real estates

Throws:

IOException - if the operation failed

doLoadPublishChannels

protected PublishChannels doLoadPublishChannels()
                                         throws IOException

Returns publish channels for the authorized agency.

Returns:

publish channels

Throws:

IOException - if the operation failed

doRemoveObject

protected void doRemoveObject(String externalObjectId)
                       throws IOException

Removes a real estate object from the Webservice.

Parameters:

externalObjectId - external real estate ID

Throws:

IOException - if the operation failed

doRemoveObject

protected void doRemoveObject(long is24ObjectId,
                  String externalObjectId)
                       throws IOException

Removes a real estate object from the Webservice.

Parameters:

is24ObjectId - real estate ID by IS24

externalObjectId - external real estate ID

Throws:

IOException - if the operation failed

doUpdateContact

protected Long doUpdateContact(RealtorContactDetails contact,
                   String poolContactId)
                        throws IOException

Saves a contact person to the Webservice.

Parameters:

contact - contact to save

poolContactId - contact ID within export pool

Returns:

ID of the processed contact person in the Webservice or null, if the object was not updated

Throws:

IOException - if the operation failed

doUpdateObject

protected Long doUpdateObject(RealEstate object,
                  PublishChannels is24PublishChannels,
                  String poolObjectId)
                       throws IOException

Saves a real estate to the Webservice.

Parameters:

object - real estate to save

is24PublishChannels - channels, where the real estate should be published

poolObjectId - real estate ID within export pool

Returns:

ID of the processed real estate in the Webservice or null, if the object was not updated

Throws:

IOException - if the operation failed

export

public ExportMessage[] export(AbstractClient client,
                     ExportPool pool,
                     boolean archivateUnpublishedObjects,
                     boolean unpublishUntouchedObjects)
                       throws IOException

Starts the export of an ExportPool.

Parameters:

client - client, that is used for transfers

pool - pool with exportable data

archivateUnpublishedObjects - archivate old real estates instead of removal

unpublishUntouchedObjects - archivate or remove untouched real estates (means full transfer instead of incremental)

Returns:

messages, that occured during the export process

Throws:

IOException - if the operation failed

getClient

protected final AbstractClient getClient()

Returns the client of the current export process.

Returns:

client

getMessages

public final ExportMessage[] getMessages()

Returns messages, that occured during the last export process.

Returns:

messages

getMessagesForContact

public final ExportMessage[] getMessagesForContact(String externalContactId)

Returns messages for a certain contact person, that occured during the last export process.

Parameters:

externalContactId - external contact ID

Returns:

messages

getMessagesForObject

public final ExportMessage[] getMessagesForObject(String externalObjectId)

Returns messages for a certain real estate, that occured during the last export process.

Parameters:

externalObjectId - real estate ID

Returns:

messages

getMessagesGeneral

public final ExportMessage[] getMessagesGeneral()

Returns general messages, that occured during the last export process.

Returns:

messages

getPool

protected final ExportPool getPool()

Returns the pool of the current export process.

Returns:

pool

getProgress

protected final long getProgress()

Returns the progress of the current export process.

Returns:

current progress value

getTotalProgress

protected final long getTotalProgress()

Returns the total progress of the current export process.

Returns:

total progress value

isUseNewEnergySourceEnev2014Values

public boolean isUseNewEnergySourceEnev2014Values()

Checks, if all values for "energySourceEnev2014" are enabled.

Returns:

true, if all values for "energySourceEnev2014" are enabled

See Also:

notes about Energy Certificate 2014

progressUpdated

protected void progressUpdated(long progress,
                   long totalProgress)

Calback method, that is called after the progress has changed.

This method may be overridden by inheriting classes in order to track the progress of the export process.

Parameters:

progress - current progress value

totalProgress - total progress value

putContactMessage

protected final void putContactMessage(String externalContactId,
                     ExportMessage.Code code,
                     String msg)

Registers a message for a contact person.

Parameters:

externalContactId - external contact ID

code - message code

msg - message text

putContactMessage

protected void putContactMessage(String externalContactId,
                     ExportMessage.Code code,
                     String msg,
                     String errorRequestRefNumber)

Registers a message for a contact person.

Parameters:

externalContactId - external contact ID

code - message code

msg - message text

errorRequestRefNumber - unique identifier of the failed HTTP request

putContactMessage

protected final void putContactMessage(String externalContactId,
                     ExportMessage.Code code,
                     RequestFailedException ex)

Registers error messages for a contact person.

Parameters:

externalContactId - external contact ID

code - message code

ex - exception of the failed request

putGeneralMessage

protected final void putGeneralMessage(ExportMessage.Code code,
                     String msg)

Registers a general message.

Parameters:

code - message code

msg - message text

putGeneralMessage

protected void putGeneralMessage(ExportMessage.Code code,
                     String msg,
                     String errorRequestRefNumber)

Registers a general message.

Parameters:

code - message code

msg - message text

errorRequestRefNumber - unique identifier of the failed HTTP request

putGeneralMessage

protected final void putGeneralMessage(ExportMessage.Code code,
                     RequestFailedException ex)

Registers general error messages.

Parameters:

code - message code

ex - exception of the failed request

putObjectMessage

protected final void putObjectMessage(String externalObjectId,
                    ExportMessage.Code code,
                    String msg)

Registers a message for a real estate.

Parameters:

externalObjectId - external real estate ID

code - message code

msg - message text

putObjectMessage

protected void putObjectMessage(String externalObjectId,
                    ExportMessage.Code code,
                    String msg,
                    String errorRequestRefNumber)

Registers a message for a real estate.

Parameters:

externalObjectId - external real estate ID

code - message code

msg - message text

errorRequestRefNumber - unique identifier of the failed HTTP request

putObjectMessage

protected final void putObjectMessage(String externalObjectId,
                    ExportMessage.Code code,
                    RequestFailedException ex)

Registers error messages for a real estate.

Parameters:

externalObjectId - external real estate ID

code - message code

ex - exception of the failed request

setProgress

protected final void setProgress(long progress)

Sets the progress of the current export process.

Parameters:

progress - current progress value

setUseNewEnergySourceEnev2014Values

public void setUseNewEnergySourceEnev2014Values(boolean useNewEnergySourceEnev2014Values)

Enables / disables all values for "energySourceEnev2014".

Parameters:

useNewEnergySourceEnev2014Values - enabled / disabled

See Also:

notes about Energy Certificate 2014