DRAFT
Summary
This documents the implementation of one operation of the groups API. There is a reference implementation server which makes it easy to implement the FIFER protocol.
hasMember operation
Note: this is similar to what we already discussed, though as it was implemented, things were tweaked. Of course we should discuss the discrepancies :)
This is an outline of the object model. Each FIFER transport (REST, POX, POJ, SOAP) uses this object model.
...
- GroupHasMemberResponse
- hasMember
- responseMetadata: ResponseMetadata
- errorText: String
- protocolVersion: String
- requestId: String
- resultCode: Sring
- serverMillis: int
- serverType: String
- serverVersion: String
- success: boolean
- warnings: String
SOAP
This is the CXF WSDL from the service interface
...
| Code Block |
|---|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:hasMemberResponse xmlns:ns2="http://ws_v0_1.fiferServer.fifer.jasig.org/"> <return> <hasMember>true</hasMember> </return> </ns2:hasMemberResponse> </soap:Body> </soap:Envelope> |
REST
This is like POJ/POX but has a simplified request interface
...
| Code Block |
|---|
{
"groupHasMemberResponse":{
"hasMember":true,
"responseMetadata":{
"protocolVersion":"v0.1.0",
"requestId":"abcd123412345678909",
"resultCode":"SUCCESS",
"serverMillis":123,
"serverType":"FIFER reference server",
"serverVersion":"v0.5.0",
"success":true
}
}
}
|
POJ (plain old json)
This is similar to REST, except it doesnt use HTTP methods, and it doesnt use the URL to convey request information (though you could use request params)
Request:
| Code Block |
|---|
{{
"groupHasMemberRequest":{
"groupLookup":{
"handle":"someHandle"
},
"subjectLookup":{
"id":"someId"
}
}
}
|
...
| Code Block |
|---|
{
"groupHasMemberResponse":{
"hasMember":true,
"responseMetadata":{
"protocolVersion":"v0.1.0",
"requestId":"abcd123412345678909",
"resultCode":"SUCCESS",
"serverMillis":123,
"serverType":"FIFER reference server",
"serverVersion":"v0.5.0",
"success":true
}
}
}
|
POX (plan old xml)
Request:
| Code Block |
|---|
{<groupHasMemberRequest>
<groupLookup>
<handle>someHandle</handle>
</groupLookup>
<subjectLookup>
<id>someId</id>
</subjectLookup>
</groupHasMemberRequest>
|
...
| Code Block |
|---|
<groupHasMemberResponse>
<responseMetadata>
<serverType>FIFER reference server</serverType>
<requestId>abcd123412345678909</requestId>
<serverVersion>v0.5.0</serverVersion>
<protocolVersion>v0.1.0</protocolVersion>
<success>true</success>
<resultCode>SUCCESS</resultCode>
<serverMillis>123</serverMillis>
</responseMetadata>
<hasMember>true</hasMember>
</groupHasMemberResponse>
|
Reference server
This is a Java server that can easily be used to implement a back-end groups service for all of the above transports. All you need to do is implement the service interfaces. e.g.
...
| Code Block |
|---|
package org.jasig.fifer.fiferServer.grouper;
import org.apache.commons.lang.StringUtils;
import org.jasig.fifer.fiferServer.coreapi.GroupHasMemberResponse;
import org.jasig.fifer.fiferServer.coreapi.GroupLookup;
import org.jasig.fifer.fiferServer.coreapi.ResponseMetadata;
import org.jasig.fifer.fiferServer.coreapi.SubjectLookup;
import org.jasig.fifer.fiferServer.group.MembershipImmediacy;
import org.jasig.fifer.fiferServer.logic.FiferGroupLogicInterface;
import edu.internet2.middleware.grouperClient.api.GcHasMember;
import edu.internet2.middleware.grouperClient.ws.WsMemberFilter;
import edu.internet2.middleware.grouperClient.ws.beans.WsHasMemberResults;
import edu.internet2.middleware.grouperClient.ws.beans.WsSubjectLookup;
/**
* Implement the fifer group service for Grouper
* @author mchyzer
*
*/
public class GrouperGroupLogic implements FiferGroupLogicInterface {
/**
* convert from handle to group name
* @param handle
* @return the group name
*/
private String convertFromGroupHandleToGroupName(String handle) {
//TODO translate from handle to group name
return handle;
}
/**
* @see FiferGroupLogicInterface#hasMember(GroupLookup, SubjectLookup, MembershipImmediacy)
*/
@Override
public GroupHasMemberResponse hasMember(GroupLookup groupLookup, SubjectLookup subjectLookup,
MembershipImmediacy membershipImmediacy) {
GcHasMember gcHasMember = new GcHasMember();
{
if (!StringUtils.isBlank(groupLookup.getId())) {
gcHasMember.assignGroupUuid(groupLookup.getId());
}
if (!StringUtils.isBlank(groupLookup.getHandle())) {
gcHasMember.assignGroupName(convertFromGroupHandleToGroupName(groupLookup.getHandle()));
}
}
{
WsSubjectLookup wsSubjectLookup = new WsSubjectLookup();
if (!StringUtils.isBlank(subjectLookup.getHandle())) {
wsSubjectLookup.setSubjectIdentifier(subjectLookup.getHandle());
}
if (!StringUtils.isBlank(subjectLookup.getId())) {
wsSubjectLookup.setSubjectId(subjectLookup.getId());
}
if (!StringUtils.isBlank(subjectLookup.getIdOrHandle())) {
//set both of these for id or identifier
wsSubjectLookup.setSubjectId(subjectLookup.getIdOrHandle());
wsSubjectLookup.setSubjectIdentifier(subjectLookup.getIdOrHandle());
}
}
{
if (membershipImmediacy == MembershipImmediacy.any) {
gcHasMember.assignMemberFilter(WsMemberFilter.All);
}
if (membershipImmediacy == MembershipImmediacy.immediate) {
gcHasMember.assignMemberFilter(WsMemberFilter.Immediate);
}
if (membershipImmediacy == MembershipImmediacy.nonimmediate) {
gcHasMember.assignMemberFilter(WsMemberFilter.NonImmediate);
}
}
WsHasMemberResults wsHasMemberResults = gcHasMember.execute();
GroupHasMemberResponse groupHasMemberResponse = new GroupHasMemberResponse();
ResponseMetadata responseMetadata = new ResponseMetadata();
groupHasMemberResponse.setResponseMetadata(responseMetadata);
if (StringUtils.equals(wsHasMemberResults.getResultMetadata().getSuccess(), "T")
|| StringUtils.equals(wsHasMemberResults.getResultMetadata().getResultCode(), "SUBJECT_NOT_FOUND")) {
responseMetadata.setSuccess(true);
if (StringUtils.equals(wsHasMemberResults.getResultMetadata().getResultCode(), "SUBJECT_NOT_FOUND")
|| StringUtils.equals(wsHasMemberResults.getResultMetadata().getResultCode(), "IS_NOT_MEMBER")) {
groupHasMemberResponse.setHasMember(false);
} else if (StringUtils.equals(wsHasMemberResults.getResultMetadata().getResultCode(), "IS_MEMBER")) {
groupHasMemberResponse.setHasMember(true);
} else {
throw new RuntimeException("Note expecting Grouper result code: " + wsHasMemberResults.getResultMetadata().getResultCode());
}
}
return groupHasMemberResponse;
}
}
|
Note, the service implementor only needs to worry about the current version of the FIFER API, the reference implementation will degrade gracefully to all previous versions of the API for all formats.