Package org.labkey.remoteapi.pipeline

Class FileNotificationCommand

java.lang.Object

org.labkey.remoteapi.Command<ResponseType,org.apache.hc.client5.http.classic.methods.HttpPost>

org.labkey.remoteapi.PostCommand<FileNotificationResponse>

org.labkey.remoteapi.pipeline.FileNotificationCommand

All Implemented Interfaces:

HasRequiredVersion

public class FileNotificationCommand
extends PostCommand<FileNotificationResponse>

Notifies the server that files may have become available for the pipeline to process. Causes the server to look through all the jobs that are blocked, waiting for files, and release the ones whose files are now available.

Nested Class Summary

Nested classes/interfaces inherited from class org.labkey.remoteapi.Command

Command.CommonParameters, Command.Response

Field Summary

Fields inherited from class org.labkey.remoteapi.Command

CONTENT_TYPE_JSON

Constructor Summary

Constructors

Constructor	Description
FileNotificationCommand()

Method Summary

Modifier and Type	Method	Description
protected FileNotificationResponse	createResponse(String text, int status, String contentType, org.json.JSONObject json)	Creates an instance of the response class, initialized with the response text, the HTTP status code, and parsed JSONObject.

Methods inherited from class org.labkey.remoteapi.PostCommand

createRequest, getJsonObject

Methods inherited from class org.labkey.remoteapi.Command

_execute, createParameterMap, execute, getActionName, getControllerName, getHttpRequest, getParameters, getParamValueAsString, getRequiredVersion, getTimeout, setRequiredVersion, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

FileNotificationCommand

public FileNotificationCommand()

Method Details

createResponse

protected FileNotificationResponse createResponse(String text,
 int status,
 String contentType,
 org.json.JSONObject json)

Description copied from class: Command

Creates an instance of the response class, initialized with the response text, the HTTP status code, and parsed JSONObject.

Override this method to create an instance of a different class that extends CommandResponse

Overrides:

createResponse in class Command<FileNotificationResponse,org.apache.hc.client5.http.classic.methods.HttpPost>

Parameters:

text - The response text from the server.

status - The HTTP status code.

contentType - The Content-Type header value.

json - The parsed JSONObject (or null if no JSON was returned).

Returns:

An instance of the response object.