org.yamcs.web.rest

Class RestHandler

java.lang.Object

org.yamcs.web.RouteHandler

org.yamcs.web.rest.RestHandler

Direct Known Subclasses:

ArchiveAlarmRestHandler, ArchiveCommandRestHandler, ArchiveDownloadRestHandler, ArchiveEventRestHandler, ArchiveIndexRestHandler, ArchivePacketRestHandler, ArchiveParameterReplayRestHandler, ArchiveParameterRestHandler, ArchiveStreamRestHandler, ArchiveTableRestHandler, ArchiveTagRestHandler, CcsdsTmIndex.CcsdsTmIndexRestHandler, ClientRestHandler, DisplayRestHandler, InstanceRestHandler, LinkRestHandler, MDBAlgorithmRestHandler, MDBCommandRestHandler, MDBContainerRestHandler, MDBParameterRestHandler, MDBRestHandler, MDBSpaceSystemRestHandler, OldArchiveParameterRestHandler, ParameterArchiveMaintenanceRestHandler, ParameterArchiveMaintenanceRestHandler, ProcessorCommandQueueRestHandler, ProcessorCommandRestHandler, ProcessorParameterRestHandler, ProcessorRestHandler, RocksDbMaintenanceRestHandler, ServiceRestHandler, SimulationTimeService.SimTimeRestHandler, UserRestHandler

public abstract class RestHandler
extends RouteHandler

Contains utility methods for REST handlers. May eventually refactor this out.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RestHandler.NameDescriptionWithId<T extends NameDescription>

Field Summary

Fields inherited from class org.yamcs.web.RouteHandler

HTTP_DATE_FORMAT, HTTP_DATE_GMT_TIMEZONE

Constructor Summary

Constructors

Constructor and Description
RestHandler()

Method Summary

Modifier and Type	Method and Description
protected static void	abortRequest(RestRequest req)
protected static boolean	authorised(RestRequest req, Privilege.Type type, String privilege)
protected static void	checkSystemPrivilege(RestRequest req, Privilege.SystemPrivilege priv)
static void	completeChunkedTransfer(RestRequest req)
protected static void	completeOK(RestRequest restRequest)
protected static void	completeOK(RestRequest restRequest, MediaType contentType, io.netty.buffer.ByteBuf body)
protected static <T extends com.google.protobuf.Message> void	completeOK(RestRequest restRequest, T responseMsg)
protected static void	completeWithError(RestRequest req, HttpException e) write the error to the client and complete the request exceptionally
static <T extends com.google.protobuf.Message> io.netty.channel.ChannelFuture	sendMessageResponse(RestRequest restRequest, io.netty.handler.codec.http.HttpResponseStatus status, T responseMsg)
protected static io.netty.channel.ChannelFuture	sendRestError(RestRequest req, io.netty.handler.codec.http.HttpResponseStatus status, Throwable t)
protected static AlarmServer	verifyAlarmServer(Processor processor)
protected static Algorithm	verifyAlgorithm(RestRequest req, XtceDb mdb, String pathName)
protected void	verifyAuthorization(AuthenticationToken authToken, Privilege.SystemPrivilege p)
protected static void	verifyAuthorization(AuthenticationToken authToken, Privilege.Type type, Collection<String> names)
protected static void	verifyAuthorization(AuthenticationToken authToken, Privilege.Type type, String... names)
protected static YamcsManagement.ClientInfo	verifyClient(RestRequest req, int clientId)
protected static MetaCommand	verifyCommand(RestRequest req, XtceDb mdb, String pathName)
protected static SequenceContainer	verifyContainer(RestRequest req, XtceDb mdb, String pathName)
protected static String	verifyInstance(RestRequest req, String instance)
protected static YamcsManagement.LinkInfo	verifyLink(RestRequest req, String instance, String linkName)
protected static String	verifyNamespace(RestRequest req, XtceDb mdb, String pathName)
protected static Parameter	verifyParameter(RestRequest req, XtceDb mdb, String pathName)
protected static Yamcs.NamedObjectId	verifyParameterId(RestRequest req, XtceDb mdb, String pathName)
protected static RestHandler.NameDescriptionWithId<Parameter>	verifyParameterWithId(RestRequest req, XtceDb mdb, String pathName)
protected static Processor	verifyProcessor(RestRequest req, String instance, String processorName)
protected static SpaceSystem	verifySpaceSystem(RestRequest req, XtceDb mdb, String pathName)
protected static Stream	verifyStream(RestRequest req, YarchDatabaseInstance ydb, String streamName)
protected static TableDefinition	verifyTable(RestRequest req, YarchDatabaseInstance ydb, String tableName)

Methods inherited from class org.yamcs.web.RouteHandler

setDateAndCacheHeaders, setDateHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

RestHandler

public RestHandler()

Method Detail

completeOK

protected static void completeOK(RestRequest restRequest)

completeOK

