Package com.yahoo.restapi

Interface RestApi.Builder

Enclosing interface:

RestApi

public static interface RestApi.Builder

Method Summary

Modifier and Type	Method	Description
<EXCEPTION extends RuntimeException> RestApi.Builder	addExceptionMapper(Class<EXCEPTION> type, RestApi.ExceptionMapper<EXCEPTION> mapper)	see RestApiMappers.DEFAULT_EXCEPTION_MAPPERS for default mappers
RestApi.Builder	addFilter(RestApi.Filter filter)
<REQUEST_ENTITY> RestApi.Builder	addRequestMapper(Class<REQUEST_ENTITY> type, RestApi.RequestMapper<REQUEST_ENTITY> mapper)	see RestApiMappers.DEFAULT_REQUEST_MAPPERS for default mappers
<RESPONSE_ENTITY> RestApi.Builder	addResponseMapper(Class<RESPONSE_ENTITY> type, RestApi.ResponseMapper<RESPONSE_ENTITY> mapper)	see RestApiMappers.DEFAULT_RESPONSE_MAPPERS for default mappers
RestApi.Builder	addRoute(RestApi.RouteBuilder route)
RestApi	build()
RestApi.Builder	disableDefaultAclMapping()
RestApi.Builder	disableDefaultExceptionMappers()	Disables mappers listed in RestApiMappers.DEFAULT_EXCEPTION_MAPPERS
RestApi.Builder	disableDefaultResponseMappers()	Disables mappers listed in RestApiMappers.DEFAULT_RESPONSE_MAPPERS
<REQUEST_ENTITY> RestApi.Builder	registerJacksonRequestEntity(Class<REQUEST_ENTITY> type)
<RESPONSE_ENTITY> RestApi.Builder	registerJacksonResponseEntity(Class<RESPONSE_ENTITY> type)
RestApi.Builder	requiredCapabilities(com.yahoo.security.tls.Capability... capabilities)
RestApi.Builder	requiredCapabilities(com.yahoo.security.tls.CapabilitySet capabilities)
RestApi.Builder	setDefaultRoute(RestApi.RouteBuilder route)
RestApi.Builder	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Details

setObjectMapper

RestApi.Builder setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

setDefaultRoute

RestApi.Builder setDefaultRoute(RestApi.RouteBuilder route)

addRoute

RestApi.Builder addRoute(RestApi.RouteBuilder route)

addFilter

RestApi.Builder addFilter(RestApi.Filter filter)

addExceptionMapper

<EXCEPTION extends RuntimeException>
RestApi.Builder addExceptionMapper(Class<EXCEPTION> type,
 RestApi.ExceptionMapper<EXCEPTION> mapper)

see RestApiMappers.DEFAULT_EXCEPTION_MAPPERS for default mappers

addResponseMapper

<RESPONSE_ENTITY> RestApi.Builder addResponseMapper(Class<RESPONSE_ENTITY> type,
 RestApi.ResponseMapper<RESPONSE_ENTITY> mapper)

see RestApiMappers.DEFAULT_RESPONSE_MAPPERS for default mappers

addRequestMapper

<REQUEST_ENTITY> RestApi.Builder addRequestMapper(Class<REQUEST_ENTITY> type,
 RestApi.RequestMapper<REQUEST_ENTITY> mapper)

see RestApiMappers.DEFAULT_REQUEST_MAPPERS for default mappers

registerJacksonResponseEntity

<RESPONSE_ENTITY> RestApi.Builder registerJacksonResponseEntity(Class<RESPONSE_ENTITY> type)

registerJacksonRequestEntity

<REQUEST_ENTITY> RestApi.Builder registerJacksonRequestEntity(Class<REQUEST_ENTITY> type)

disableDefaultExceptionMappers

RestApi.Builder disableDefaultExceptionMappers()

Disables mappers listed in RestApiMappers.DEFAULT_EXCEPTION_MAPPERS

disableDefaultResponseMappers

RestApi.Builder disableDefaultResponseMappers()

Disables mappers listed in RestApiMappers.DEFAULT_RESPONSE_MAPPERS

disableDefaultAclMapping

RestApi.Builder disableDefaultAclMapping()

requiredCapabilities

RestApi.Builder requiredCapabilities(com.yahoo.security.tls.Capability... capabilities)

requiredCapabilities

RestApi.Builder requiredCapabilities(com.yahoo.security.tls.CapabilitySet capabilities)

build

RestApi build()