com.yahoo.elide

Class ElideSettingsBuilder

java.lang.Object

com.yahoo.elide.ElideSettingsBuilder

public class ElideSettingsBuilder
extends Object

Builder for ElideSettings.

Constructor Summary

Constructors

Constructor and Description
ElideSettingsBuilder(DataStore dataStore) A new builder used to generate Elide instances.

Method Summary

Modifier and Type	Method and Description
ElideSettings	build()
ElideSettingsBuilder	withAuditLogger(AuditLogger auditLogger)
ElideSettingsBuilder	withBaseUrl(String baseUrl) Sets the base URL that will be returned in URLs generated by Elide.
ElideSettingsBuilder	withDefaultMaxPageSize(int maxPageSize)
ElideSettingsBuilder	withDefaultPageSize(int pageSize)
ElideSettingsBuilder	withDefaultSerdes()
ElideSettingsBuilder	withEntityDictionary(EntityDictionary entityDictionary)
ElideSettingsBuilder	withEpochDates()
ElideSettingsBuilder	withExportApiPath(String exportApiPath)
ElideSettingsBuilder	withGraphQLApiPath(String graphQLApiPath)
ElideSettingsBuilder	withGraphQLDialect(FilterDialect dialect)
ElideSettingsBuilder	withISO8601Dates(String dateFormat, TimeZone tz)
ElideSettingsBuilder	withJoinFilterDialect(JoinFilterDialect dialect)
ElideSettingsBuilder	withJSONApiLinks(JSONApiLinks links)
ElideSettingsBuilder	withJsonApiMapper(JsonApiMapper jsonApiMapper)
ElideSettingsBuilder	withJsonApiPath(String jsonApiPath)
ElideSettingsBuilder	withStrictQueryParams(boolean enabled)
ElideSettingsBuilder	withSubqueryFilterDialect(SubqueryFilterDialect dialect)
ElideSettingsBuilder	withUpdate200Status()
ElideSettingsBuilder	withUpdate204Status()
ElideSettingsBuilder	withVerboseErrors()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElideSettingsBuilder

public ElideSettingsBuilder(DataStore dataStore)

A new builder used to generate Elide instances. Instantiates an EntityDictionary without providing a mapping of security checks and uses the provided Slf4jLogger for audit.

Parameters:

dataStore - the datastore used to communicate with the persistence layer

Method Detail

build

public ElideSettings build()

withAuditLogger

public ElideSettingsBuilder withAuditLogger(AuditLogger auditLogger)

withEntityDictionary

public ElideSettingsBuilder withEntityDictionary(EntityDictionary entityDictionary)

withJsonApiMapper

public ElideSettingsBuilder withJsonApiMapper(JsonApiMapper jsonApiMapper)

withJoinFilterDialect

public ElideSettingsBuilder withJoinFilterDialect(JoinFilterDialect dialect)

withSubqueryFilterDialect

public ElideSettingsBuilder withSubqueryFilterDialect(SubqueryFilterDialect dialect)

withDefaultMaxPageSize

public ElideSettingsBuilder withDefaultMaxPageSize(int maxPageSize)

withDefaultPageSize

public ElideSettingsBuilder withDefaultPageSize(int pageSize)

withUpdate200Status

public ElideSettingsBuilder withUpdate200Status()

withUpdate204Status

public ElideSettingsBuilder withUpdate204Status()

withBaseUrl

public ElideSettingsBuilder withBaseUrl(String baseUrl)

Sets the base URL that will be returned in URLs generated by Elide.

Parameters:

baseUrl - The base URL that clients use in queries.

Returns:

the settings builder.

withGraphQLDialect

public ElideSettingsBuilder withGraphQLDialect(FilterDialect dialect)

withVerboseErrors

public ElideSettingsBuilder withVerboseErrors()

withISO8601Dates

public ElideSettingsBuilder withISO8601Dates(String dateFormat,
                                             TimeZone tz)

withEpochDates

public ElideSettingsBuilder withEpochDates()

withDefaultSerdes

public ElideSettingsBuilder withDefaultSerdes()

withJSONApiLinks

public ElideSettingsBuilder withJSONApiLinks(JSONApiLinks links)

withJsonApiPath

public ElideSettingsBuilder withJsonApiPath(String jsonApiPath)

withGraphQLApiPath

public ElideSettingsBuilder withGraphQLApiPath(String graphQLApiPath)

withExportApiPath

public ElideSettingsBuilder withExportApiPath(String exportApiPath)

withStrictQueryParams

public ElideSettingsBuilder withStrictQueryParams(boolean enabled)