|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.grouper.GrouperAPI
edu.internet2.middleware.grouper.Composite
public class Composite
A composite membership definition within the Groups Registry. A composite group is composed of two groups and a set operator (stored in grouper_composites table) (e.g. union, intersection, etc). A composite group has no immediate members. All subjects in a composite group are effective members.
| Field Summary | |
|---|---|
static java.lang.String |
COLUMN_ID
id col in db |
static java.lang.String |
COLUMN_OLD_ID
old id col for id conversion |
static java.lang.String |
COLUMN_OLD_UUID
old uuid id col for id conversion |
static java.lang.String |
COLUMN_UUID
uuid col in db |
static java.lang.String |
FIELD_CREATE_TIME
constant for field name for: createTime |
static java.lang.String |
FIELD_CREATOR_UUID
constant for field name for: creatorUUID |
static java.lang.String |
FIELD_DB_VERSION
constant for field name for: dbVersion |
static java.lang.String |
FIELD_FACTOR_OWNER_UUID
constant for field name for: factorOwnerUUID |
static java.lang.String |
FIELD_LEFT_FACTOR_UUID
constant for field name for: leftFactorUUID |
static java.lang.String |
FIELD_RIGHT_FACTOR_UUID
constant for field name for: rightFactorUUID |
static java.lang.String |
FIELD_TYPE
constant for field name for: type |
static java.lang.String |
FIELD_UUID
constant for field name for: uuid |
static java.lang.String |
TABLE_GROUPER_COMPOSITES
table for composites |
| Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI |
|---|
COLUMN_HIBERNATE_VERSION_NUMBER, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER |
| Fields inherited from interface org.hibernate.classic.Lifecycle |
|---|
NO_VETO, VETO |
| Constructor Summary | |
|---|---|
Composite()
|
|
| Method Summary | |
|---|---|
Composite |
clone()
deep clone the fields in this object |
Composite |
dbVersion()
save the state when retrieving from DB |
java.util.Set<java.lang.String> |
dbVersionDifferentFields()
note, these are massaged so that name, extension, etc look like normal fields. |
void |
dbVersionReset()
take a snapshot of the data since this is what is in the db |
boolean |
equals(java.lang.Object other)
|
java.lang.String |
getContextId()
context id of the transaction |
long |
getCreateTime()
|
java.lang.String |
getCreatorUuid()
|
java.lang.String |
getFactorOwnerUuid()
|
java.lang.String |
getLeftFactorUuid()
|
Group |
getLeftGroup()
Return this Composite's left factor. |
java.lang.String |
getName()
|
Group |
getOwnerGroup()
Return this Composite's owner. |
java.lang.String |
getRightFactorUuid()
|
Group |
getRightGroup()
Return this Composite's right factor. |
CompositeType |
getType()
Return this composite's type. |
java.lang.String |
getTypeDb()
simple getter for type for db |
java.lang.String |
getUuid()
|
int |
hashCode()
|
static Membership |
internal_createNewCompositeMembershipObject(java.lang.String ownerGroupId,
java.lang.String memberUuid,
java.lang.String viaCompositeId)
|
java.lang.String |
internal_getLeftName()
left name |
java.lang.String |
internal_getOwnerName()
owner name |
java.lang.String |
internal_getRightName()
right name |
void |
onPostDelete(HibernateSession hibernateSession)
after a delete occurs |
void |
onPostSave(HibernateSession hibernateSession)
after a save (insert) occurs |
void |
onPostUpdate(HibernateSession hibernateSession)
after an update occurs |
void |
onPreDelete(HibernateSession hibernateSession)
before a delete (insert) occurs |
void |
onPreSave(HibernateSession hibernateSession)
before a save (insert) occurs |
void |
onPreUpdate(HibernateSession hibernateSession)
before an update occurs |
void |
setContextId(java.lang.String contextId1)
context id of the transaction |
void |
setCreateTime(long createTime)
|
void |
setCreatorUuid(java.lang.String creatorUUID)
|
void |
setFactorOwnerUuid(java.lang.String factorOwnerUUID)
|
void |
setLeftFactorUuid(java.lang.String leftFactorUUID)
|
void |
setRightFactorUuid(java.lang.String rightFactorUUID)
|
void |
setTypeDb(java.lang.String type)
|
void |
setUuid(java.lang.String uuid)
|
void |
store()
store this object to the DB. |
java.lang.String |
toString()
|
java.lang.String |
toStringDto()
|
void |
xmlCopyBusinessPropertiesToExisting(Composite existingRecord)
copy business (non update) properties to an existing record |
boolean |
xmlDifferentBusinessProperties(Composite other)
see if the non update cols are different (e.g. name) |
boolean |
xmlDifferentUpdateProperties(Composite other)
see if the update cols are different (e.g. last updated) |
java.lang.String |
xmlGetId()
set id key in db |
Composite |
xmlRetrieveByIdOrKey()
retrieve from db by id or key. |
Composite |
xmlSaveBusinessProperties(Composite existingRecord)
save the business properties (not update properties) |
void |
xmlSaveUpdateProperties()
save the udpate properties (e.g. last updated). |
void |
xmlSetId(java.lang.String theId)
set id key in db |
XmlExportComposite |
xmlToExportComposite(GrouperVersion grouperVersion)
convert to xml bean for export |
java.lang.String |
xmlToString()
convert to string for log |
| Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI |
|---|
dbVersionClear, dbVersionIsDifferent, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onSave, onUpdate, setHibernateVersionNumber |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String TABLE_GROUPER_COMPOSITES
public static final java.lang.String COLUMN_ID
public static final java.lang.String COLUMN_UUID
public static final java.lang.String COLUMN_OLD_ID
public static final java.lang.String COLUMN_OLD_UUID
public static final java.lang.String FIELD_CREATE_TIME
public static final java.lang.String FIELD_CREATOR_UUID
public static final java.lang.String FIELD_DB_VERSION
public static final java.lang.String FIELD_FACTOR_OWNER_UUID
public static final java.lang.String FIELD_LEFT_FACTOR_UUID
public static final java.lang.String FIELD_RIGHT_FACTOR_UUID
public static final java.lang.String FIELD_TYPE
public static final java.lang.String FIELD_UUID
| Constructor Detail |
|---|
public Composite()
| Method Detail |
|---|
public Group getLeftGroup()
throws GroupNotFoundException
Composite's left factor.
try {
Group left = c.getLeftGroup();
}
catch (GroupNotFoundException eGNF) {
// unable to retrieve group
}
Group.
GroupNotFoundException
public Group getOwnerGroup()
throws GroupNotFoundException
Composite's owner.
try {
Group owner = c.geOwnerGroup();
}
catch (GroupNotFoundException eGNF) {
// unable to retrieve group
}
Group.
GroupNotFoundException
public Group getRightGroup()
throws GroupNotFoundException
Composite's right factor.
try {
Group right = c.getRightGroup();
}
catch (GroupNotFoundException eGNF) {
// unable to retrieve group
}
Group.
GroupNotFoundExceptionpublic CompositeType getType()
CompositeType type = c.getType();
CompositeType of this Composite.public java.lang.String getTypeDb()
public java.lang.String toString()
toString in class java.lang.Objectpublic java.lang.String getName()
public java.lang.String internal_getLeftName()
public java.lang.String internal_getOwnerName()
public java.lang.String internal_getRightName()
public boolean equals(java.lang.Object other)
equals in class java.lang.Objectother -
public long getCreateTime()
public java.lang.String getCreatorUuid()
public java.lang.String getFactorOwnerUuid()
public java.lang.String getLeftFactorUuid()
public java.lang.String getRightFactorUuid()
public java.lang.String getUuid()
public int hashCode()
hashCode in class java.lang.Objectpublic void setCreateTime(long createTime)
createTime - public void setCreatorUuid(java.lang.String creatorUUID)
creatorUUID - public void setFactorOwnerUuid(java.lang.String factorOwnerUUID)
factorOwnerUUID - public void setLeftFactorUuid(java.lang.String leftFactorUUID)
leftFactorUUID - public void setRightFactorUuid(java.lang.String rightFactorUUID)
rightFactorUUID - public void setTypeDb(java.lang.String type)
type - public void setUuid(java.lang.String uuid)
uuid - public java.lang.String toStringDto()
public void onPostDelete(HibernateSession hibernateSession)
HibGrouperLifecycle
onPostDelete in interface HibGrouperLifecycleonPostDelete in class GrouperAPIGrouperAPI.onPostDelete(edu.internet2.middleware.grouper.hibernate.HibernateSession)public void onPostSave(HibernateSession hibernateSession)
HibGrouperLifecycle
onPostSave in interface HibGrouperLifecycleonPostSave in class GrouperAPIGrouperAPI.onPostSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)public void onPostUpdate(HibernateSession hibernateSession)
HibGrouperLifecycle
onPostUpdate in interface HibGrouperLifecycleonPostUpdate in class GrouperAPIGrouperAPI.onPostUpdate(edu.internet2.middleware.grouper.hibernate.HibernateSession)public void onPreDelete(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreDelete in interface HibGrouperLifecycleonPreDelete in class GrouperAPIGrouperAPI.onPreDelete(edu.internet2.middleware.grouper.hibernate.HibernateSession)public void onPreSave(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreSave in interface HibGrouperLifecycleonPreSave in class GrouperAPIGrouperAPI.onPreSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)public void onPreUpdate(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreUpdate in interface HibGrouperLifecycleonPreUpdate in class GrouperAPIGrouperAPI.onPreUpdate(edu.internet2.middleware.grouper.hibernate.HibernateSession)public Composite dbVersion()
dbVersion in class GrouperAPIpublic java.util.Set<java.lang.String> dbVersionDifferentFields()
dbVersionDifferentFields in class GrouperAPIGrouperAPI.dbVersionDifferentFields()public void dbVersionReset()
dbVersionReset in class GrouperAPIpublic Composite clone()
clone in interface GrouperCloneableclone in class GrouperAPIObject.clone()public java.lang.String getContextId()
public void setContextId(java.lang.String contextId1)
setContextId in interface GrouperHasContextcontextId1 -
public static Membership internal_createNewCompositeMembershipObject(java.lang.String ownerGroupId,
java.lang.String memberUuid,
java.lang.String viaCompositeId)
ownerGroupId - memberUuid - viaCompositeId -
public void xmlCopyBusinessPropertiesToExisting(Composite existingRecord)
XmlImportableBase
xmlCopyBusinessPropertiesToExisting in interface XmlImportableBase<Composite>XmlImportableBase.xmlCopyBusinessPropertiesToExisting(java.lang.Object)public boolean xmlDifferentBusinessProperties(Composite other)
XmlImportableBase
xmlDifferentBusinessProperties in interface XmlImportableBase<Composite>other - the one to compare with
XmlImportableBase.xmlDifferentBusinessProperties(java.lang.Object)public boolean xmlDifferentUpdateProperties(Composite other)
XmlImportableBase
xmlDifferentUpdateProperties in interface XmlImportableBase<Composite>other - the one to compare with
XmlImportableBase.xmlDifferentUpdateProperties(java.lang.Object)public Composite xmlRetrieveByIdOrKey()
XmlImportable
xmlRetrieveByIdOrKey in interface XmlImportable<Composite>XmlImportable.xmlRetrieveByIdOrKey()public Composite xmlSaveBusinessProperties(Composite existingRecord)
XmlImportableBase
xmlSaveBusinessProperties in interface XmlImportableBase<Composite>existingRecord - null if insert, the object if exists in DB
generally just copy the hibernate version number, and last updated to the
object and store it
XmlImportableBase.xmlSaveBusinessProperties(java.lang.Object)public void store()
public void xmlSaveUpdateProperties()
XmlImportableBase
xmlSaveUpdateProperties in interface XmlImportableBase<Composite>XmlImportableBase.xmlSaveUpdateProperties()public XmlExportComposite xmlToExportComposite(GrouperVersion grouperVersion)
grouperVersion -
public java.lang.String xmlGetId()
XmlImportableBase
xmlGetId in interface XmlImportableBase<Composite>XmlImportableBase.xmlGetId()public void xmlSetId(java.lang.String theId)
XmlImportableBase
xmlSetId in interface XmlImportableBase<Composite>XmlImportableBase.xmlSetId(java.lang.String)public java.lang.String xmlToString()
XmlImportableBase
xmlToString in interface XmlImportableBase<Composite>XmlImportableBase.xmlToString()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||