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)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Endpoint.Method

Method Summary

Modifier and Type	Method and Description
default E	clearHeaders()
default E	clearParamMappings()
default E	clearParams()
default E	delete()
default E	get()
Map<String,Object>	getHeaders()
List<Mapping<?>>	getMapParams()
Endpoint.Method	getMethod()
Map<String,String>	getParams()
String	getScope()
TransformBody	getTransformRequestBody()
TransformBody	getTransformResponseBody()
String	getType()
String	getUri()
default E	header(String name, Object valueOrTemplate)
default E	headers(Map<String,Object> headers)
default E	mapParam(Mapping<?>... mappings)
default E	mapParams(Collection<Mapping<?>> mappings)
default E	method(Endpoint.Method method)
default E	method(String method)
default E	param(String name, String valueOrTemplate)
default E	params(Map<String,String> params)
default E	patch()
default E	post()
default E	put()
default E	removeHeader(String name)
default E	removeMapParam(String id)
default E	removeParam(String name)
default E	scope(String... scope)
default E	scopes(Collection<String> scopes)
default E	self()
void	setHeaders(Map<String,Object> headers)
void	setMapParams(List<Mapping<?>> mapParams)
void	setMethod(Endpoint.Method method)
void	setParams(Map<String,String> params)
void	setScope(String scope)
void	setTransformRequestBody(TransformBody transformRequestBody)
void	setTransformResponseBody(TransformBody transformResponseBody)
void	setType(String type)
void	setUri(String uri)
default E	transformRequest(TransformBody transformRequestBody)
default E	transformRequest(UnaryOperator<TransformBody> fn)
default E	transformResponse(TransformBody transformResponseBody)
default E	transformResponse(UnaryOperator<TransformBody> fn)
default E	type(String type)
default E	uri(String uri)

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Method Detail

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()

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)

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)