Notifications (change log)

# if we should insert records into grouper_change_log_temp when events happen
# defaults to true
changeLog.enabled = true

# should the change log temp to change log daemon run?
changeLog.changeLogTempToChangeLog.enable = true

#quartz cron-like schedule for change log temp to change log daemon, the default is 50 seconds after every minute: 50 * * * * ?
#leave blank to disable this
changeLog.changeLogTempToChangeLog.quartz.cron =

GrouperSession grouperSession = GrouperSession.startRootSession();
AttributeDef provisioningMarkerAttributeDef = new AttributeDefSave(grouperSession).assignCreateParentStemsIfNotExist(true).assignName("attr:someAttrDef").assignToStem(true).assignToGroup(true).save();
AttributeDefName provisioningMarkerAttributeName = new AttributeDefNameSave(grouperSession, provisioningMarkerAttributeDef).assignName("attr:provisioningMarker").save()


Stem parentFolder = StemFinder.findByName(grouperSession, "some:folder", true);
parentFolder.getAttributeDelegate().assignAttribute(provisioningMarkerAttributeName);
 
Group someGroup = GroupFinder.findByName(grouperSession, "another:folder:someGroup", true);
someGroup .getAttributeDelegate().assignAttribute(provisioningMarkerAttributeName);

changeLog.consumer.abc.class = edu.internet2.middleware.grouper.changeLog.consumer.PrintChangeLogConsumer


# note: this name matches the attribute name created in the example above
changeLog.consumer.abc.syncAttributeName = attr:provisioningMarker
changeLog.consumer.abc.quartzCron =
# defaults to true if not configured
changeLog.consumer.abc.retryOnError = true

public class SomeChangeLogConsumer extends ChangeLogConsumerBaseImpl {
 
  protected void renameGroup(String oldGroupName, String newGroupName, ChangeLogEntry changeLogEntry) {
  }


  protected void removeMovedGroup(String oldGroupName, ChangeLogEntry changeLogEntry) {
  }
 
  protected void addGroup(Group group, ChangeLogEntry changeLogEntry) {
  }


  protected void addGroupAndMemberships(Group group, ChangeLogEntry changeLogEntry) {
  }


  protected void updateGroup(Group group, ChangeLogEntry changeLogEntry) {
  }
 
  protected void removeGroup(Group group, ChangeLogEntry changeLogEntry) {
  }


  protected void removeDeletedGroup(PITGroup pitGroup, ChangeLogEntry changeLogEntry) {
  }


  protected void addMembership(Subject subject, Group group, ChangeLogEntry changeLogEntry) {
  }


  protected void removeMembership(Subject subject, Group group, ChangeLogEntry changeLogEntry) {
  }


  protected boolean isFullSyncRunning(String consumerName) {
  }
}
 

package edu.internet2.middleware.grouper.changeLog.consumer;

import java.util.List;
import edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase;
import edu.internet2.middleware.grouper.changeLog.ChangeLogEntry;
import edu.internet2.middleware.grouper.changeLog.ChangeLogLabels;
import edu.internet2.middleware.grouper.changeLog.ChangeLogProcessorMetadata;
import edu.internet2.middleware.grouper.changeLog.ChangeLogTypeBuiltin;


/**
 * just print out some of the events
 */
public class PrintTest extends ChangeLogConsumerBase {

  /**
   * @see edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase#processChangeLogEntries(java.util.List, edu.internet2.middleware.grouper.changeLog.ChangeLogProcessorMetadata)
   */
  @Override
  public long processChangeLogEntries(List<ChangeLogEntry> changeLogEntryList,
      ChangeLogProcessorMetadata changeLogProcessorMetadata) {

    long currentId = -1;

    //try catch so we can track that we made some progress
    try {
      for (ChangeLogEntry changeLogEntry : changeLogEntryList) {
        currentId = changeLogEntry.getSequenceNumber();

        //if this is a group type add action and category
        if (changeLogEntry.equalsCategoryAndAction(ChangeLogTypeBuiltin.GROUP_TYPE_ADD)) {

          //print the name from the entry
          System.out.println("Group type add, name: "
              + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_TYPE_ADD.name));
        }

        if (changeLogEntry.equalsCategoryAndAction(ChangeLogTypeBuiltin.GROUP_TYPE_DELETE)) {

          //print the name from the entry
          System.out.println("Group type delete, name: "
              + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_TYPE_DELETE.name));
        }

        //if this is a group add action and category
        if (changeLogEntry.equalsCategoryAndAction(ChangeLogTypeBuiltin.GROUP_ADD)) {

          //print the name from the entry
          System.out.println("Group add, name: "
              + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_ADD.name));
        }

