Package org.waarp.vitam.ingest

Class IngestRequest

java.lang.Object

org.waarp.vitam.common.AbstractVitamRequest

org.waarp.vitam.ingest.IngestRequest

public class IngestRequest
extends AbstractVitamRequest

IngestRequest is the unitary entry for Ingest operations made by Waarp to Vitam

Field Summary

Fields inherited from class org.waarp.vitam.common.AbstractVitamRequest

status

Constructor Summary

Constructors

Constructor	Description
IngestRequest()
IngestRequest(WaarpCommon.TaskOption taskOption, String contextId, String action, boolean checkAtr, IngestRequestFactory factory)	Standard constructor

Method Summary

Modifier and Type	Method	Description
String	getAction()
File	getAtrFile(IngestRequestFactory factory)
String	getContextId()
fr.gouv.vitam.common.model.LocalFile	getLocalFile()
org.waarp.vitam.ingest.IngestRequest.IngestStep	getStep()
boolean	isCheckAtr()
IngestRequest	save(IngestRequestFactory factory)	Save this IngestRequest
IngestRequest	setAction(String action)
IngestRequest	setCheckAtr(boolean checkAtr)
IngestRequest	setContextId(String contextId)
IngestRequest	setFromRequestResponse(fr.gouv.vitam.common.model.RequestResponseOK requestResponse)	Set extra information from first response from operation submission
IngestRequest	setStatus(int status)	Set the status AND the step according to the value of the status (if less than 0, it is a step value, not a final status), but in dry mode (no check, used by Json deserialization)
IngestRequest	setStep(org.waarp.vitam.ingest.IngestRequest.IngestStep step, int status, IngestRequestFactory factory)	Use to set the step and status accordingly.
String	toString()

Methods inherited from class org.waarp.vitam.common.AbstractVitamRequest

getAccessContract, getApplicationSessionId, getCheckMessage, getGlobalExecutionState, getGlobalExecutionStatus, getJsonPath, getLastTryTime, getPath, getPersonalCertificate, getProcessState, getRequestId, getStatus, getStatusCode, getTenantId, getVitamContext, getWaarpId, getWaarpModel, getWaarpPartner, getWaarpRule, setAccessContract, setApplicationSessionId, setGlobalExecutionState, setGlobalExecutionStatus, setJsonPath, setLastTryTime, setPath, setPersonalCertificate, setRequestId, setTenantId, setWaarpId, setWaarpModel, setWaarpPartner, setWaarpRule

Methods inherited from class java.lang.Object

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

Constructor Detail

IngestRequest

public IngestRequest()

IngestRequest

public IngestRequest(WaarpCommon.TaskOption taskOption,
                     String contextId,
                     String action,
                     boolean checkAtr,
                     IngestRequestFactory factory)
              throws fr.gouv.vitam.common.exception.InvalidParseOperationException

Standard constructor

Parameters:

taskOption -

contextId -

action -

checkAtr -

factory -

Throws:

fr.gouv.vitam.common.exception.InvalidParseOperationException

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getContextId

public String getContextId()

setContextId

public IngestRequest setContextId(String contextId)

Parameters:

contextId - a type of ingest among "DEFAULT_WORKFLOW" (Sip ingest), "HOLDING_SCHEME" (tree) "FILING_SCHEME" (plan)

Returns:

this

getAction

public String getAction()

setAction

public IngestRequest setAction(String action)

Parameters:

action - shall be "RESUME" only

Returns:

this

setStep

public IngestRequest setStep(org.waarp.vitam.ingest.IngestRequest.IngestStep step,
                             int status,
                             IngestRequestFactory factory)
                      throws fr.gouv.vitam.common.exception.InvalidParseOperationException

Use to set the step and status accordingly.

Parameters:

step -

status -

factory -

Returns:

this

Throws:

fr.gouv.vitam.common.exception.InvalidParseOperationException

setStatus

public IngestRequest setStatus(int status)

Set the status AND the step according to the value of the status (if less than 0, it is a step value, not a final status), but in dry mode (no check, used by Json deserialization)

Specified by:

setStatus in class AbstractVitamRequest

Parameters:

status -

Returns:

this

save

public IngestRequest save(IngestRequestFactory factory)
                   throws fr.gouv.vitam.common.exception.InvalidParseOperationException

Save this IngestRequest

Parameters:

factory -

Returns:

this

Throws:

fr.gouv.vitam.common.exception.InvalidParseOperationException

getStep

public org.waarp.vitam.ingest.IngestRequest.IngestStep getStep()

isCheckAtr

public boolean isCheckAtr()

setCheckAtr

public IngestRequest setCheckAtr(boolean checkAtr)

setFromRequestResponse

public IngestRequest setFromRequestResponse(fr.gouv.vitam.common.model.RequestResponseOK requestResponse)

Set extra information from first response from operation submission

Parameters:

requestResponse -

Returns:

this

getLocalFile

public fr.gouv.vitam.common.model.LocalFile getLocalFile()

Returns:

the LocalFile according to this

getAtrFile

public File getAtrFile(IngestRequestFactory factory)

Returns:

the ATR File pointer according to this