Package edu.internet2.middleware.grouper.ws.rest.method

Enum Class GrouperRestHttpMethod

java.lang.Object

java.lang.Enum<GrouperRestHttpMethod>

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

All Implemented Interfaces:

Serializable, Comparable<GrouperRestHttpMethod>, Constable

public enum GrouperRestHttpMethod
extends Enum<GrouperRestHttpMethod>

types of http methods accepted by grouper rest

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETE	DELETE
GET	GET
POST	POST
PUT	PUT

Method Summary

Modifier and Type	Method	Description
abstract WsResponseBean	service(GrouperVersion clientVersion, List<String> urlStrings, WsRequestBean requestObject)	handle the incoming request based on HTTP method
static GrouperRestHttpMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GrouperRestHttpMethod	valueOfIgnoreCase(String string, boolean exceptionOnNotFound)	do a case-insensitive matching
static GrouperRestHttpMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static GrouperRestHttpMethod[] 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 GrouperRestHttpMethod 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

service

public abstract WsResponseBean service(GrouperVersion clientVersion,
 List<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(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