        if (changeLogEntry.equalsCategoryAndAction(ChangeLogTypeBuiltin.GROUP_DELETE)) {

          //print the name from the entry
          System.out.println("Group delete, name: "
              + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_DELETE.name));
        }

        if (changeLogEntry.equalsCategoryAndAction(ChangeLogTypeBuiltin.GROUP_UPDATE)) {

          //print the name from the entry
          System.out.println("Group update, name: "
              + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_UPDATE.name)
              + ", property: " + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_UPDATE.propertyChanged)
              + ", from: '" + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_UPDATE.propertyOldValue)
              + "', to: '" + changeLogEntry.retrieveValueForLabel(ChangeLogLabels.GROUP_UPDATE.propertyNewValue) + "'");
        }

        //we successfully processed this record
      }
    } catch (Exception e) {
      changeLogProcessorMetadata.registerProblem(e, "Error processing record", currentId);
      //we made it to this -1
      return currentId-1;
    }
    if (currentId == -1) {
      throw new RuntimeException("Couldnt process any records");
    }

    return currentId;
  }

}

You need the grouper API jars, you can get those from a WS or UI deployment, or from the API itself...

In this case I used my WS deployment:

[appadmin@fasttest-small-b-01 temp]$ pwd
/opt/appserv/tomcat/apps/grouperWs/webapps/grouperWs/WEB-INF/temp
[appadmin@fasttest-small-b-01 temp]$ mkdir -p edu/internet2/middleware/grouper/changeLog/consumer

... put the source in the file with your favorite editor ...

[appadmin@fasttest-small-b-01 temp]$ cat edu/internet2/middleware/grouper/changeLog/consumer/PrintTest.java
package edu.internet2.middleware.grouper.changeLog.consumer;

import java.util.List;
import edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase;
import edu.internet2.middleware.grouper.changeLog.ChangeLogEntry;
import edu.internet2.middleware.grouper.changeLog.ChangeLogLabels;
import edu.internet2.middleware.grouper.changeLog.ChangeLogProcessorMetadata;
import edu.internet2.middleware.grouper.changeLog.ChangeLogTypeBuiltin;


/**
 * just print out some of the events
 */
