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

Class ServerStreamStringIteratorRest

java.lang.Object

de.aristaflow.ilm.ws.rest.base.service.AbstractSubResource<ServerStreamStringWebService>

de.aristaflow.ilm.ws.rest.model.common.ServerStreamStringIteratorRest

@Produces("application/json")
@Consumes("application/json")
public class ServerStreamStringIteratorRest
extends AbstractSubResource<ServerStreamStringWebService>

See Also:

ServerStreamStringWebService

Constructor Summary

Constructors

Constructor

Description

ServerStreamStringIteratorRest(ServerStreamStringWebService 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)
@Valid StringRemoteIteratorData	getNext(@NotNull UUID iteratorId, @Positive Integer count)
InitialStringRemoteIteratorData	initIteratorAndRespStatus(InitialStringRemoteIteratorData isrid, Long aliveTime)	Initialises the string remote iterator of the designated string remote iterator data by setting the designated explicit alive time if required and the response status to HttpURLConnection.HTTP_CREATED.
Long	keepAlive(UUID iteratorId, Long aliveTime)

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

ServerStreamStringIteratorRest

public ServerStreamStringIteratorRest(ServerStreamStringWebService 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 InitialStringRemoteIteratorData initIteratorAndRespStatus(InitialStringRemoteIteratorData isrid,
                                                                 Long aliveTime)

Initialises the string remote iterator of the designated string 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 string 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:

isrid - The string 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 string remote iterator data. If this is null, the implicit alive time will be used, that is, no extension will be applied.

Returns:

The designated string remote iterator data.

getNext

@GET
@Path("/{iteratorId}/next")
@Valid
public @Valid StringRemoteIteratorData getNext(@NotNull @PathParam("iteratorId")
                                               @NotNull UUID iteratorId,
                                               @Positive @QueryParam("count")
                                               @Positive Integer count)

See Also:

ServerStreamStringWebService.getNext(UUID, Integer)

keepAlive

@GET
@Path("/{iteratorId}/remaining-alive-time")
public Long keepAlive(@PathParam("iteratorId")
                      UUID iteratorId,
                      @QueryParam("aliveTime")
                      Long aliveTime)

See Also:

ServerStreamStringWebService.keepAlive(UUID, Long)

close

@DELETE
@Path("/{iteratorId}")
public void close(@NotNull @PathParam("iteratorId")
                  @NotNull UUID iteratorId)

See Also:

ServerStreamStringWebService.close(UUID)