edu.internet2.middleware.grouper.externalSubjects
Class ExternalSubjectAttribute

java.lang.Object
  extended by edu.internet2.middleware.grouper.GrouperAPI
      extended by edu.internet2.middleware.grouper.externalSubjects.ExternalSubjectAttribute
All Implemented Interfaces:
HibGrouperLifecycle, Hib3GrouperVersioned, GrouperCloneable, GrouperHasContext, GrouperUtil.FieldValuable, Serializable, org.hibernate.classic.Lifecycle

public class ExternalSubjectAttribute
extends GrouperAPI
implements GrouperHasContext, Hib3GrouperVersioned

attribute on an external subject, configured in the grouper.properties

Author:
mchyzer
See Also:
Serialized Form

Field Summary
static String COLUMN_ATTRIBUTE_SYSTEM_NAME
          column name for attribute system name
static String COLUMN_ATTRIBUTE_VALUE
          column name for attribute value
static String COLUMN_CONTEXT_ID
          column name for context id
static String COLUMN_CREATE_TIME
          column name for create time
static String COLUMN_CREATOR_MEMBER_ID
          column name for creator member id
static String COLUMN_MODIFIER_MEMBER_ID
          column name for modifier member id
static String COLUMN_MODIFY_TIME
          column name for modify time
static String COLUMN_SUBJECT_UUID
          column name for subject uuid
static String COLUMN_UUID
          column name for uuid
static String FIELD_ATTRIBUTE_SYSTEM_NAME
          constant for field name for: attributeSystemName
static String FIELD_ATTRIBUTE_VALUE
          constant for field name for: attributeValue
static String FIELD_CONTEXT_ID
          constant for field name for: contextId
static String FIELD_CREATE_TIME
          constant for field name for: createTime
static String FIELD_CREATOR_MEMBER_ID
          constant for field name for: creatorMemberId
static String FIELD_MODIFIER_MEMBER_ID
          constant for field name for: modifierMemberId
static String FIELD_MODIFY_TIME
          constant for field name for: modifyTime
static String FIELD_SUBJECT_UUID
          constant for field name for: subjectUuid
static String FIELD_UUID
          constant for field name for: uuid
static String TABLE_GROUPER_EXT_SUBJ_ATTR
          table name for external subject attributes
 
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
ExternalSubjectAttribute()
           
 
Method Summary
static void assertValidAttribute(String attributeName)
          assert that the attribute name is valid
 ExternalSubjectAttribute clone()
          deep clone the fields in this object
 String getAttributeSystemName()
          system name of the attributes
 String getAttributeValue()
          value of attribute
 String getContextId()
          contextId links to audit tables
 Date getCreateTime()
          Get creation time for this subject.
 long getCreateTimeDb()
           
 String getCreatorMemberId()
           
 String getModifierMemberId()
           
 Date getModifyTime()
          Get modify time for this subject.
 long getModifyTimeDb()
           
 String getSubjectUuid()
          subject uuid foreign key to subject table
 String getUuid()
          uuid of the attribute
 void onPreSave(HibernateSession hibernateSession)
          before a save (insert) occurs
 void onPreUpdate(HibernateSession hibernateSession)
          before an update occurs
 void setAttributeSystemName(String attributeSystemName1)
          system name of the attributes
 void setAttributeValue(String attributeValue1)
          value of the attribute
 void setContextId(String contextId1)
          contextId links to audit tables
 void setCreateTimeDb(long createTime1)
          create time
 void setCreatorMemberId(String creatorMemberId1)
          member id of creator
 void setModifierMemberId(String modifierMemberId1)
          member id of modifier
 void setModifyTimeDb(long modifyTime1)
          last time modified
 void setSubjectUuid(String subjectUuid1)
          subject uuid foreign key to subject table
 void setUuid(String uuid1)
          uuid of the attribute
 void store(ExternalSubject externalSubject)
          store this object to the DB.
 String toString()
           
static boolean validAttribute(String attributeName, boolean errorOnNotfound)
          assert that the attribute name is valid
 
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

COLUMN_CREATE_TIME

public static final String COLUMN_CREATE_TIME
column name for create time

See Also:
Constant Field Values

COLUMN_CREATOR_MEMBER_ID

public static final String COLUMN_CREATOR_MEMBER_ID
column name for creator member id

See Also:
Constant Field Values

COLUMN_MODIFIER_MEMBER_ID

public static final String COLUMN_MODIFIER_MEMBER_ID
column name for modifier member id

See Also:
Constant Field Values

COLUMN_MODIFY_TIME

public static final String COLUMN_MODIFY_TIME
column name for modify time

See Also:
Constant Field Values

TABLE_GROUPER_EXT_SUBJ_ATTR

public static final String TABLE_GROUPER_EXT_SUBJ_ATTR
table name for external subject attributes

See Also:
Constant Field Values

COLUMN_CONTEXT_ID

public static final String COLUMN_CONTEXT_ID
column name for context id

See Also:
Constant Field Values

COLUMN_ATTRIBUTE_SYSTEM_NAME

public static final String COLUMN_ATTRIBUTE_SYSTEM_NAME
column name for attribute system name

See Also:
Constant Field Values

COLUMN_ATTRIBUTE_VALUE

public static final String COLUMN_ATTRIBUTE_VALUE
column name for attribute value

See Also:
Constant Field Values

COLUMN_SUBJECT_UUID

public static final String COLUMN_SUBJECT_UUID
column name for subject uuid

