GcGrouperSync (Grouper Client 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouperClient.jdbc.tableSync.GcGrouperSync

All Implemented Interfaces:

GcDbVersionable, GcSqlAssignPrimaryKey
```
public class GcGrouperSync
extends Object
implements GcSqlAssignPrimaryKey, GcDbVersionable
```
one record for each provisioner. even if full and incremental, only one record. retrieve all other sync objects from this object, and pass it around, and store all at once at end

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTESTATION_PROPAGATION` use this to propagate attestation from folders to groups
`static String`	`DEPROVISIONING` use this for deprovisioning
`static String`	`OBJECT_TYPE_PROPAGATION` use this to propagate object types from folders to sub folders and groups
`static String`	`PROVISIONING` use this for provisioning
`static String`	`SQL_SYNC_ENGINE` use this for sql engine sync

Constructor Summary

Constructors
Constructor and Description

GcGrouperSync()

Constructors
Constructor and Description
`GcGrouperSync()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObjectCreatedCount(int amountToAdd)` add object count created (query count)
`int`	`batchSize()`
`GcGrouperSync`	`clone()` deep clone the fields in this object
`void`	`dbVersionDelete()` db version
`boolean`	`dbVersionDifferent()` if we need to update this object
`void`	`dbVersionReset()` take a snapshot of the data since this is what is in the db
`static String`	`defaultConnectionName(String connectionName)` use 'grouper' if not specified
`boolean`	`equalsDeep(Object obj)`
`boolean`	`gcSqlAssignNewPrimaryKeyForInsert()` assign a new primary key for insert.
`String`	`getConnectionName()` connection name or null for default
`GcGrouperSyncDao`	`getGcGrouperSyncDao()` dao for syncs
`GcGrouperSyncGroupDao`	`getGcGrouperSyncGroupDao()` dao for groups
`GcGrouperSyncJobDao`	`getGcGrouperSyncJobDao()` dao for jobs
`GcGrouperSyncLogDao`	`getGcGrouperSyncLogDao()` dao for log operations
`GcGrouperSyncMemberDao`	`getGcGrouperSyncMemberDao()` dao for members
`GcGrouperSyncMembershipDao`	`getGcGrouperSyncMembershipDao()` dao for memberships
`Integer`	`getGroupCount()` if group this is the number of groups
`String`	`getId()` uuid of this record in this table
`Long`	`getIncrementalIndex()` int of last record processed
`Timestamp`	`getIncrementalTimestamp()` when last record processed if timestamp and not integer
`int`	`getInternalObjectsCreatedCount()` keep count of objects created
`Timestamp`	`getLastFullMetadataSyncRun()` when last full metadata sync ran.
`Timestamp`	`getLastFullMetadataSyncStart()` when last full metadata sync started.
`Timestamp`	`getLastFullSyncRun()` when last full sync ran (end)
`Timestamp`	`getLastFullSyncStart()` when last full sync started
`Timestamp`	`getLastIncrementalSyncRun()` when incremental sync ran
`Timestamp`	`getLastUpdated()` when this record was last updated
`String`	`getProvisionerName()` name of provisioner must be unique.
`Integer`	`getRecordsCount()` number of records including users, groups, etc
`String`	`getSyncEngine()` e.g.
`Integer`	`getUserCount()` if has users, this is the number of users
`static void`	`main(String[] args)`
`int`	`maxBindVarsInSelect()`
`static void`	`reset()` delete all data if table is here
`void`	`setConnectionName(String connectionName1)` connection name or null for default
`void`	`setGroupCount(Integer groupCount1)` if group this is the number of groups
`void`	`setId(String id1)` uuid of this record in this table
`void`	`setIncrementalIndex(Long incrementalIndexOrMillis1)` int of last record processed
`void`	`setIncrementalTimestamp(Timestamp incrementalTimestamp1)` when last record processed if timestamp and not integer
`void`	`setInternalObjectsCreatedCount(int internalObjectsCreatedCount1)` keep count of objects created
`void`	`setLastFullMetadataSyncRun(Timestamp lastFullMetadataSyncRun1)` when last full metadata sync ran.
`void`	`setLastFullMetadataSyncStart(Timestamp lastFullMetadataSyncStart)` when last full metadata sync started.
`void`	`setLastFullSyncRun(Timestamp lastFullSyncRun1)` when last full sync ran (end)
`void`	`setLastFullSyncStart(Timestamp lastFullSyncStart)` when last full sync started
`void`	`setLastIncrementalSyncRun(Timestamp lastIncrementalSyncRun1)` when incremental sync ran
`void`	`setLastUpdated(Timestamp lastUpdated1)` when this record was last updated
`void`	`setProvisionerName(String provisionerName1)` name of provisioner must be unique.
`void`	`setRecordsCount(Integer recordsCount1)` number of records including users, groups, etc
`void`	`setSyncEngine(String syncEngine1)` e.g.
`void`	`setUserCount(Integer userCount1)` if has users, this is the number of users
`void`	`storePrepare()`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SQL_SYNC_ENGINE
```
public static final String SQL_SYNC_ENGINE
```
    use this for sql engine sync
    
    See Also:
    
    Constant Field Values
  - PROVISIONING
```
public static final String PROVISIONING
```
    use this for provisioning
    
    See Also:
    
    Constant Field Values
  - DEPROVISIONING
```
public static final String DEPROVISIONING
```
    use this for deprovisioning
    
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_PROPAGATION
```
public static final String OBJECT_TYPE_PROPAGATION
```
    use this to propagate object types from folders to sub folders and groups
    
    See Also:
    
    Constant Field Values
  - ATTESTATION_PROPAGATION
```
public static final String ATTESTATION_PROPAGATION
```
    use this to propagate attestation from folders to groups
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GcGrouperSync
```
public GcGrouperSync()
```
- Method Detail
  - getInternalObjectsCreatedCount
```
public int getInternalObjectsCreatedCount()
```
    keep count of objects created
    
    Returns:
    
    count
  - setInternalObjectsCreatedCount
```
public void setInternalObjectsCreatedCount(int internalObjectsCreatedCount1)
```
    keep count of objects created
    
    Parameters:
    
    internalObjectsCreatedCount1 -
  - addObjectCreatedCount
```
public void addObjectCreatedCount(int amountToAdd)
```
    add object count created (query count)
    
    Parameters:
    
    amountToAdd -
  - batchSize
```
public int batchSize()
```
    Returns:
    
    batch size if configured or 1000 be default
  - maxBindVarsInSelect
```
public int maxBindVarsInSelect()
```
    Returns:
    
    batch size if configured or 1000 be default
  - getGcGrouperSyncGroupDao
```
public GcGrouperSyncGroupDao getGcGrouperSyncGroupDao()
```
    dao for groups
    
    Returns:
  - dbVersionReset
```
public void dbVersionReset()
```
    take a snapshot of the data since this is what is in the db
    
    Specified by:
    
    dbVersionReset in interface GcDbVersionable
  - dbVersionDifferent
```
public boolean dbVersionDifferent()
```
    if we need to update this object
    
    Specified by:
    
    dbVersionDifferent in interface GcDbVersionable
    
    Returns:
    
    if needs to update this object
  - dbVersionDelete
```
public void dbVersionDelete()
```
    db version
    
    Specified by:
    
    dbVersionDelete in interface GcDbVersionable
  - clone
```
public GcGrouperSync clone()
```
    deep clone the fields in this object
    
    Overrides:
    
    clone in class Object
  - equalsDeep
```
public boolean equalsDeep(Object obj)
```
  - reset
```
public static void reset()
```
    delete all data if table is here
  - defaultConnectionName
```
public static String defaultConnectionName(String connectionName)
```
    use 'grouper' if not specified
    
    Parameters:
    
    connectionName -
    
    Returns:
    
    the connection name
  - getLastIncrementalSyncRun
```
public Timestamp getLastIncrementalSyncRun()
```
    when incremental sync ran
    
    Returns:
  - setLastIncrementalSyncRun
```
public void setLastIncrementalSyncRun(Timestamp lastIncrementalSyncRun1)
```
    when incremental sync ran
    
    Parameters:
    
    lastIncrementalSyncRun1 -
  - getLastFullSyncStart
```
public Timestamp getLastFullSyncStart()
```
    when last full sync started
    
    Returns:
  - setLastFullSyncStart
```
public void setLastFullSyncStart(Timestamp lastFullSyncStart)
```
    when last full sync started
    
    Parameters:
    
    lastFullSyncStart -
  - getLastFullSyncRun
```
public Timestamp getLastFullSyncRun()
```
    when last full sync ran (end)
    
    Returns:
    
    when
  - setLastFullSyncRun
```
public void setLastFullSyncRun(Timestamp lastFullSyncRun1)
```
    when last full sync ran (end)
    
    Parameters:
    
    lastFullSyncRun1 -
  - getLastFullMetadataSyncStart
```
public Timestamp getLastFullMetadataSyncStart()
```
    when last full metadata sync started. this needs to run when groups get renamed
    
    Returns:
  - setLastFullMetadataSyncStart
```
public void setLastFullMetadataSyncStart(Timestamp lastFullMetadataSyncStart)
```
    when last full metadata sync started. this needs to run when groups get renamed
    
    Parameters:
    
    lastFullMetadataSyncStart -
  - getLastFullMetadataSyncRun
```
public Timestamp getLastFullMetadataSyncRun()
```
    when last full metadata sync ran. this needs to run when groups get renamed
    
    Returns:
    
    when
  - setLastFullMetadataSyncRun
```
public void setLastFullMetadataSyncRun(Timestamp lastFullMetadataSyncRun1)
```
    when last full metadata sync ran. this needs to run when groups get renamed
    
    Parameters:
    
    lastFullMetadataSyncRun1 -
  - getIncrementalIndex
```
public Long getIncrementalIndex()
```
    int of last record processed
    
    Returns:
    
    number
  - setIncrementalIndex
```
public void setIncrementalIndex(Long incrementalIndexOrMillis1)
```
    int of last record processed
    
    Parameters:
    
    incrementalIndexOrMillis1 -
  - getIncrementalTimestamp
```
public Timestamp getIncrementalTimestamp()
```
    when last record processed if timestamp and not integer
    
    Returns:
    
    timestamp
  - setIncrementalTimestamp
```
public void setIncrementalTimestamp(Timestamp incrementalTimestamp1)
```
    when last record processed if timestamp and not integer
    
    Parameters:
    
    incrementalTimestamp1 -
  - getConnectionName
```
public String getConnectionName()
```
    connection name or null for default
    
    Returns:
    
    connection name
  - setConnectionName
```
public void setConnectionName(String connectionName1)
```
    connection name or null for default
    
    Parameters:
    
    connectionName1 -
  - storePrepare
```
public void storePrepare()
```
  - main
```
public static void main(String[] args)
```
    Parameters:
    
    args -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getId
```
public String getId()
```
    uuid of this record in this table
    
    Returns:
    
    the id
  - setId
```
public void setId(String id1)
```
    uuid of this record in this table
    
    Parameters:
    
    id1 - the id to set
  - getSyncEngine
```
public String getSyncEngine()
```
    e.g. for syncing sql, it sqlTableSync
    
    Returns:
    
    sync engine
  - setSyncEngine
```
public void setSyncEngine(String syncEngine1)
```
    e.g. for syncing sql, it sqlTableSync
    
    Parameters:
    
    syncEngine1 -
  - getProvisionerName
```
public String getProvisionerName()
```
    name of provisioner must be unique. this is the config key generally
    
    Returns:
    
    provisioner name
  - setProvisionerName
```
public void setProvisionerName(String provisionerName1)
```
    name of provisioner must be unique. this is the config key generally
    
    Parameters:
    
    provisionerName1 -
  - getLastUpdated
```
public Timestamp getLastUpdated()
```
    when this record was last updated
    
    Returns:
    
    when last updated
  - setLastUpdated
```
public void setLastUpdated(Timestamp lastUpdated1)
```
    when this record was last updated
    
    Parameters:
    
    lastUpdated1 -
  - getGroupCount
```
public Integer getGroupCount()
```
    if group this is the number of groups
    
    Returns:
    
    group count
  - setGroupCount
```
public void setGroupCount(Integer groupCount1)
```
    if group this is the number of groups
    
    Parameters:
    
    groupCount1 -
  - getUserCount
```
public Integer getUserCount()
```
    if has users, this is the number of users
    
    Returns:
    
    user count
  - setUserCount
```
public void setUserCount(Integer userCount1)
```
    if has users, this is the number of users
    
    Parameters:
    
    userCount1 -
  - getGcGrouperSyncLogDao
```
public GcGrouperSyncLogDao getGcGrouperSyncLogDao()
```
    dao for log operations
    
    Returns:
  - getRecordsCount
```
public Integer getRecordsCount()
```
    number of records including users, groups, etc
    
    Returns:
    
    number of records
  - setRecordsCount
```
public void setRecordsCount(Integer recordsCount1)
```
    number of records including users, groups, etc
    
    Parameters:
    
    recordsCount1 -
  - gcSqlAssignNewPrimaryKeyForInsert
```
public boolean gcSqlAssignNewPrimaryKeyForInsert()
```
    Description copied from interface: GcSqlAssignPrimaryKey
    
    assign a new primary key for insert. return true if assigned (insert) or false if not needed
    
    Specified by:
    
    gcSqlAssignNewPrimaryKeyForInsert in interface GcSqlAssignPrimaryKey
  - getGcGrouperSyncJobDao
```
public GcGrouperSyncJobDao getGcGrouperSyncJobDao()
```
    dao for jobs
    
    Returns:
  - getGcGrouperSyncMemberDao
```
public GcGrouperSyncMemberDao getGcGrouperSyncMemberDao()
```
    dao for members
    
    Returns:
  - getGcGrouperSyncMembershipDao
```
public GcGrouperSyncMembershipDao getGcGrouperSyncMembershipDao()
```
    dao for memberships
    
    Returns:
  - getGcGrouperSyncDao
```
public GcGrouperSyncDao getGcGrouperSyncDao()
```
    dao for syncs
    
    Returns:

Class GcGrouperSync

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SQL_SYNC_ENGINE

PROVISIONING

DEPROVISIONING

OBJECT_TYPE_PROPAGATION

ATTESTATION_PROPAGATION

Constructor Detail

GcGrouperSync

Method Detail

getInternalObjectsCreatedCount

setInternalObjectsCreatedCount

addObjectCreatedCount

batchSize

maxBindVarsInSelect

getGcGrouperSyncGroupDao

dbVersionReset

dbVersionDifferent

dbVersionDelete

clone

equalsDeep

reset

defaultConnectionName

getLastIncrementalSyncRun

setLastIncrementalSyncRun

getLastFullSyncStart

setLastFullSyncStart

getLastFullSyncRun

setLastFullSyncRun

getLastFullMetadataSyncStart

setLastFullMetadataSyncStart

getLastFullMetadataSyncRun

setLastFullMetadataSyncRun

getIncrementalIndex

setIncrementalIndex

getIncrementalTimestamp

setIncrementalTimestamp

getConnectionName

setConnectionName

storePrepare

main

toString

getId

setId

getSyncEngine

setSyncEngine

getProvisionerName

setProvisionerName

getLastUpdated

setLastUpdated

getGroupCount

setGroupCount

getUserCount

setUserCount

getGcGrouperSyncLogDao

getRecordsCount

setRecordsCount

gcSqlAssignNewPrimaryKeyForInsert

getGcGrouperSyncJobDao

getGcGrouperSyncMemberDao

getGcGrouperSyncMembershipDao

getGcGrouperSyncDao