co.ecg.alpaca.toolkit.helper.migration

Class AbstractImport<O extends co.ecg.alpaca.toolkit.model.BroadWorksObject,T extends BroadWorksObjectInformation<O>,R extends co.ecg.alpaca.toolkit.messaging.request.Request<co.ecg.alpaca.toolkit.messaging.response.DefaultResponse>,S extends Enum<S>,E extends AbstractImport<O,T,R,S,E>>

java.lang.Object

co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

co.ecg.alpaca.toolkit.helper.model.IterableProcess<E,S>

co.ecg.alpaca.toolkit.helper.migration.AbstractImport<O,T,R,S,E>

All Implemented Interfaces:

Executable<O>, Loggable

Direct Known Subclasses:

AbstractDeviceImport, AbstractServiceProviderImport, BroadWorksUserImport, GroupImport

public abstract class AbstractImport<O extends co.ecg.alpaca.toolkit.model.BroadWorksObject,T extends BroadWorksObjectInformation<O>,R extends co.ecg.alpaca.toolkit.messaging.request.Request<co.ecg.alpaca.toolkit.messaging.response.DefaultResponse>,S extends Enum<S>,E extends AbstractImport<O,T,R,S,E>>
extends IterableProcess<E,S>
implements Executable<O>

Abstract BroadWorksObject Import - Performs the creation of a BroadWorksObject given a BroadWorksObjectInformation

Author:

Matthew Keathley on 5/10/16.

Field Summary

Fields

Modifier and Type	Field and Description
R	addRequest

Fields inherited from class co.ecg.alpaca.toolkit.helper.model.IterableProcess

stepList

Fields inherited from class co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

errors, log, warnings

Constructor Summary

Constructors

Constructor and Description
AbstractImport(co.ecg.alpaca.toolkit.model.BroadWorksServer bws, T information, Class<S> buildStepClass) Creates a new Object Import with the provided information

Method Summary

Modifier and Type	Method and Description
void	concurrencyCheck()
abstract R	getAddRequest()
co.ecg.alpaca.toolkit.model.BroadWorksServer	getBroadWorksServer()
T	getInformation()
O	getOutput()
protected <R extends co.ecg.alpaca.toolkit.messaging.response.Response,Q extends co.ecg.alpaca.toolkit.messaging.request.Request<R>> void	mapRequestAndFire(Q request, co.ecg.alpaca.toolkit.messaging.response.Response response, Consumer<R> responseConsumer, Consumer<Q> afterMappingConsumer) Convenience method to map a request to a response and add it to the request bundler
protected <R extends co.ecg.alpaca.toolkit.messaging.response.Response> void	mapRequestAndFire(co.ecg.alpaca.toolkit.messaging.request.Request<R> request, co.ecg.alpaca.toolkit.messaging.response.Response response) Convenience method to map a request to a response and add it to the request bundler
protected <R extends co.ecg.alpaca.toolkit.messaging.response.Response> void	mapRequestAndFire(co.ecg.alpaca.toolkit.messaging.request.Request<R> request, co.ecg.alpaca.toolkit.messaging.response.Response response, Consumer<R> responseConsumer) Convenience method to map a request to a response and add it to the request bundler
E	registerForEvents() Registers the import to receive events
void	serviceModifyEvent(co.ecg.alpaca.toolkit.event.ServiceModifyEvent event) Method to handle the subscription to the EventBus for ServiceModifyEvent.
void	setAddRequest(R request)
void	setOutput(O output)

Methods inherited from class co.ecg.alpaca.toolkit.helper.model.IterableProcess

addStep, addStep, all, allBut, isConcurrent, only, removeStep, setConcurrent, step

Methods inherited from class co.ecg.alpaca.toolkit.helper.model.ErrorableProcess

checkValidity, exception, getErrors, getReport, getWarnings, hasErrors, isError, isError, isError, printReport, setExceptionOnErrors

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.ecg.alpaca.toolkit.helper.model.Executable

execute

Methods inherited from interface co.ecg.alpaca.toolkit.helper.model.Loggable

getSessionLogger, logger

Field Detail

addRequest

public R extends co.ecg.alpaca.toolkit.messaging.request.Request<co.ecg.alpaca.toolkit.messaging.response.DefaultResponse> addRequest

Constructor Detail

AbstractImport

public AbstractImport(co.ecg.alpaca.toolkit.model.BroadWorksServer bws,
                      T information,
                      Class<S> buildStepClass)
               throws HelperException

Creates a new Object Import with the provided information

Parameters:

bws - The BroadWorks server to create the User on

information - The information to base the new object on

buildStepClass - The class of the import build steps

Throws:

HelperException - Thrown if unable to create the Import.

Method Detail

concurrencyCheck

public void concurrencyCheck()

registerForEvents

public E registerForEvents()

Registers the import to receive events

Returns:

Return the import object.

getBroadWorksServer

public co.ecg.alpaca.toolkit.model.BroadWorksServer getBroadWorksServer()

getOutput

public O getOutput()

setOutput

public void setOutput(O output)

getInformation

public T getInformation()

getAddRequest

public abstract R getAddRequest()
                         throws co.ecg.alpaca.toolkit.exception.RequestException

Throws:

co.ecg.alpaca.toolkit.exception.RequestException

setAddRequest

public void setAddRequest(R request)

mapRequestAndFire

protected <R extends co.ecg.alpaca.toolkit.messaging.response.Response> void mapRequestAndFire(co.ecg.alpaca.toolkit.messaging.request.Request<R> request,
                                                                                               co.ecg.alpaca.toolkit.messaging.response.Response response)
                                                                                        throws co.ecg.alpaca.toolkit.exception.RequestException

Convenience method to map a request to a response and add it to the request bundler

Parameters:

request - The output request

response - The input response

Throws:

co.ecg.alpaca.toolkit.exception.RequestException - Thrown if unable to map or fire the request.

mapRequestAndFire

protected <R extends co.ecg.alpaca.toolkit.messaging.response.Response> void mapRequestAndFire(co.ecg.alpaca.toolkit.messaging.request.Request<R> request,
                                                                                               co.ecg.alpaca.toolkit.messaging.response.Response response,
                                                                                               Consumer<R> responseConsumer)
                                                                                        throws co.ecg.alpaca.toolkit.exception.RequestException

Convenience method to map a request to a response and add it to the request bundler

Parameters:

request - The output request

response - The input response

responseConsumer - Action to perform on the response

Throws:

co.ecg.alpaca.toolkit.exception.RequestException - Thrown if unable to map or fire the request.

mapRequestAndFire

protected <R extends co.ecg.alpaca.toolkit.messaging.response.Response,Q extends co.ecg.alpaca.toolkit.messaging.request.Request<R>> void mapRequestAndFire(Q request,
                                                                                                                                                            co.ecg.alpaca.toolkit.messaging.response.Response response,
                                                                                                                                                            Consumer<R> responseConsumer,
                                                                                                                                                            Consumer<Q> afterMappingConsumer)
                                                                                                                                                     throws co.ecg.alpaca.toolkit.exception.RequestException

Convenience method to map a request to a response and add it to the request bundler

Parameters:

request - The output request

response - The input response

responseConsumer - A custom consumer for the response

Throws:

co.ecg.alpaca.toolkit.exception.RequestException - Thrown if unable to map or fire the request.

serviceModifyEvent

public void serviceModifyEvent(co.ecg.alpaca.toolkit.event.ServiceModifyEvent event)

Method to handle the subscription to the EventBus for ServiceModifyEvent. These incoming events allow for the import to be queried to see if there was any errors.

Parameters:

event - The ServiceModifyEvent to be handled