See Also:
Constant Field Values

COLUMN_UUID

public static final String COLUMN_UUID
column name for uuid

See Also:
Constant Field Values

FIELD_ATTRIBUTE_SYSTEM_NAME

public static final String FIELD_ATTRIBUTE_SYSTEM_NAME
constant for field name for: attributeSystemName

See Also:
Constant Field Values

FIELD_ATTRIBUTE_VALUE

public static final String FIELD_ATTRIBUTE_VALUE
constant for field name for: attributeValue

See Also:
Constant Field Values

FIELD_CONTEXT_ID

public static final String FIELD_CONTEXT_ID
constant for field name for: contextId

See Also:
Constant Field Values

FIELD_CREATE_TIME

public static final String FIELD_CREATE_TIME
constant for field name for: createTime

See Also:
Constant Field Values

FIELD_CREATOR_MEMBER_ID

public static final String FIELD_CREATOR_MEMBER_ID
constant for field name for: creatorMemberId

See Also:
Constant Field Values

FIELD_MODIFIER_MEMBER_ID

public static final String FIELD_MODIFIER_MEMBER_ID
constant for field name for: modifierMemberId

See Also:
Constant Field Values

FIELD_MODIFY_TIME

public static final String FIELD_MODIFY_TIME
constant for field name for: modifyTime

See Also:
Constant Field Values

FIELD_SUBJECT_UUID

public static final String FIELD_SUBJECT_UUID
constant for field name for: subjectUuid

See Also:
Constant Field Values

FIELD_UUID

public static final String FIELD_UUID
constant for field name for: uuid

See Also:
Constant Field Values
Constructor Detail

ExternalSubjectAttribute

public ExternalSubjectAttribute()
Method Detail

getSubjectUuid

public String getSubjectUuid()
subject uuid foreign key to subject table

Returns:
the uuid

setSubjectUuid

public void setSubjectUuid(String subjectUuid1)
subject uuid foreign key to subject table

Parameters:
subjectUuid1 -

getAttributeSystemName

public String getAttributeSystemName()
system name of the attributes

Returns:
system name

setAttributeSystemName

public void setAttributeSystemName(String attributeSystemName1)
system name of the attributes

Parameters:
attributeSystemName1 -

getAttributeValue

public String getAttributeValue()
value of attribute

Returns:
value

setAttributeValue

public void setAttributeValue(String attributeValue1)
value of the attribute

Parameters:
attributeValue1 -

getUuid

public String getUuid()
uuid of the attribute

Returns:
uuid

setUuid

public void setUuid(String uuid1)
uuid of the attribute

Parameters:
uuid1 -

clone

public ExternalSubjectAttribute clone()
Description copied from class: GrouperAPI
deep clone the fields in this object

Specified by:
clone in interface GrouperCloneable
Specified by:
clone in class GrouperAPI
Returns:
the clone of the object
See Also:
GrouperAPI.clone()

getContextId

public String getContextId()
contextId links to audit tables

Returns:
context id

setContextId

public void setContextId(String contextId1)
contextId links to audit tables

Specified by:
setContextId in interface GrouperHasContext
Parameters:
contextId1 -

getCreateTime

public Date getCreateTime()
Get creation time for this subject.

Returns:
Date that this subject was created.

getCreateTimeDb

public long getCreateTimeDb()
Returns:
create time

getCreatorMemberId

public String getCreatorMemberId()
Returns:
creator

getModifierMemberId

public String getModifierMemberId()
Returns:
the modifier member id

getModifyTime

public Date getModifyTime()
Get modify time for this subject.

Returns:
Date that this subject was created.

getModifyTimeDb

public long getModifyTimeDb()
Returns:
modify time

setCreateTimeDb

public void setCreateTimeDb(long createTime1)
create time

Parameters:
createTime1 -

setCreatorMemberId

public void setCreatorMemberId(String creatorMemberId1)
member id of creator

Parameters:
creatorMemberId1 -

setModifierMemberId

public void setModifierMemberId(String modifierMemberId1)
member id of modifier

Parameters:
modifierMemberId1 -

setModifyTimeDb

public void setModifyTimeDb(long modifyTime1)
last time modified

Parameters:
modifyTime1 -

onPreSave

public void onPreSave(HibernateSession hibernateSession)
Description copied from interface: HibGrouperLifecycle
before a save (insert) occurs

Specified by:
onPreSave in interface HibGrouperLifecycle
Overrides:
onPreSave in class GrouperAPI
See Also:
GrouperAPI.onPreSave(HibernateSession)

onPreUpdate

public void onPreUpdate(HibernateSession hibernateSession)
Description copied from interface: HibGrouperLifecycle
before an update occurs

Specified by:
onPreUpdate in interface HibGrouperLifecycle
Overrides:
onPreUpdate in class GrouperAPI
See Also:
GrouperAPI.onPreUpdate(HibernateSession)

assertValidAttribute

public static void assertValidAttribute(String attributeName)
assert that the attribute name is valid

Parameters:
attributeName -

validAttribute

public static boolean validAttribute(String attributeName,
                                     boolean errorOnNotfound)
assert that the attribute name is valid

Parameters:
attributeName -
errorOnNotfound -
Returns:
if found

store

public void store(ExternalSubject externalSubject)
store this object to the DB.

Parameters:
externalSubject - reference back to owner

toString

public String toString()
Overrides:
toString in class Object
See Also:
Object.toString()