public class PrintTest extends ChangeLogConsumerBase {
...

[appadmin@fastprod-medium-a-01 temp]$ javac -classpath "../lib/*" -sourcepath . edu/internet2/middleware/grouper/changeLog/consumer/PrintTest.java

Then you can put that in a jar, put the jar in the grouper lib dir, should be good to go:

[appadmin@fastprod-medium-a-01 temp]$ jar cvf printTest.jar .
added manifest
adding: edu/(in = 0) (out= 0)(stored 0%)
adding: edu/internet2/(in = 0) (out= 0)(stored 0%)
adding: edu/internet2/middleware/(in = 0) (out= 0)(stored 0%)
adding: edu/internet2/middleware/grouper/(in = 0) (out= 0)(stored 0%)
adding: edu/internet2/middleware/grouper/changeLog/(in = 0) (out= 0)(stored 0%)
adding: edu/internet2/middleware/grouper/changeLog/consumer/(in = 0) (out= 0)(stored 0%)
adding: edu/internet2/middleware/grouper/changeLog/consumer/PrintTest.java(in = 3289) (out= 793)(deflated 75%)
adding: edu/internet2/middleware/grouper/changeLog/consumer/PrintTest.class(in = 3724) (out= 1485)(deflated 60%)
[appadmin@fastprod-medium-a-01 temp]$ ls -altr
total 16
drwxr-xr-x. 9 appadmin users 4096 Sep 24 14:40 ..
drwxr-xr-x. 3 appadmin users 4096 Sep 24 14:41 edu
drwxr-xr-x. 3 appadmin users 4096 Sep 24 14:43 .
-rw-r--r--. 1 appadmin users 3871 Sep 24 14:43 printTest.jar
[appadmin@fastprod-medium-a-01 temp]$ jar tf printTest.jar
META-INF/
META-INF/MANIFEST.MF
edu/
edu/internet2/
edu/internet2/middleware/
edu/internet2/middleware/grouper/
edu/internet2/middleware/grouper/changeLog/
edu/internet2/middleware/grouper/changeLog/consumer/
edu/internet2/middleware/grouper/changeLog/consumer/PrintTest.java
edu/internet2/middleware/grouper/changeLog/consumer/PrintTest.class
[appadmin@fastprod-medium-a-01 temp]$

#specify the consumers here.  specify the consumer name after the changeLog.consumer. part.  This example is "ldappc"
#but it could be changeLog.consumer.myConsumerName.class
#the class must extend edu.internet2.middleware.grouper.changeLog.ChangeLogConsumerBase
#changeLog.consumer.ldappc.class =

#the quartz cron is a cron-like string.  it defaults to every minute on the minute (since the temp to change log job runs
#at 10 seconds to each minute).  it defaults to this: 0 * * * * ?
#though it will stagger each one by 2 seconds
#changeLog.consumer.ldappc.quartzCron =

changeLog.consumer.printTest.class = edu.internet2.middleware.grouper.changeLog.consumer.PrintTest
changeLog.consumer.printTest.quartzCron =

C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper>bin\gsh -loader
Using GROUPER_HOME:           C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper\bin\..
Using GROUPER_CONF:           C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper\bin\../conf
Using JAVA:                   "c:\dev_inst\java/bin/java"
using MEMORY:                 64m-512m
Grouper starting up: version: 1.5.0-rc1, build date: 2009/06/10 01:09:59, env: DEV
...

C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper>bin\gsh
Using GROUPER_HOME:           C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper\bin\..
Using GROUPER_CONF:           C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper\bin\../conf
Using JAVA:                   "c:\dev_inst\java/bin/java"
using MEMORY:                 64m-512m
...
gsh 0% typeAdd("testA");
type: 'testA'
gsh 1% addRootStem("stem1", "stem1");
stem: name='stem1' displayName='stem1' uuid='ece24338-afde-4d5f-8593-d11b8b4341aa'
gsh 2% group = addGroup("stem1", "group1", "group1");
group: name='stem1:group1' displayName='stem1:group1' uuid='6ada2741-20b0-4cb6-9780-b07cfaf31db3'
gsh 3% typeDel("testA");
true
gsh 4% group.setDisplayExtension("group2");
gsh 5% group.setDescription("my description");
gsh 6% group.store();
gsh 7% typeAdd("testB");
type: 'testB'
gsh 8% typeDel("testB");
true
gsh 9% group.delete();
gsh 10%

C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper>bin\gsh -loader
Using GROUPER_HOME:           C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper\bin\..
Using GROUPER_CONF:           C:\mchyzer\isc\dev\grouper-qs-1.2.0\grouper\bin\../conf
Using JAVA:                   "c:\dev_inst\java/bin/java"
using MEMORY:                 64m-512m
Group type add, name: testA
Group add, name: stem1:group1
Group type delete, name: testA
Group update, name: stem1:group1, property: description, from: 'null', to: 'my description'
Group update, name: stem1:group1, property: displayExtension, from: 'group1', to: 'group2'
Group type add, name: testB
Group type delete, name: testB
Group delete, name: stem1:group1

select * from grouper_change_log_consumer

name       last_sequence_processed  last_updated   created_on     id                                    hibernate_version_number
--------------------------------------------------------------------------------------------------------------------------------
printTest  14                       1244611320119  1244610780084  57bd90bc-64b9-43c7-8023-dbb2b5fcbd03  4