protected static <T extends com.google.protobuf.Message> void completeOK(RestRequest restRequest,
                                                                         T responseMsg)

completeOK

protected static void completeOK(RestRequest restRequest,
                                 MediaType contentType,
                                 io.netty.buffer.ByteBuf body)

sendMessageResponse

public static <T extends com.google.protobuf.Message> io.netty.channel.ChannelFuture sendMessageResponse(RestRequest restRequest,
                                                                                                         io.netty.handler.codec.http.HttpResponseStatus status,
                                                                                                         T responseMsg)

sendRestError

protected static io.netty.channel.ChannelFuture sendRestError(RestRequest req,
                                                              io.netty.handler.codec.http.HttpResponseStatus status,
                                                              Throwable t)

completeWithError

protected static void completeWithError(RestRequest req,
                                        HttpException e)

write the error to the client and complete the request exceptionally

Parameters:

req -

e -

abortRequest

protected static void abortRequest(RestRequest req)

verifyInstance

protected static String verifyInstance(RestRequest req,
                                       String instance)
                                throws NotFoundException

Throws:

NotFoundException

verifyLink

protected static YamcsManagement.LinkInfo verifyLink(RestRequest req,
                                                     String instance,
                                                     String linkName)
                                              throws NotFoundException

Throws:

NotFoundException

verifyClient

protected static YamcsManagement.ClientInfo verifyClient(RestRequest req,
                                                         int clientId)
                                                  throws NotFoundException

Throws:

NotFoundException

verifyProcessor

protected static Processor verifyProcessor(RestRequest req,
                                           String instance,
                                           String processorName)
                                    throws NotFoundException

Throws:

NotFoundException

verifyNamespace

protected static String verifyNamespace(RestRequest req,
                                        XtceDb mdb,
                                        String pathName)
                                 throws NotFoundException

Throws:

NotFoundException

verifySpaceSystem

protected static SpaceSystem verifySpaceSystem(RestRequest req,
                                               XtceDb mdb,
                                               String pathName)
                                        throws NotFoundException

Throws:

NotFoundException

verifyParameterId

protected static Yamcs.NamedObjectId verifyParameterId(RestRequest req,
                                                       XtceDb mdb,
                                                       String pathName)
                                                throws NotFoundException

Throws:

NotFoundException

verifyParameter

protected static Parameter verifyParameter(RestRequest req,
                                           XtceDb mdb,
                                           String pathName)
                                    throws NotFoundException

Throws:

NotFoundException

verifyParameterWithId

protected static RestHandler.NameDescriptionWithId<Parameter> verifyParameterWithId(RestRequest req,
                                                                                    XtceDb mdb,
                                                                                    String pathName)
                                                                             throws NotFoundException

Throws:

NotFoundException

verifyStream

protected static Stream verifyStream(RestRequest req,
                                     YarchDatabaseInstance ydb,
                                     String streamName)
                              throws NotFoundException

Throws:

NotFoundException

verifyTable

protected static TableDefinition verifyTable(RestRequest req,
                                             YarchDatabaseInstance ydb,
                                             String tableName)
                                      throws NotFoundException

Throws:

NotFoundException

verifyCommand

protected static MetaCommand verifyCommand(RestRequest req,
                                           XtceDb mdb,
                                           String pathName)
                                    throws NotFoundException

Throws:

NotFoundException

verifyAlgorithm

protected static Algorithm verifyAlgorithm(RestRequest req,
                                           XtceDb mdb,
                                           String pathName)
                                    throws NotFoundException

Throws:

NotFoundException

verifyContainer

protected static SequenceContainer verifyContainer(RestRequest req,
                                                   XtceDb mdb,
                                                   String pathName)
                                            throws NotFoundException

Throws:

NotFoundException

verifyAlarmServer

protected static AlarmServer verifyAlarmServer(Processor processor)
                                        throws BadRequestException

Throws:

BadRequestException

authorised

protected static boolean authorised(RestRequest req,
                                    Privilege.Type type,
                                    String privilege)

completeChunkedTransfer

public static void completeChunkedTransfer(RestRequest req)

checkSystemPrivilege

protected static void checkSystemPrivilege(RestRequest req,
                                           Privilege.SystemPrivilege priv)
                                    throws HttpException

Throws:

HttpException

verifyAuthorization

protected void verifyAuthorization(AuthenticationToken authToken,
                                   Privilege.SystemPrivilege p)
                            throws ForbiddenException

Throws:

ForbiddenException

verifyAuthorization

protected static void verifyAuthorization(AuthenticationToken authToken,
                                          Privilege.Type type,
                                          Collection<String> names)
                                   throws ForbiddenException

Throws:

ForbiddenException

verifyAuthorization

protected static void verifyAuthorization(AuthenticationToken authToken,
                                          Privilege.Type type,
                                          String... names)
                                   throws ForbiddenException

Throws:

ForbiddenException