Package org.labkey.remoteapi

Class GetCommand<ResponseType extends CommandResponse>

java.lang.Object

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

org.labkey.remoteapi.GetCommand<ResponseType>

All Implemented Interfaces:

HasRequiredVersion

Direct Known Subclasses:

EnsureLoginCommand, GetContainersCommand, GetDomainDetailsCommand, GetGroupPermsCommand, GetProtocolCommand, GetQueriesCommand, GetQueryDetailsCommand, GetSchemasCommand, GetUsersCommand, LineageCommand, SimpleGetCommand, WhoAmICommand

public abstract class GetCommand<ResponseType extends CommandResponse>
extends Command<ResponseType,org.apache.hc.client5.http.classic.methods.HttpGet>

Base class for all commands that use get

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

Modifier	Constructor	Description
protected	GetCommand(String controllerName, String actionName)

Method Summary

Modifier and Type	Method	Description
protected org.apache.hc.client5.http.classic.methods.HttpGet	createRequest(URI uri)	Creates the HttpGet instance used for the request.

Methods inherited from class org.labkey.remoteapi.Command

_execute, createParameterMap, createResponse, 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

GetCommand

protected GetCommand(String controllerName,
 String actionName)

Method Details

createRequest

protected org.apache.hc.client5.http.classic.methods.HttpGet createRequest(URI uri)

Creates the HttpGet instance used for the request. Override to modify the HttpGet object before use.

Specified by:

createRequest in class Command<ResponseType extends CommandResponse,org.apache.hc.client5.http.classic.methods.HttpGet>

Parameters:

uri - the request uri

Returns:

The HttpUriRequest instance.