|
||||||||||
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.audit.AuditEntry
public class AuditEntry
represents a user audit record. This is one unit of work that could contain multiple operations.
Field Summary | |
---|---|
static java.lang.String |
FIELD_ACT_AS_MEMBER_ID
constant for field name for: actAsMemberId |
static java.lang.String |
FIELD_AUDIT_TYPE_ID
constant for field name for: auditTypeId |
static java.lang.String |
FIELD_CONTEXT_ID
constant for field name for: contextId |
static java.lang.String |
FIELD_CREATED_ON_DB
constant for field name for: createdOnDb |
static java.lang.String |
FIELD_DESCRIPTION
constant for field name for: description |
static java.lang.String |
FIELD_DURATION_MICROSECONDS
constant for field name for: durationMicroseconds |
static java.lang.String |
FIELD_ENV_NAME
constant for field name for: envName |
static java.lang.String |
FIELD_GROUPER_ENGINE
constant for field name for: grouperEngine |
static java.lang.String |
FIELD_GROUPER_VERSION
constant for field name for: grouperVersion |
static java.lang.String |
FIELD_ID
constant for field name for: id |
static java.lang.String |
FIELD_INT01
constant for field name for: int01 |
static java.lang.String |
FIELD_INT02
constant for field name for: int02 |
static java.lang.String |
FIELD_INT03
constant for field name for: int03 |
static java.lang.String |
FIELD_INT04
constant for field name for: int04 |
static java.lang.String |
FIELD_INT05
constant for field name for: int05 |
static java.lang.String |
FIELD_LAST_UPDATED_DB
constant for field name for: lastUpdatedDb |
static java.lang.String |
FIELD_LOGGED_IN_MEMBER_ID
constant for field name for: loggedInMemberId |
static java.lang.String |
FIELD_QUERY_COUNT
constant for field name for: queryCount |
static java.lang.String |
FIELD_SERVER_HOST
constant for field name for: serverHost |
static java.lang.String |
FIELD_SERVER_USER_NAME
constant for field name for: serverUserName |
static java.lang.String |
FIELD_STRING01
constant for field name for: string01 |
static java.lang.String |
FIELD_STRING02
constant for field name for: string02 |
static java.lang.String |
FIELD_STRING03
constant for field name for: string03 |
static java.lang.String |
FIELD_STRING04
constant for field name for: string04 |
static java.lang.String |
FIELD_STRING05
constant for field name for: string05 |
static java.lang.String |
FIELD_STRING06
constant for field name for: string06 |
static java.lang.String |
FIELD_STRING07
constant for field name for: string07 |
static java.lang.String |
FIELD_STRING08
constant for field name for: string08 |
static java.lang.String |
FIELD_USER_IP_ADDRESS
constant for field name for: userIpAddress |
static java.lang.String |
TABLE_GROUPER_AUDIT_ENTRY
name of the grouper audit entry table in the db |
Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI |
---|
COLUMN_HIBERNATE_VERSION_NUMBER, FIELD_DB_VERSION, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER |
Fields inherited from interface org.hibernate.classic.Lifecycle |
---|
NO_VETO, VETO |
Constructor Summary | |
---|---|
AuditEntry()
construct |
|
AuditEntry(AuditTypeIdentifier auditTypeIdentifier,
java.lang.String... labelNamesAndValues)
construct, assign an id |
Method Summary | |
---|---|
void |
assignIntValue(AuditType auditType,
java.lang.String label,
java.lang.Long value)
|
void |
assignStringValue(AuditType auditType,
java.lang.String label,
java.lang.String value)
|
GrouperAPI |
clone()
deep clone the fields in this object |
boolean |
equalsDeep(AuditEntry auditEntry)
see if one audit type is the same as another (not looking at last update, id, etc) |
java.lang.String |
getActAsMemberId()
member uuid of the user being acted as |
AuditType |
getAuditType()
get the audit type, it better be there |
java.lang.String |
getAuditTypeId()
foreign key to the type of audit entry this is |
java.lang.String |
getContextId()
context id ties multiple db changes |
java.sql.Timestamp |
getCreatedOn()
when created |
java.lang.Long |
getCreatedOnDb()
when created |
java.lang.String |
getDescription()
description of what happened in paragraph form |
long |
getDurationMicroseconds()
number of nanos that the duration of the context took |
java.lang.String |
getEnvName()
env label from grouper.properties |
java.lang.String |
getGrouperEngine()
WS, UI, loader, GSH, etc |
java.lang.String |
getGrouperVersion()
version of the grouper API, e.g. 1.4.0 |
java.lang.String |
getId()
primary key uuid of this record |
java.lang.Long |
getInt01()
misc integer field 1 |
java.lang.Long |
getInt02()
misc integer field 2 |
java.lang.Long |
getInt03()
misc integer field 3 |
java.lang.Long |
getInt04()
misc integer field 4 |
java.lang.Long |
getInt05()
misc integer field 5 |
java.sql.Timestamp |
getLastUpdated()
when last updated |
java.lang.Long |
getLastUpdatedDb()
when last updated |
java.lang.String |
getLoggedInMemberId()
member uuid of the user logged in to grouper ui or ws etc |
int |
getQueryCount()
number of queries (count be db or otherwise) |
java.lang.String |
getServerHost()
host of the server that executed the transaction |
java.lang.String |
getServerUserName()
Username of the OS user running the API. |
java.lang.String |
getString01()
misc field 1 |
java.lang.String |
getString02()
misc field 2 |
java.lang.String |
getString03()
misc field 3 |
java.lang.String |
getString04()
misc field 4 |
java.lang.String |
getString05()
misc field 5 |
java.lang.String |
getString06()
misc field 6 |
java.lang.String |
getString07()
misc field 7 |
java.lang.String |
getString08()
misc field 8 |
java.lang.String |
getUserIpAddress()
ip address of user (from WS or UI etc) |
void |
onPreSave(HibernateSession hibernateSession)
before a save (insert) occurs |
void |
onPreUpdate(HibernateSession hibernateSession)
before an update occurs |
java.lang.String |
retrieveStringValue(AuditType auditType,
java.lang.String label)
get a string value from name value pairs |
java.lang.String |
retrieveStringValue(java.lang.String label)
get a string value from name value pairs |
void |
saveOrUpdate(boolean copyContextData)
save or update this object |
void |
setActAsMemberId(java.lang.String actAsMemberUuid1)
member uuid of the user being acted as |
void |
setAuditTypeId(java.lang.String auditTypeId1)
foreign key to the type of audit entry this is |
void |
setContextId(java.lang.String contextId1)
context id ties multiple db changes |
void |
setCreatedOn(java.sql.Timestamp createdOn1)
when created |
void |
setCreatedOnDb(java.lang.Long createdOn1)
when created |
void |
setDescription(java.lang.String description1)
description of what happened in paragraph form |
void |
setDurationMicroseconds(long durationMicroseconds1)
number of nanos that the duration of the context took |
void |
setEnvName(java.lang.String envLabel1)
env label from grouper.properties |
void |
setGrouperEngine(java.lang.String grouperSystem1)
WS, UI, loader, GSH, etc |
void |
setGrouperVersion(java.lang.String grouperVersion1)
version of the grouper API, e.g. 1.4.0 |
void |
setId(java.lang.String id1)
primary key uuid of this record |
void |
setInt01(java.lang.Long int01a)
misc integer field 1 |
void |
setInt02(java.lang.Long int02a)
misc integer field 2 |
void |
setInt03(java.lang.Long int03a)
misc integer field 3 |
void |
setInt04(java.lang.Long int04a)
misc integer field 4 |
void |
setInt05(java.lang.Long int05a)
misc integer field 5 |
void |
setLastUpdated(java.sql.Timestamp lastUpdated1)
when last updated |
void |
setLastUpdatedDb(java.lang.Long lastUpdated1)
when last updated |
void |
setLoggedInMemberId(java.lang.String loggedInMemberUuid)
member uuid of the user logged in to grouper ui or ws etc |
void |
setQueryCount(int queryCount)
number of queries (count be db or otherwise) |
void |
setServerHost(java.lang.String serverHost1)
host of the server that executed the transaction |
void |
setServerUserName(java.lang.String serverUserName1)
Username of the OS user running the API. |
void |
setString01(java.lang.String string01a)
misc field 1 |
void |
setString02(java.lang.String string02a)
misc field 2 |
void |
setString03(java.lang.String string03a)
misc field 3 |
void |
setString04(java.lang.String string04a)
misc field 4 |
void |
setString05(java.lang.String string05a)
misc field 5 |
void |
setString06(java.lang.String string06a)
misc field 6 |
void |
setString07(java.lang.String string07a)
misc field 7 |
void |
setString08(java.lang.String string08a)
misc field 8 |
void |
setUserIpAddress(java.lang.String userIpAddress1)
ip address of user (from WS or UI etc) |
java.lang.String |
toString()
|
java.lang.String |
toStringDeep()
the string repre |
java.lang.String |
toStringReport(boolean extended)
|
void |
truncate()
make sure this object will fit in the DB |
void |
xmlCopyBusinessPropertiesToExisting(AuditEntry existingRecord)
copy business (non update) properties to an existing record |
boolean |
xmlDifferentBusinessProperties(AuditEntry other)
see if the non update cols are different (e.g. name) |
boolean |
xmlDifferentUpdateProperties(AuditEntry other)
see if the update cols are different (e.g. last updated) |
java.lang.String |
xmlGetId()
set id key in db |
XmlImportable<AuditEntry> |
xmlRetrieveByIdOrKey()
retrieve from db by id or key. |
AuditEntry |
xmlSaveBusinessProperties(AuditEntry 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 |
XmlExportAuditEntry |
xmlToExportAuditEntry(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 |
---|
dbVersion, dbVersionClear, dbVersionDifferentFields, dbVersionIsDifferent, dbVersionReset, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onPostDelete, onPostSave, onPostUpdate, onPreDelete, onSave, onUpdate, setHibernateVersionNumber |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FIELD_ACT_AS_MEMBER_ID
public static final java.lang.String FIELD_AUDIT_TYPE_ID
public static final java.lang.String FIELD_CONTEXT_ID
public static final java.lang.String FIELD_CREATED_ON_DB
public static final java.lang.String FIELD_DESCRIPTION
public static final java.lang.String FIELD_DURATION_MICROSECONDS
public static final java.lang.String FIELD_ENV_NAME
public static final java.lang.String FIELD_GROUPER_ENGINE
public static final java.lang.String FIELD_GROUPER_VERSION
public static final java.lang.String FIELD_ID
public static final java.lang.String FIELD_INT01
public static final java.lang.String FIELD_INT02
public static final java.lang.String FIELD_INT03
public static final java.lang.String FIELD_INT04
public static final java.lang.String FIELD_INT05
public static final java.lang.String FIELD_LAST_UPDATED_DB
public static final java.lang.String FIELD_LOGGED_IN_MEMBER_ID
public static final java.lang.String FIELD_QUERY_COUNT
public static final java.lang.String FIELD_SERVER_HOST
public static final java.lang.String FIELD_SERVER_USER_NAME
public static final java.lang.String FIELD_STRING01
public static final java.lang.String FIELD_STRING02
public static final java.lang.String FIELD_STRING03
public static final java.lang.String FIELD_STRING04
public static final java.lang.String FIELD_STRING05
public static final java.lang.String FIELD_STRING06
public static final java.lang.String FIELD_STRING07
public static final java.lang.String FIELD_STRING08
public static final java.lang.String FIELD_USER_IP_ADDRESS
public static final java.lang.String TABLE_GROUPER_AUDIT_ENTRY
Constructor Detail |
---|
public AuditEntry()
public AuditEntry(AuditTypeIdentifier auditTypeIdentifier, java.lang.String... labelNamesAndValues)
auditTypeIdentifier
- points to audit typelabelNamesAndValues
- alternate label name and valueMethod Detail |
---|
public boolean equalsDeep(AuditEntry auditEntry)
auditEntry
-
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public AuditType getAuditType()
public java.lang.String toStringReport(boolean extended)
extended
- if all fields should be printed
public void saveOrUpdate(boolean copyContextData)
copyContextData
- public void assignStringValue(AuditType auditType, java.lang.String label, java.lang.String value)
auditType
- label
- value
- public void assignIntValue(AuditType auditType, java.lang.String label, java.lang.Long value)
auditType
- label
- value
- public java.lang.String getAuditTypeId()
public void setAuditTypeId(java.lang.String auditTypeId1)
auditTypeId1
- public java.lang.String getId()
public void setId(java.lang.String id1)
id1
- public java.lang.String getActAsMemberId()
public java.lang.String getContextId()
public java.lang.String getLoggedInMemberId()
public java.lang.String getServerHost()
public java.lang.String getUserIpAddress()
public void setActAsMemberId(java.lang.String actAsMemberUuid1)
actAsMemberUuid1
- public void setContextId(java.lang.String contextId1)
contextId1
- public void setLoggedInMemberId(java.lang.String loggedInMemberUuid)
loggedInMemberUuid
- public void setServerHost(java.lang.String serverHost1)
serverHost1
- public void setUserIpAddress(java.lang.String userIpAddress1)
userIpAddress1
- public java.lang.String getEnvName()
public void setEnvName(java.lang.String envLabel1)
envLabel1
- public java.lang.String getGrouperEngine()
public void setGrouperEngine(java.lang.String grouperSystem1)
grouperSystem1
- public java.lang.String getString01()
public void setString01(java.lang.String string01a)
string01a
- public java.lang.String getString02()
public void setString02(java.lang.String string02a)
string02a
- public java.lang.String getString03()
public void setString03(java.lang.String string03a)
string03a
- public java.lang.String getString04()
public void setString04(java.lang.String string04a)
string04a
- public java.lang.String getString05()
public void setString05(java.lang.String string05a)
string05a
- public java.lang.String getString06()
public void setString06(java.lang.String string06a)
string06a
- public java.lang.String getString07()
public void setString07(java.lang.String string07a)
string07a
- public java.lang.String getString08()
public void setString08(java.lang.String string08a)
string08a
- public java.lang.Long getInt01()
public void setInt01(java.lang.Long int01a)
int01a
- public java.lang.Long getInt02()
public void setInt02(java.lang.Long int02a)
int02a
- public java.lang.Long getInt03()
public void setInt03(java.lang.Long int03a)
int03a
- public java.lang.Long getInt04()
public void setInt04(java.lang.Long int04a)
int04a
- public java.lang.Long getInt05()
public void setInt05(java.lang.Long int05a)
int05a
- public java.lang.String getDescription()
public void setDescription(java.lang.String description1)
description1
- public java.sql.Timestamp getCreatedOn()
public java.sql.Timestamp getLastUpdated()
public java.lang.Long getCreatedOnDb()
public java.lang.Long getLastUpdatedDb()
public void setCreatedOn(java.sql.Timestamp createdOn1)
createdOn1
- public void setLastUpdated(java.sql.Timestamp lastUpdated1)
lastUpdated1
- public void truncate()
public java.lang.String getGrouperVersion()
public void setGrouperVersion(java.lang.String grouperVersion1)
grouperVersion1
- public GrouperAPI clone()
GrouperAPI
clone
in interface GrouperCloneable
clone
in class GrouperAPI
GrouperAPI.clone()
public long getDurationMicroseconds()
public void setDurationMicroseconds(long durationMicroseconds1)
durationMicroseconds1
- public void onPreSave(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreSave
in interface HibGrouperLifecycle
onPreSave
in class GrouperAPI
GrouperAPI.onPreSave(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public void onPreUpdate(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreUpdate
in interface HibGrouperLifecycle
onPreUpdate
in class GrouperAPI
GrouperAPI.onPreUpdate(edu.internet2.middleware.grouper.hibernate.HibernateSession)
public int getQueryCount()
public void setQueryCount(int queryCount)
queryCount
- public java.lang.String getServerUserName()
public void setServerUserName(java.lang.String serverUserName1)
serverUserName1
- public void setCreatedOnDb(java.lang.Long createdOn1)
createdOn1
- public void setLastUpdatedDb(java.lang.Long lastUpdated1)
lastUpdated1
- public java.lang.String toStringDeep()
public XmlImportable<AuditEntry> xmlRetrieveByIdOrKey()
XmlImportable
xmlRetrieveByIdOrKey
in interface XmlImportable<AuditEntry>
XmlImportable.xmlRetrieveByIdOrKey()
public void xmlCopyBusinessPropertiesToExisting(AuditEntry existingRecord)
XmlImportableBase
xmlCopyBusinessPropertiesToExisting
in interface XmlImportableBase<AuditEntry>
XmlImportableBase.xmlCopyBusinessPropertiesToExisting(java.lang.Object)
public boolean xmlDifferentBusinessProperties(AuditEntry other)
XmlImportableBase
xmlDifferentBusinessProperties
in interface XmlImportableBase<AuditEntry>
other
- the one to compare with
XmlImportableBase.xmlDifferentBusinessProperties(java.lang.Object)
public boolean xmlDifferentUpdateProperties(AuditEntry other)
XmlImportableBase
xmlDifferentUpdateProperties
in interface XmlImportableBase<AuditEntry>
other
- the one to compare with
XmlImportableBase.xmlDifferentUpdateProperties(java.lang.Object)
public java.lang.String xmlGetId()
XmlImportableBase
xmlGetId
in interface XmlImportableBase<AuditEntry>
XmlImportableBase.xmlGetId()
public AuditEntry xmlSaveBusinessProperties(AuditEntry existingRecord)
XmlImportableBase
xmlSaveBusinessProperties
in interface XmlImportableBase<AuditEntry>
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 xmlSaveUpdateProperties()
XmlImportableBase
xmlSaveUpdateProperties
in interface XmlImportableBase<AuditEntry>
XmlImportableBase.xmlSaveUpdateProperties()
public void xmlSetId(java.lang.String theId)
XmlImportableBase
xmlSetId
in interface XmlImportableBase<AuditEntry>
XmlImportableBase.xmlSetId(java.lang.String)
public XmlExportAuditEntry xmlToExportAuditEntry(GrouperVersion grouperVersion)
grouperVersion
-
public java.lang.String retrieveStringValue(java.lang.String label)
label
-
public java.lang.String retrieveStringValue(AuditType auditType, java.lang.String label)
auditType
- label
-
public java.lang.String xmlToString()
XmlImportableBase
xmlToString
in interface XmlImportableBase<AuditEntry>
XmlImportableBase.xmlToString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |