Package io.vertigo.vega.webservice.definitions

Class WebServiceDefinition

java.lang.Object
io.vertigo.core.node.definition.AbstractDefinition<WebServiceDefinition>
io.vertigo.vega.webservice.definitions.WebServiceDefinition
All Implemented Interfaces:
io.vertigo.core.node.definition.Definition
public final class WebServiceDefinition extends io.vertigo.core.node.definition.AbstractDefinition<WebServiceDefinition>
Web service definition.
Author:
npiedeloup

  • Field Details

  • Method Details

    • builder

      public static WebServiceDefinitionBuilder builder(Method method)
      Static method factory for WebServiceDefinitionBuilder
      Parameters:
      method - Method to bind to this webService
      Returns:
      WebServiceDefinitionBuilder

    • getPath

      public String getPath()
      Returns:
      path

    • getSortPath

      public String getSortPath()
      Returns:
      sortPath

    • getVerb

      public WebServiceDefinition.Verb getVerb()
      Returns:
      verb

    • getAcceptType

      public String getAcceptType()
      Returns:
      acceptType

    • getMethod

      public Method getMethod()
      Returns:
      method

    • isNeedSession

      public boolean isNeedSession()
      Returns:
      needSession

    • isSessionInvalidate

      public boolean isSessionInvalidate()
      Returns:
      sessionInvalidate

    • isNeedAuthentification

      public boolean isNeedAuthentification()
      Returns:
      needAuthentification

    • isAccessTokenPublish

      public boolean isAccessTokenPublish()
      Returns:
      accessTokenPublish

    • isAccessTokenMandatory

      public boolean isAccessTokenMandatory()
      Returns:
      accessTokenMandatory

    • isAccessTokenConsume

      public boolean isAccessTokenConsume()
      Returns:
      accessTokenConsume

    • isServerSideSave

      public boolean isServerSideSave()
      Returns:
      serverSideSave

    • getIncludedFields

      public Set<String> getIncludedFields()
      Returns:
      includedFields

    • getExcludedFields

      public Set<String> getExcludedFields()
      Returns:
      excludedFields

    • getWebServiceParams

      public List<WebServiceParam> getWebServiceParams()
      Returns:
      webServiceParams

    • getDoc

      public String getDoc()
      Returns:
      doc

    • isCorsProtected

      public boolean isCorsProtected()
      Returns:
      corsProtected

    • isFileAttachment

      public boolean isFileAttachment()
      Returns:
      fileAttachment

    • isNeedApiKey

      public boolean isNeedApiKey()
      Returns:
      the needApiKey