edu.internet2.middleware.grouper.ws.rest.method
Enum GrouperRestHttpMethod

java.lang.Object
  extended by java.lang.Enum<GrouperRestHttpMethod>
      extended by edu.internet2.middleware.grouper.ws.rest.method.GrouperRestHttpMethod
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<GrouperRestHttpMethod>

public enum GrouperRestHttpMethod
extends java.lang.Enum<GrouperRestHttpMethod>

types of http methods accepted by grouper rest


Enum Constant Summary
DELETE
          DELETE
GET
          GET
POST
          POST
PUT
          PUT
 
Method Summary
abstract  WsResponseBean service(GrouperVersion clientVersion, java.util.List<java.lang.String> urlStrings, WsRequestBean requestObject)
          handle the incoming request based on HTTP method
static GrouperRestHttpMethod valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static GrouperRestHttpMethod valueOfIgnoreCase(java.lang.String string, boolean exceptionOnNotFound)
          do a case-insensitive matching
static GrouperRestHttpMethod[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

GET

public static final GrouperRestHttpMethod GET
GET


POST

public static final GrouperRestHttpMethod POST
POST


PUT

public static final GrouperRestHttpMethod PUT
PUT


DELETE

public static final GrouperRestHttpMethod DELETE
DELETE

Method Detail

values

public static GrouperRestHttpMethod[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GrouperRestHttpMethod c : GrouperRestHttpMethod.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GrouperRestHttpMethod valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

service

public abstract WsResponseBean service(GrouperVersion clientVersion,
                                       java.util.List<java.lang.String> urlStrings,
                                       WsRequestBean requestObject)
handle the incoming request based on HTTP method

Parameters:
clientVersion - version of client, e.g. v1_3_000
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"}
requestObject - is the request body converted to object
Returns:
the resultObject

valueOfIgnoreCase

public static GrouperRestHttpMethod valueOfIgnoreCase(java.lang.String string,
                                                      boolean exceptionOnNotFound)
                                               throws GrouperRestInvalidRequest
do a case-insensitive matching

Parameters:
string -
exceptionOnNotFound - true to throw exception if method not found
Returns:
the enum or null or exception if not found
Throws:
GrouperRestInvalidRequest - if there is a problem