Package com.broadleafcommerce.metadata.dsl.core

Interface Endpoint<E extends Endpoint<E>>

All Superinterfaces:
Copyable<E>, Serializable
All Known Subinterfaces:
PageableEndpoint<E>
All Known Implementing Classes:
AbstractEndpoint, DefaultEndpoint, DefaultPageableEndpoint
public interface Endpoint<E extends Endpoint<E>> extends Serializable, Copyable<E>
Represents the metadata for an endpoint.
Author:
Nick Crum (ncrum)

  • Method Details

    • getType

      @Nullable String getType()

    • getUri

      @Nullable String getUri()

    • getMethod

      @Nullable Endpoint.Method getMethod()

    • getScope

      @Nullable String getScope()

    • getParams

      Map<String,String> getParams()

    • getHeaders

      Map<String,Object> getHeaders()

    • getMapParams

      List<Mapping<?>> getMapParams()

    • getTransformRequestBody

      @Nullable TransformBody getTransformRequestBody()

    • getTransformResponseBody

      @Nullable TransformBody getTransformResponseBody()

    • getParent

      @Nullable Component<?> getParent()

    • setType

      void setType(String type)

    • setUri

      void setUri(String uri)

    • setMethod

      void setMethod(Endpoint.Method method)

    • setScope

      void setScope(String scope)

    • setParams

      void setParams(Map<String,String> params)

    • setHeaders

      void setHeaders(Map<String,Object> headers)

    • setMapParams

      void setMapParams(List<Mapping<?>> mapParams)

    • setTransformRequestBody

      void setTransformRequestBody(TransformBody transformRequestBody)

    • setTransformResponseBody

      void setTransformResponseBody(TransformBody transformResponseBody)

    • setParent

      void setParent(Component<?> parent)

    • self

      default E self()

    • type

      default E type(String type)

    • uri

      default E uri(String uri)

    • method

      default E method(Endpoint.Method method)

    • method

      default E method(String method)

    • get

      default E get()

    • post

      default E post()

    • put

      default E put()

    • patch

      default E patch()

    • delete

      default E delete()

    • scope

      default E scope(String... scope)

    • scopes

      default E scopes(Collection<String> scopes)

    • param

      default E param(String name, String valueOrTemplate)

    • params

      default E params(Map<String,String> params)

    • removeParam

      default E removeParam(String name)

    • clearParams

      default E clearParams()

    • header

      default E header(String name, Object valueOrTemplate)

    • headers

      default E headers(Map<String,Object> headers)

    • removeHeader

      default E removeHeader(String name)

    • clearHeaders

      default E clearHeaders()

    • mapParam

      default E mapParam(Mapping<?>... mappings)

    • mapParams

      default E mapParams(Collection<Mapping<?>> mappings)

    • removeMapParam

      default E removeMapParam(String id)

    • clearParamMappings

      default E clearParamMappings()

    • transformRequest

      default E transformRequest(TransformBody transformRequestBody)

    • transformRequest

      default E transformRequest(UnaryOperator<TransformBody> fn)

    • transformResponse

      default E transformResponse(TransformBody transformResponseBody)

    • transformResponse

      default E transformResponse(UnaryOperator<TransformBody> fn)