Interface IRestServiceDefinition

All Known Implementing Classes:
RestServiceDefinition

public interface IRestServiceDefinition
This interface defines a rest service.
Since:
9.0
Author:
a.pragt
  • Method Details Link icon

    • getName Link icon

      String getName()
      Returns the name of the service.
      Returns:
      The name of the service, may not be null.
    • getLocation Link icon

      String getLocation()
      Returns the location url of the service.
      Returns:
      The location url of the service, may be null.
    • useDomainSchemas Link icon

      boolean useDomainSchemas()
      Returns a indicator whether to use domain schemas (otherwise schemasets are used).
      Returns:
      Indicator for using domain schemas.
    • getSchemaSet Link icon

      ISchemaSetDefinition getSchemaSet()
      Returns the corresponding schemaset of the service.
      Returns:
      The schemaset definition of the service, may be null in case of a domain schema.
    • getOperationNames Link icon

      String[] getOperationNames()
      Returns all available operation names in the service.
      Returns:
      The operation names of the service, may not be null.
    • getOperation Link icon

      IRestOperationDefinition getOperation(String operationName)
      Returns an operation of the service.
      Parameters:
      operationName - The name of the operation, may not be null.
      Returns:
      The definition of the operation.
      Throws:
      UnknownOperationException - when the operation does not exist for the rest service.
    • getDirection Link icon

      RestServiceDirection getDirection()
      Returns the direction of the service.
      Returns:
      Whether the service is used for outgoing requests, incoming requests or both, may not be null.
    • getApiDocumentation Link icon

      String getApiDocumentation()
      Returns the api documentation for the rest service.
      Returns:
      The api documentation for the rest service.