Class ProcedureDescription

java.lang.Object
com.rabbitmq.tools.jsonrpc.ProcedureDescription
public class ProcedureDescription extends Object
Description of a single JSON-RPC procedure.

  • Field Details

    • name

      private String name
      Procedure name

    • summary

      private String summary
      Human-readable procedure summary

    • help

      private String help
      Human-readable instructions for how to get information on the procedure's operation

    • idempotent

      private boolean idempotent
      True if this procedure is idempotent, that is, can be accessed via HTTP GET

    • params

      private ParameterDescription[] params
      Descriptions of parameters for this procedure

    • returnType

      private String returnType
      Return type for this procedure

    • javaReturnType

      private String javaReturnType

    • _javaReturnTypeAsClass

      private Class<?> _javaReturnTypeAsClass

    • method

      private Method method
      Reflected method object, used for service invocation

  • Constructor Details

    • ProcedureDescription

      public ProcedureDescription(Map<String,Object> pm)

    • ProcedureDescription

      public ProcedureDescription(Method m)

    • ProcedureDescription

      public ProcedureDescription()

  • Method Details

    • getReturn

      public String getReturn()
      Getter for return type

    • setReturn

      public void setReturn(String value)
      Private API - used via reflection during parsing/loading

    • internal_getMethod

      public Method internal_getMethod()
      Private API - used to get the reflected method object, for servers

    • getJavaReturnType

      public String getJavaReturnType()

    • setJavaReturnType

      public void setJavaReturnType(String javaReturnType)

    • getReturnType

      public Class<?> getReturnType()

    • computeReturnTypeAsJavaClass

      private Class<?> computeReturnTypeAsJavaClass()

    • internal_getParams

      public ParameterDescription[] internal_getParams()
      Gets an array of parameter descriptions for all this procedure's parameters

    • arity

      public int arity()
      Retrieves the parameter count for this procedure

    • getParams

      public ParameterDescription[] getParams()

    • getName

      public String getName()

    • getSummary

      public String getSummary()

    • getHelp

      public String getHelp()

    • isIdempotent

      public boolean isIdempotent()

    • setName

      public void setName(String name)

    • setSummary

      public void setSummary(String summary)

    • setHelp

      public void setHelp(String help)

    • setIdempotent

      public void setIdempotent(boolean idempotent)