Package org.sonar.api.impl.ws

Class ValidatingRequest

  • public abstract class ValidatingRequest
extends org.sonar.api.server.ws.Request
    Since:
    4.2

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.sonar.api.server.ws.Request

        org.sonar.api.server.ws.Request.Param<T extends java.lang.Object>, org.sonar.api.server.ws.Request.Part, org.sonar.api.server.ws.Request.StringParam

    • Field Summary

      • Fields inherited from class org.sonar.api.server.ws.Request

        MSG_PARAMETER_MISSING

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      org.sonar.api.server.ws.WebService.Action action()  
      org.sonar.api.server.ws.LocalConnector localConnector()  
      java.util.List<java.lang.String> multiParam​(java.lang.String key)  
      java.lang.String param​(java.lang.String key)  
      <E extends java.lang.Enum<E>>
      java.util.List<E>      		 paramAsEnums​(java.lang.String key, java.lang.Class<E> enumClass)  
      java.io.InputStream paramAsInputStream​(java.lang.String key)  
      org.sonar.api.server.ws.Request.Part paramAsPart​(java.lang.String key)  
      java.util.List<java.lang.String> paramAsStrings​(java.lang.String key)  
      protected abstract java.io.InputStream readInputStreamParam​(java.lang.String key)  
      protected abstract java.util.List<java.lang.String> readMultiParam​(java.lang.String key)  
      protected abstract java.lang.String readParam​(java.lang.String key)  
      protected abstract org.sonar.api.server.ws.Request.Part readPart​(java.lang.String key)  
      void setAction​(org.sonar.api.server.ws.WebService.Action action)  
      void setLocalConnector​(org.sonar.api.server.ws.LocalConnector lc)  

      • Methods inherited from class org.sonar.api.server.ws.Request

        getHeaders, getMediaType, getParam, getParam, getParam, getParams, getPath, getReader, hasParam, header, mandatoryMultiParam, mandatoryParam, mandatoryParamAsBoolean, mandatoryParamAsEnum, mandatoryParamAsInt, mandatoryParamAsLong, mandatoryParamAsPart, mandatoryParamAsStrings, method, param, paramAsBoolean, paramAsBoolean, paramAsDate, paramAsDateTime, paramAsEnum, paramAsInt, paramAsInt, paramAsLong, paramAsLong

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ValidatingRequest

        public ValidatingRequest()

    • Method Detail

      • setAction

        public void setAction​(org.sonar.api.server.ws.WebService.Action action)

      • action

        public org.sonar.api.server.ws.WebService.Action action()

      • localConnector

        public org.sonar.api.server.ws.LocalConnector localConnector()
        Specified by:
        localConnector in class org.sonar.api.server.ws.Request

      • setLocalConnector

        public void setLocalConnector​(org.sonar.api.server.ws.LocalConnector lc)

      • param

        @CheckForNull
public java.lang.String param​(java.lang.String key)
        Specified by:
        param in class org.sonar.api.server.ws.Request

      • multiParam

        public java.util.List<java.lang.String> multiParam​(java.lang.String key)
        Specified by:
        multiParam in class org.sonar.api.server.ws.Request

      • paramAsInputStream

        @CheckForNull
public java.io.InputStream paramAsInputStream​(java.lang.String key)
        Specified by:
        paramAsInputStream in class org.sonar.api.server.ws.Request

      • paramAsPart

        @CheckForNull
public org.sonar.api.server.ws.Request.Part paramAsPart​(java.lang.String key)
        Specified by:
        paramAsPart in class org.sonar.api.server.ws.Request

      • paramAsStrings

        @CheckForNull
public java.util.List<java.lang.String> paramAsStrings​(java.lang.String key)
        Specified by:
        paramAsStrings in class org.sonar.api.server.ws.Request

      • paramAsEnums

        @CheckForNull
public <E extends java.lang.Enum<E>> java.util.List<E> paramAsEnums​(java.lang.String key,
                                                                    java.lang.Class<E> enumClass)
        Overrides:
        paramAsEnums in class org.sonar.api.server.ws.Request

      • readParam

        @CheckForNull
protected abstract java.lang.String readParam​(java.lang.String key)

      • readMultiParam

        protected abstract java.util.List<java.lang.String> readMultiParam​(java.lang.String key)

      • readInputStreamParam

        @CheckForNull
protected abstract java.io.InputStream readInputStreamParam​(java.lang.String key)

      • readPart

        @CheckForNull
protected abstract org.sonar.api.server.ws.Request.Part readPart​(java.lang.String key)