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

Enum Class GrouperWsRestGet

java.lang.Object

java.lang.Enum<GrouperWsRestGet>

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

All Implemented Interfaces:

Serializable, Comparable<GrouperWsRestGet>, Constable

public enum GrouperWsRestGet
extends Enum<GrouperWsRestGet>

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
attributeAssignActions	attribute assign actions get requests
attributeAssignments	attribute get requests
attributeDefNames	attributeDefNames get requests
attributeDefs	attributeDefs get requests
audits	audit get requests
externalSubjects	external subjects get requests
grouperPrivileges	grouperPrivileges get requests
groups	group get requests
memberships	group get requests
messaging	messaging get requests
permissionAssignments	permission get requests
stems	stem get requests
subjects	subject get requests

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 GrouperWsRestGet	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GrouperWsRestGet	valueOfIgnoreCase(String string, boolean exceptionOnNotFound)	do a case-insensitive matching
static GrouperWsRestGet[]	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

groups

public static final GrouperWsRestGet groups

group get requests

attributeDefs

public static final GrouperWsRestGet attributeDefs

attributeDefs get requests

attributeDefNames

public static final GrouperWsRestGet attributeDefNames

attributeDefNames get requests

attributeAssignments

public static final GrouperWsRestGet attributeAssignments

attribute get requests

attributeAssignActions

public static final GrouperWsRestGet attributeAssignActions

attribute assign actions get requests

stems

public static final GrouperWsRestGet stems

stem get requests

grouperPrivileges

public static final GrouperWsRestGet grouperPrivileges

grouperPrivileges get requests

subjects

public static final GrouperWsRestGet subjects

subject get requests

memberships

public static final GrouperWsRestGet memberships

group get requests

permissionAssignments

public static final GrouperWsRestGet permissionAssignments

permission get requests

messaging

public static final GrouperWsRestGet messaging

messaging get requests

externalSubjects

public static final GrouperWsRestGet externalSubjects

external subjects get requests

audits

public static final GrouperWsRestGet audits

audit get requests

Method Details

values

public static GrouperWsRestGet[] 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 GrouperWsRestGet 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 result object

valueOfIgnoreCase

public static GrouperWsRestGet 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