Package io.vertigo.vega.webservice.definitions

Class WebServiceDefinitionBuilder

java.lang.Object

io.vertigo.vega.webservice.definitions.WebServiceDefinitionBuilder

All Implemented Interfaces:

io.vertigo.core.lang.Builder<WebServiceDefinition>

public final class WebServiceDefinitionBuilder
extends Object
implements io.vertigo.core.lang.Builder<WebServiceDefinition>

WebServiceDefinition Builder.

Author:

npiedeloup

Method Summary

Modifier and Type	Method	Description
WebServiceDefinitionBuilder	addExcludedFields(String... excludedFields)
WebServiceDefinitionBuilder	addIncludedFields(String... includedFields)
WebServiceDefinitionBuilder	addWebServiceParam(WebServiceParam webServiceParam)
WebServiceDefinition	build()
boolean	hasVerb()
WebServiceDefinitionBuilder	with(WebServiceDefinition.Verb verb, String path)
WebServiceDefinitionBuilder	withAccessTokenConsume(boolean accessTokenConsume)
WebServiceDefinitionBuilder	withAccessTokenMandatory(boolean accessTokenMandatory)
WebServiceDefinitionBuilder	withAccessTokenPublish(boolean accessTokenPublish)
WebServiceDefinitionBuilder	withCorsProtected(boolean corsProtected)
WebServiceDefinitionBuilder	withDoc(String doc)
WebServiceDefinitionBuilder	withFileAttachment(boolean fileAttachment)
WebServiceDefinitionBuilder	withNeedApiKey(boolean needApiKey)
WebServiceDefinitionBuilder	withNeedAuthentication(boolean needAuthentication)
WebServiceDefinitionBuilder	withNeedSession(boolean needSession)
WebServiceDefinitionBuilder	withPathPrefix(String pathPrefix)
WebServiceDefinitionBuilder	withServerSideSave(boolean serverSideSave)
WebServiceDefinitionBuilder	withSessionInvalidate(boolean sessionInvalidate)

Methods inherited from class java.lang.Object

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

Method Detail

build

public WebServiceDefinition build()

Specified by:

build in interface io.vertigo.core.lang.Builder<WebServiceDefinition>

withPathPrefix

public WebServiceDefinitionBuilder withPathPrefix(String pathPrefix)

Parameters:

pathPrefix - Path prefix

Returns:

this builder

with

public WebServiceDefinitionBuilder with(WebServiceDefinition.Verb verb,
                                        String path)

Parameters:

verb - Verb

path - Path

Returns:

this builder

hasVerb

public boolean hasVerb()

Returns:

if verb was set

withAccessTokenConsume

public WebServiceDefinitionBuilder withAccessTokenConsume(boolean accessTokenConsume)

Parameters:

accessTokenConsume - accessTokenConsume

Returns:

this builder

withNeedAuthentication

public WebServiceDefinitionBuilder withNeedAuthentication(boolean needAuthentication)

Parameters:

needAuthentication - needAuthentication

Returns:

this builder

withNeedApiKey

public WebServiceDefinitionBuilder withNeedApiKey(boolean needApiKey)

Parameters:

needAuthentication - needApiKey

Returns:

this builder

withNeedSession

public WebServiceDefinitionBuilder withNeedSession(boolean needSession)

Parameters:

needSession - needSession

Returns:

this builder

withSessionInvalidate

public WebServiceDefinitionBuilder withSessionInvalidate(boolean sessionInvalidate)

Parameters:

sessionInvalidate - sessionInvalidate

Returns:

this builder

addExcludedFields

public WebServiceDefinitionBuilder addExcludedFields(String... excludedFields)

Parameters:

excludedFields - list of excludedFields

Returns:

this builder

addIncludedFields

public WebServiceDefinitionBuilder addIncludedFields(String... includedFields)

Parameters:

includedFields - list of includedFields

Returns:

this builder

withAccessTokenPublish

public WebServiceDefinitionBuilder withAccessTokenPublish(boolean accessTokenPublish)

Parameters:

accessTokenPublish - accessTokenPublish

Returns:

this builder

withAccessTokenMandatory

public WebServiceDefinitionBuilder withAccessTokenMandatory(boolean accessTokenMandatory)

Parameters:

accessTokenMandatory - accessTokenMandatory

Returns:

this builder

withServerSideSave

public WebServiceDefinitionBuilder withServerSideSave(boolean serverSideSave)

Parameters:

serverSideSave - serverSideSave

Returns:

this builder

withDoc

public WebServiceDefinitionBuilder withDoc(String doc)

Parameters:

doc - doc

Returns:

this builder

withCorsProtected

public WebServiceDefinitionBuilder withCorsProtected(boolean corsProtected)

Parameters:

corsProtected - corsProtected

Returns:

this builder

withFileAttachment

public WebServiceDefinitionBuilder withFileAttachment(boolean fileAttachment)

Parameters:

fileAttachment - fileAttachment

Returns:

this builder

addWebServiceParam

public WebServiceDefinitionBuilder addWebServiceParam(WebServiceParam webServiceParam)

Parameters:

webServiceParam - webServiceParam

Returns:

this builder