Package edu.internet2.middleware.grouperVoot.restLogic

Enum Class VootWsRest

java.lang.Object
java.lang.Enum<VootWsRest>
edu.internet2.middleware.grouperVoot.restLogic.VootWsRest
All Implemented Interfaces:
Serializable, Comparable<VootWsRest>, Constable
public enum VootWsRest extends Enum<VootWsRest>
All first level resources on a get request.

  • Enum Constant Details

    • groups

      public static final VootWsRest groups
      group get requests

    • people

      public static final VootWsRest people
      people get requests

    • VOOT_BLANK

      public static final VootWsRest VOOT_BLANK
      blank or other request

  • Method Details

    • values

      public static VootWsRest[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VootWsRest valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getStart

      protected int getStart(Map<String,String[]> requestParameters)
      Utility function to retrieve from the query string the startIndex parameter (if present).
      Returns:
      the integer value of the parameter passed.

    • getCount

      protected int getCount(Map<String,String[]> requestParameters)
      Utility function to retrieve from the query string the count parameter (if present).
      Returns:
      the integer value of the parameter passed.

    • service

      public abstract Object service(List<String> urlStrings, VootRestHttpMethod vootRestHttpMethod, Map<String,String[]> requestParameters)
      Handle the incoming request based on HTTP method.
      Parameters:
      urlStrings - not including the app name or servlet. for http://localhost/grouper-ws/servicesRest/groups/a:b the urlStrings would be size two: {"group", "a:b"}
      vootRestHttpMethod - is the method of the call.
      requestParameters - the parameters passed to the request.
      Returns:
      the result object.

    • valueOfIgnoreCase

      public static VootWsRest valueOfIgnoreCase(String string, boolean exceptionOnNotFound) throws GrouperRestInvalidRequest
      Do a case-insensitive matching.
      Parameters:
      string - the first commant to VOOT from query string.
      exceptionOnNotFound - true if exception should be thrown on not found
      Returns:
      the enum or null or exception if not found.
      Throws:
      RuntimeException - if empty string passed.
      GrouperRestInvalidRequest - if there is a problem.