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

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

public enum GrouperWsRestGetSubject
extends Enum<GrouperWsRestGetSubject>

all first level resources on a get request


Enum Constant Summary
groups
          group get requests for groups
memberships
          group get requests for subject
 
Method Summary
abstract  WsResponseBean service(GrouperVersion clientVersion, String subjectId, String sourceId, List<String> urlStrings, WsRequestBean requestObject)
          handle the incoming request based on HTTP method GET and group as resource
static GrouperWsRestGetSubject valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GrouperWsRestGetSubject valueOfIgnoreCase(String string, boolean exceptionOnNotFound)
          do a case-insensitive matching
static GrouperWsRestGetSubject[] 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

groups

public static final GrouperWsRestGetSubject groups
group get requests for groups


memberships

public static final GrouperWsRestGetSubject memberships
group get requests for subject

Method Detail

values

public static GrouperWsRestGetSubject[] 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 (GrouperWsRestGetSubject c : GrouperWsRestGetSubject.values())
    System.out.println(c);

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

valueOf

public static GrouperWsRestGetSubject valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

service

public abstract WsResponseBean service(GrouperVersion clientVersion,
                                       String subjectId,
                                       String sourceId,
                                       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"}
sourceId - in url (if applicable)
subjectId - in url (if applicable)
requestObject - is the request body converted to object
Returns:
the return object

valueOfIgnoreCase

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