Page History

...

To deploy the services, download the warfile and configure the property files (e.g. subject sources, databases, logging, etc).  Configure authentication.

Note: there is a command line and java API web service client called Grouper Client

...

• addMember: assign a member to a group
  • If already a member, that is ok
  • Accepts batches of members (non-Lite)
  • Accepts flag to say that any members not in batch should be removed (e.g. replace list)
• deleteMember: unassign a member from a group
  • If not a member, that is ok
  • Accepts batches of members (non-Lite)
• Get Members: return the members (including subject data) in a group (from direct or indirect membership)
  • Will accept member filter (All, Effective, Immediate, Composite)
  • Accepts batches of groups (non-Lite)
• getMemberships
  • Will accept member filter (All, Effective, Immediate, Composite)
  • Accepts batches of subjects and groups (non-Lite)
• hasMember: see if a subject is a member of a group
  • Will return true or false
  • Accepts batches of subject ids or identifers (returns batches of true's / false's) (non-Lite)
  • Will accept member filter (All, Effective, etc)
  • Can query on field (permission)
• getGroups: list groups for a subject
  • Will accept member filter (All, Effective, etc)
  • Accepts batches of subjects (non-Lite)
• groupSave
  • Create / update a group
  • Accepts batches of groups (non-Lite)
• groupDelete
  • Delete a group
  • Accepts batches of groups (non-Lite)
• getGrouperPrivileges
  • View privileges (many combinations of input are acceptable)
  • Can view all privileges for the subject, group, stem, specific privilege and combinations thereof
• assignGrouperPrivileges
  • Add or remove a privilege for a subject and (group or stem)
  • Will not fail if the privilege is already assigned or revoked
• findGroups
  • Can query for groups based on name, uuid, parent stem, or a substring query
  • Can create complex queries with group match (AND, OR, MINUS) (non-Lite)
• findStems
  • Can query for stems based on name, uuid, parent stem, or a substring query
  • Can create complex queries with group match (AND, OR, MINUS) (non-Lite)
• findAttributeDefNames
  • Can query for attributeDefNames/permissionNames based on name, uuid, inheritance, or a substring query
  • Can sort/page
• stemSave
  • Create / update a stem
  • Accepts batches of stems (non-Lite)
• stemDelete
  • Delete a stem
  • Accepts batches (non-Lite)
• memberChangeSubject
  • Change the subject of a current member
  • Accepts batches (non-Lite)
• assignAttributes
  • Assign or remove attributes (new attribute framework) from groups, stems, memberships, members, assignments, etc
  • Accepts batches (non-Lite)
• assignAttributesBatch
  • Assign or remove attributes (new attribute framework) from groups, stems, memberships, members, assignments, etc in a batch which allows more options for batch assignments than the non-lite "assignAttributes"
  • There is no Lite option for assignAttributesBatch since you can use the Lite version of assignAttributes
• getAttributeAssignments
  • Retrieves attribute assignments (new attribute framework) from groups, stems, memberships, members, assignments, etc
  • Batch or Lite
• assignPermissions
  • Assign or remove permissions from roles or individual subjects (in the context of a role)
  • Batch or Lite
• getPermissionAssignments
  • Retrieves permission assignments from roles or individual subjects (in the context of a role)
  • Batch or Lite
• Get Subjects
  • Lookup or search for subjects and attributes
  • Batch or Lite
• attributeDefNameSave
  • Create / update an attributeDefName
  • Accepts batches of attributeDefNames (non-Lite)
• attributeDefNameDelete
  • Delete an attributeDefName
  • Accepts batches of attributeDefNames lookups (non-Lite)
• getAuditEntries
  • Get audit entries
  • Batch or Lite

Features

• API
  • Batched operations (e.g. add 100 subjects to a group at once).  There is a separate server-side max-in-batch param in the grouper-ws.properties.
  • Transaction support (if any fails in one batch request, rollback all in that single batch request)
• Authentication
  • Let container or web server handle
    o   PKI
    o   http-simple-auth
    o   Source IP address filtering (TODO)
  • Custom authenticator
  • WS-Security
    o   PKI
    o   Kerberos
  • LDAP authn
  • Proxying. The web service can execute operations based on an underlying user, not the authenticating user.  Note the authenticating user must have appropriate permissions
• Error Handling
  • Error codes and error messages are sent in responses, as well as warnings.  In batched mode, batches of response codes are returned.  In REST, the http status code is used as well.
• Clients
  • Grouper will provide a quick start with Java, and it is up to users to create their own clients.  The SOAP and REST are based on the HTTP documents, so any programming language will work
• Web Service Implementation
  • Apache Axis for SOAP, and home-grown for REST
• JSONP is supported, see this jira

...

log4j.appender.grouper_ws                           = org.apache.log4j.DailyRollingFileAppender
log4j.appender.grouper_ws.File                      = ${grouper.home}logs/grouper_ws.log
log4j.appender.grouper_ws.DatePattern               = '.'yyyy-MM-dd
log4j.appender.grouper_ws.MaxBackupIndex            = 30
log4j.appender.grouper_ws.layout                    = org.apache.log4j.PatternLayout
log4j.appender.grouper_ws.layout.ConversionPattern  = %d{ISO8601}: %m%n
 
 
  
# daemon log
log4j.logger.edu.internet2.middleware.grouper.ws.j2ee.ServletFilterLogger = DEBUG, grouper_ws
log4j.additivity.edu.internet2.middleware.grouper.ws.j2ee.ServletFilterLogger = false

...

You will see log entries like this

...