Package de.aristaflow.ilm.ws.rest.model.common.collection

Class RemoteIteratorRest<WI,NI extends RemoteIteratorData<WI>>

java.lang.Object

de.aristaflow.ilm.ws.rest.base.service.AbstractSubResource<AddDataTransformatorRemoteIteratorWebService<?,WI,?,?,NI>>

de.aristaflow.ilm.ws.rest.model.common.collection.RemoteIteratorRest<WI,NI>

Direct Known Subclasses:

ArchInstIdRemoteIteratorRest, ArchTemplIdRemoteIteratorRest, AsRemoteIteratorRest, DelRecRemoteIteratorRest, EcRemoteIteratorRest, EntityRemoteIteratorRest, ErrorDataRemoteIteratorRest, ExecHistEntryRemoteIteratorRest, IdUdtRemoteIteratorRest, InstanceRemoteIteratorRest, InstIdRemoteIteratorRest, InstRefRemoteIteratorRest, InstStatusRemoteIteratorRest, NamespaceRemoteIteratorRest, NsRemoteIteratorRest, PossAbsRemoteIteratorRest, QaRemoteIteratorRest, RaRemoteIteratorRest, ResExprEvalRemoteIteratorRest, ResInstRemoteIteratorRest, ResRemoteIteratorRest, ScRemoteIteratorRest, TemplateRemoteIteratorRest, TemplIdRemoteIteratorRest, TemplKindRemoteIteratorRest, TemplRefRemoteIteratorRest, TemplStatusRemoteIteratorRest, WorkHistEntryRemoteIteratorRest

public abstract class RemoteIteratorRest<WI,NI extends RemoteIteratorData<WI>>
extends AbstractSubResource<AddDataTransformatorRemoteIteratorWebService<?,WI,?,?,NI>>

See Also:

RemoteIteratorWebService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteIteratorRest(AddDataTransformatorRemoteIteratorWebService<?,WI,?,?,NI> service, de.aristaflow.adept2.base.communication.rest.RequestHandler reqHandler, de.aristaflow.adept2.base.communication.rest.ResponseHandler respHandler, de.aristaflow.adept2.base.communication.rest.ExceptionHandler excpHandler, de.aristaflow.adept2.base.communication.rest.ServiceResourceConfig srConf, Supplier<com.fasterxml.jackson.databind.ObjectMapper> objectMapper, UnaryOperator<Exception> headerDataExcpAdapter)

Method Summary

Modifier and Type	Method	Description
void	close(@NotNull UUID iteratorId)	This method is public to allow for inheriting the OperationResponse annotations.
NI	getNext(@NotNull UUID iteratorId, @Positive Integer count, @PositiveOrZero Integer start)	This method is public to allow for inheriting the OperationResponse annotations.
NI	getPrevious(@NotNull UUID iteratorId, @Positive Integer count)	This method is public to allow for inheriting the OperationResponse annotations.
<RID extends InitialRemoteIteratorData<WI>> RID	initIteratorAndRespStatus(RID rid, Long aliveTime)	Initialises the remote iterator of the designated remote iterator data by setting the designated explicit alive time if required and the response status to HttpURLConnection.HTTP_CREATED.
@NotNull Long	keepAlive(@NotNull UUID iteratorId, @NotNull @PositiveOrZero Long aliveTime)	This method is public to allow for inheriting the OperationResponse annotations.

Methods inherited from class de.aristaflow.ilm.ws.rest.base.service.AbstractSubResource

adaptHeaderData, ensureReqMaxVersion, ensureReqMinVersion, getExceptionHandler, getLogger, getObjectMapper, getRequestHandler, getResponseHandler, getServiceResourceConfig, getWebService

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteIteratorRest

protected RemoteIteratorRest(AddDataTransformatorRemoteIteratorWebService<?,WI,?,?,NI> service,
                             de.aristaflow.adept2.base.communication.rest.RequestHandler reqHandler,
                             de.aristaflow.adept2.base.communication.rest.ResponseHandler respHandler,
                             de.aristaflow.adept2.base.communication.rest.ExceptionHandler excpHandler,
                             de.aristaflow.adept2.base.communication.rest.ServiceResourceConfig srConf,
                             Supplier<com.fasterxml.jackson.databind.ObjectMapper> objectMapper,
                             UnaryOperator<Exception> headerDataExcpAdapter)

Method Detail

initIteratorAndRespStatus

public <RID extends InitialRemoteIteratorData<WI>> RID initIteratorAndRespStatus(RID rid,
                                                                                 Long aliveTime)

Initialises the remote iterator of the designated remote iterator data by setting the designated explicit alive time if required and the response status to HttpURLConnection.HTTP_CREATED. Both only applies in case the remote iterator data is not null, that is, there is no data, and the remote iterator has not been AbstractRemoteIteratorData.closed closed implicitly, e. g. after all data has been transfered.

Parameters:

rid - The remote iterator data for which to initially set an explicit alive time. If this is null, no alive time will be set explicitly.

aliveTime - The alive time which to explicitly set for the designated remote iterator data. If this is null, the implicit alive time will be used, that is, no extension will be applied.

Returns:

The designated remote iterator data.

getNext

@Valid
public NI getNext(@NotNull @PathParam("iteratorId")
                  @NotNull UUID iteratorId,
                  @Positive @QueryParam("count")
                  @Positive Integer count,
                  @PositiveOrZero @QueryParam("start")
                  @PositiveOrZero Integer start)

This method is public to allow for inheriting the OperationResponse annotations.

See Also:

AddDataTransformatorRemoteIteratorWebService.getNext(UUID, Integer, Integer)

getPrevious

@Valid
public NI getPrevious(@NotNull @PathParam("iteratorId")
                      @NotNull UUID iteratorId,
                      @Positive @QueryParam("count")
                      @Positive Integer count)

This method is public to allow for inheriting the OperationResponse annotations.

See Also:

AddDataTransformatorRemoteIteratorWebService.getPrevious(UUID, Integer)

keepAlive

@NotNull
public @NotNull Long keepAlive(@NotNull @PathParam("iteratorId")
                               @NotNull UUID iteratorId,
                               @NotNull @PositiveOrZero @QueryParam("aliveTime")
                               @NotNull @PositiveOrZero Long aliveTime)

This method is public to allow for inheriting the OperationResponse annotations.

See Also:

AddDataTransformatorRemoteIteratorWebService.keepAlive(UUID, Long)

close

public void close(@NotNull @PathParam("iteratorId")
                  @NotNull UUID iteratorId)

This method is public to allow for inheriting the OperationResponse annotations.

See Also:

AddDataTransformatorRemoteIteratorWebService.close(UUID)