edu.internet2.middleware.grouper.pspng

Class ProvisioningWorkItem

java.lang.Object

edu.internet2.middleware.grouper.pspng.ProvisioningWorkItem

public class ProvisioningWorkItem
extends Object

This is a wrapper for the event-triggering data item used to drive PSP. Besides insulating PSP code from whether it is being triggered by Grouper's ChangeLog process or by a Messaging process, this wrapper also keeps track of the status and additional data associated with this trigger event. For instance, LDAP-based provisioners store the ldap modifications that are necessary to process a trigger event within the events themselves. At the end of a batch of events, all the ldap modifications are pulled together into as few ldap modification operations as possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProvisioningWorkItem.WORK_ITEM_COMMAND

Field Summary

Fields

Modifier and Type	Field and Description
protected org.joda.time.DateTime	asOfDate
protected ProvisioningWorkItem.WORK_ITEM_COMMAND	command
protected String	groupName
protected Map<String,Object>	provisioningData A place where information can be cached between the start/provision/finish phases of a provisioning batch
protected String	status
protected String	statusMessage
protected Boolean	success
protected ChangeLogEntry	work

Constructor Summary

Constructors

Modifier	Constructor and Description
	ProvisioningWorkItem(ChangeLogEntry work)
protected	ProvisioningWorkItem(ProvisioningWorkItem.WORK_ITEM_COMMAND command, GrouperGroupInfo group, org.joda.time.DateTime asOfDate) Create a work item that just holds the groupName without the overhead of a changelog item.

Method Summary

Modifier and Type	Method and Description
void	addValueToProvisioningData(String key, Object value)
static ProvisioningWorkItem	createForFullSync(GrouperGroupInfo grouperGroupInfo, org.joda.time.DateTime asOfDate)
static ProvisioningWorkItem	createForGroupCleanup(org.joda.time.DateTime asOfDate)
String	getAttributeName()
ChangeLogEntry	getChangelogEntry()
Long	getGroupIdIndex() Return the idIndex from the changelog entry
GrouperGroupInfo	getGroupInfo(Provisioner provisioner)
String	getGroupName()
String	getMdcLabel()
Object	getProvisioningDataValue(String key)
List<Object>	getProvisioningDataValues(String key)
String	getStatusMessage()
Subject	getSubject(Provisioner provisioner)
boolean	hasBeenProcessed() Has this work item been processed?
boolean	isSubjectUnresolvable(Provisioner provisioner)
void	markAsFailure(String statusMessageFormat, Object... statusMessageArgs)
void	markAsSkipped(String statusMessageFormat, Object... statusMessageArgs)
void	markAsSkippedAndWarn(String statusMessageFormat, Object... statusMessageArgs)
void	markAsSuccess(String statusMessageFormat, Object... statusMessageArgs)
boolean	matchesChangelogType(ChangeLogTypeBuiltin type) Does the embedded changelog entry match the given type?
boolean	matchesChangelogType(Collection<ChangeLogTypeBuiltin> types) Does the embedded changelog entry have a type contained in the given collection of types?
void	putProvisioningData(String key, Object value)
String	toString()
boolean	wasError()
boolean	wasSuccessful()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

command

protected final ProvisioningWorkItem.WORK_ITEM_COMMAND command

work

protected final ChangeLogEntry work

groupName

protected String groupName

asOfDate

protected org.joda.time.DateTime asOfDate

success

protected Boolean success

status

protected String status

statusMessage

protected String statusMessage

provisioningData

protected Map<String,Object> provisioningData

A place where information can be cached between the start/provision/finish phases of a provisioning batch

Constructor Detail

ProvisioningWorkItem

protected ProvisioningWorkItem(ProvisioningWorkItem.WORK_ITEM_COMMAND command,
                               GrouperGroupInfo group,
                               org.joda.time.DateTime asOfDate)

Create a work item that just holds the groupName without the overhead of a changelog item. This is used when Provisioner code is used in FullSync processes.

Parameters:

command - - What command does this Item represent

group -

ProvisioningWorkItem

public ProvisioningWorkItem(ChangeLogEntry work)

Method Detail

createForFullSync

public static ProvisioningWorkItem createForFullSync(GrouperGroupInfo grouperGroupInfo,
                                                     org.joda.time.DateTime asOfDate)

createForGroupCleanup

public static ProvisioningWorkItem createForGroupCleanup(org.joda.time.DateTime asOfDate)

getChangelogEntry

public ChangeLogEntry getChangelogEntry()

markAsSkippedAndWarn

public void markAsSkippedAndWarn(String statusMessageFormat,
                                 Object... statusMessageArgs)

markAsSkipped

public void markAsSkipped(String statusMessageFormat,
                          Object... statusMessageArgs)

markAsSuccess

public void markAsSuccess(String statusMessageFormat,
                          Object... statusMessageArgs)

markAsFailure

public void markAsFailure(String statusMessageFormat,
                          Object... statusMessageArgs)

hasBeenProcessed

public boolean hasBeenProcessed()

Has this work item been processed?

Returns:

true when this item should not be processed further

getGroupName

public String getGroupName()

getGroupInfo

public GrouperGroupInfo getGroupInfo(Provisioner provisioner)

getGroupIdIndex

public Long getGroupIdIndex()

Return the idIndex from the changelog entry

Returns:

getAttributeName

public String getAttributeName()

getSubject

public Subject getSubject(Provisioner provisioner)

isSubjectUnresolvable

public boolean isSubjectUnresolvable(Provisioner provisioner)

putProvisioningData

public void putProvisioningData(String key,
                                Object value)

getProvisioningDataValue

public Object getProvisioningDataValue(String key)

addValueToProvisioningData

public void addValueToProvisioningData(String key,
                                       Object value)

getProvisioningDataValues

public List<Object> getProvisioningDataValues(String key)

wasSuccessful

public boolean wasSuccessful()

wasError

public boolean wasError()

getStatusMessage

public String getStatusMessage()

toString

public String toString()

Overrides:

toString in class Object

getMdcLabel

public String getMdcLabel()

matchesChangelogType

public boolean matchesChangelogType(ChangeLogTypeBuiltin type)

Does the embedded changelog entry match the given type?

Parameters:

type -

Returns:

matchesChangelogType

public boolean matchesChangelogType(Collection<ChangeLogTypeBuiltin> types)

Does the embedded changelog entry have a type contained in the given collection of types?

Parameters:

types -

Returns: