Package com.service.basic.controllers.version1

Class BasicRestControllerV1

java.lang.Object
org.pipservices4.http.controllers.RestController
com.service.basic.controllers.version1.BasicRestControllerV1
All Implemented Interfaces:
org.pipservices4.components.config.IConfigurable, org.pipservices4.components.refer.IReferenceable, org.pipservices4.components.refer.IUnreferenceable, org.pipservices4.components.run.IClosable, org.pipservices4.components.run.IOpenable, org.pipservices4.http.controllers.IRegisterable
public class BasicRestControllerV1 extends org.pipservices4.http.controllers.RestController
Controller that receives remove calls via HTTP protocol to operations automatically generated for commands defined in ICommandable components. Each command is exposed as POST operation that receives all parameters in body object.

  • Field Summary

    Fields inherited from class org.pipservices4.http.controllers.RestController

    _baseRoute, _config, _counters, _dependencyResolver, _endpoint, _logger, _swaggerController, _swaggerEnable, _swaggerRoute, _tracer, _url

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasicRestControllerV1()
    Creates an instance of this service.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(org.pipservices4.components.config.ConfigParams config)
     
    void
    register()
    Registers all service routes in Lambda Function.
    void
    setReferences(org.pipservices4.components.refer.IReferences references)
    Sets references to dependent components.

    Methods inherited from class org.pipservices4.http.controllers.RestController

    close, getBodyAsJson, getBodyAsString, getQueryParameter, getTraceId, instrument, isOpen, open, registerInterceptor, registerOpenApiSpec, registerOpenApiSpecFromFile, registerRoute, registerRoute, registerRouteWithAuth, sendCreatedResult, sendDeletedResult, sendEmptyResult, sendError, sendResult, unsetReferences

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • BasicRestControllerV1

      public BasicRestControllerV1()
      Creates an instance of this service.

  • Method Details

    • configure

      public void configure(org.pipservices4.components.config.ConfigParams config) throws org.pipservices4.commons.errors.ConfigException
      Specified by:
      configure in interface org.pipservices4.components.config.IConfigurable
      Overrides:
      configure in class org.pipservices4.http.controllers.RestController
      Throws:
      org.pipservices4.commons.errors.ConfigException

    • setReferences

      public void setReferences(org.pipservices4.components.refer.IReferences references) throws org.pipservices4.components.refer.ReferenceException, org.pipservices4.commons.errors.ConfigException
      Sets references to dependent components.
      Specified by:
      setReferences in interface org.pipservices4.components.refer.IReferenceable
      Overrides:
      setReferences in class org.pipservices4.http.controllers.RestController
      Parameters:
      references - references to locate the component dependencies.
      Throws:
      org.pipservices4.components.refer.ReferenceException
      org.pipservices4.commons.errors.ConfigException

    • register

      public void register()
      Registers all service routes in Lambda Function.
      Specified by:
      register in interface org.pipservices4.http.controllers.IRegisterable
      Specified by:
      register in class org.pipservices4.http.controllers.RestController