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

Enum Class GrouperWsRestGetGroup

java.lang.Object

java.lang.Enum<GrouperWsRestGetGroup>

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

All Implemented Interfaces:

Serializable, Comparable<GrouperWsRestGetGroup>, Constable

public enum GrouperWsRestGetGroup
extends Enum<GrouperWsRestGetGroup>

all first level resources on a get request

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
members	group get requests for members
memberships	group get requests for memberships

Method Summary

Modifier and Type	Method	Description
abstract WsResponseBean	service(edu.internet2.middleware.grouper.misc.GrouperVersion clientVersion, String groupName, List<String> urlStrings, WsRequestBean requestObject)	handle the incoming request based on HTTP method GET and group as resource
static GrouperWsRestGetGroup	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GrouperWsRestGetGroup	valueOfIgnoreCase(String string, boolean exceptionOnNotFound)	do a case-insensitive matching
static GrouperWsRestGetGroup[]	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

members

public static final GrouperWsRestGetGroup members

group get requests for members

memberships

public static final GrouperWsRestGetGroup memberships

group get requests for memberships

Method Details

values

public static GrouperWsRestGetGroup[] 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 GrouperWsRestGetGroup 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(edu.internet2.middleware.grouper.misc.GrouperVersion clientVersion,
 String groupName,
 List<String> urlStrings,
 WsRequestBean requestObject)

handle the incoming request based on HTTP method GET and group as resource

Parameters:

clientVersion - version of client, e.g. v1_3_000

urlStrings - not including the app name or servlet. for http://localhost/grouper-ws/servicesRest/xhtml/v3_0_000/groups/a:b/members the urlStrings would be size three: {"group", "a:b", "members"}

groupName - in url

requestObject - is the request body converted to object

Returns:

the return object

valueOfIgnoreCase

public static GrouperWsRestGetGroup valueOfIgnoreCase(String string,
 boolean exceptionOnNotFound)
                                               throws GrouperRestInvalidRequest

do a case-insensitive matching

Parameters:

string -

exceptionOnNotFound - true if exception should be thrown on not found

Returns:

the enum or null or exception if not found

Throws:

GrouperRestInvalidRequest - if there is a problem