co.ecg.alpaca.toolkit.helper.migration

Class AbstractImport<O extends BroadWorksObject,T extends BroadWorksObjectInformation<O>,R extends Request<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 BroadWorksObject,T extends BroadWorksObjectInformation<O>,R extends Request<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(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()
BroadWorksServer	getBroadWorksServer()
T	getInformation()
O	getOutput()
protected <R extends Response,Q extends Request<R>> void	mapRequestAndFire(Q request, 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 Response> void	mapRequestAndFire(Request<R> request, Response response) Convenience method to map a request to a response and add it to the request bundler
protected <R extends Response> void	mapRequestAndFire(Request<R> request, 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(ServiceModifyEvent event) Method to handle the subscription to the EventBus for ServiceModifyEvent.
void	setAddRequest(R request)
void	setOutput(O output)
void	unregister() Removes this object from the EventBus

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

addStep, addStep, all, allBut, getStepCount, isConcurrent, only, removeStep, setConcurrent, step, 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 Request<DefaultResponse> addRequest

Constructor Detail

AbstractImport

public AbstractImport(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.

unregister

public void unregister()

Removes this object from the EventBus

getBroadWorksServer

public BroadWorksServer getBroadWorksServer()

getOutput

public O getOutput()

setOutput

public void setOutput(O output)

getInformation

public T getInformation()

getAddRequest

public abstract R getAddRequest()
                         throws RequestException

Throws:

RequestException

setAddRequest

public void setAddRequest(R request)

mapRequestAndFire

protected <R extends Response> void mapRequestAndFire(Request<R> request,
                                                      Response response)
                                               throws 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:

RequestException - Thrown if unable to map or fire the request.

mapRequestAndFire

protected <R extends Response> void mapRequestAndFire(Request<R> request,
                                                      Response response,
                                                      Consumer<R> responseConsumer)
                                               throws 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:

RequestException - Thrown if unable to map or fire the request.

mapRequestAndFire

protected <R extends Response,Q extends Request<R>> void mapRequestAndFire(Q request,
                                                                           Response response,
                                                                           Consumer<R> responseConsumer,
                                                                           Consumer<Q> afterMappingConsumer)
                                                                    throws 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:

RequestException - Thrown if unable to map or fire the request.

serviceModifyEvent

public void serviceModifyEvent(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