|
||||||||||
| 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.externalSubjects.ExternalSubject
public class ExternalSubject
database object for external subject
| Field Summary | |
|---|---|
static java.lang.String |
COLUMN_CONTEXT_ID
column name for context id |
static java.lang.String |
COLUMN_CREATE_TIME
column name for create time |
static java.lang.String |
COLUMN_CREATOR_MEMBER_ID
column name for creator member id |
static java.lang.String |
COLUMN_DESCRIPTION
column name for description |
static java.lang.String |
COLUMN_DISABLED_TIME
column name for disabled time |
static java.lang.String |
COLUMN_EMAIL
column name for email |
static java.lang.String |
COLUMN_ENABLED
column name for enabled |
static java.lang.String |
COLUMN_IDENTIFIER
column name for identifier |
static java.lang.String |
COLUMN_INSTITUTION
column name for institution |
static java.lang.String |
COLUMN_MODIFIER_MEMBER_ID
column name for modifier member id |
static java.lang.String |
COLUMN_MODIFY_TIME
column name for modify time |
static java.lang.String |
COLUMN_NAME
column name for name |
static java.lang.String |
COLUMN_SEARCH_STRING_LOWER
column name for searchStringLower |
static java.lang.String |
COLUMN_UUID
column name for uuid |
static java.lang.String |
COLUMN_VETTED_EMAIL_ADDRESSES
column name for vettedEmailAddresses |
static java.lang.String |
FIELD_CONTEXT_ID
constant for field name for: contextId |
static java.lang.String |
FIELD_CREATE_TIME
constant for field name for: createTime |
static java.lang.String |
FIELD_CREATOR_MEMBER_ID
constant for field name for: creatorMemberId |
static java.lang.String |
FIELD_DESCRIPTION
constant for field name for: description |
static java.lang.String |
FIELD_DISABLED_TIME
constant for field name for: disabledTime |
static java.lang.String |
FIELD_EMAIL
constant for field name for: email |
static java.lang.String |
FIELD_ENABLED
constant for field name for: enabled |
static java.lang.String |
FIELD_IDENTIFIER
constant for field name for: identifier |
static java.lang.String |
FIELD_INSTITUTION
constant for field name for: institution |
static java.lang.String |
FIELD_MODIFIER_MEMBER_ID
constant for field name for: modifierMemberId |
static java.lang.String |
FIELD_MODIFY_TIME
constant for field name for: modifyTime |
static java.lang.String |
FIELD_NAME
constant for field name for: name |
static java.lang.String |
FIELD_SEARCH_STRING_LOWER
constant for field name for: searchStringLower |
static java.lang.String |
FIELD_UUID
constant for field name for: uuid |
static java.lang.String |
FIELD_VETTED_EMAIL_ADDRESSES
constant for field name for: vettedEmailAddresses |
static java.lang.String |
TABLE_GROUPER_EXT_SUBJ
table name for external subjects |
| 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 | |
|---|---|
ExternalSubject()
|
|
| Method Summary | |
|---|---|
void |
addVettedEmailAddress(java.lang.String vettedEmailAddress)
add a vetted email address and store this object if necessary |
boolean |
assignAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
assign an attribute to this subject, change value if already exists, add if not |
ExternalSubject |
clone()
deep clone the fields in this object |
void |
delete()
delete this object from the DB. |
java.lang.String |
getContextId()
contextId links to audit tables |
java.util.Date |
getCreateTime()
Get creation time for this subject. |
long |
getCreateTimeDb()
|
java.lang.String |
getCreatorMemberId()
|
java.lang.String |
getDescription()
description, which is generated from other attributes |
java.util.Date |
getDisabledTime()
when this was disabled, or when it will be disabled, millis from 1970 |
java.lang.Long |
getDisabledTimeDb()
when this was disabled, or when it will be disabled |
java.lang.String |
getEmail()
email address |
java.lang.String |
getEnabledDb()
if this is enabled |
java.lang.String |
getIdentifier()
the thing that the subject uses to login |
java.lang.String |
getInstitution()
institution where the user is from |
java.lang.String |
getModifierMemberId()
|
java.util.Date |
getModifyTime()
Get modify time for this subject. |
long |
getModifyTimeDb()
|
java.lang.String |
getName()
name of subject |
java.lang.String |
getSearchStringLower()
search string to find a subject, in all lower case |
java.lang.String |
getUuid()
uuid for row |
java.lang.String |
getVettedEmailAddresses()
comma separated vetted email addresses |
static int |
internal_daemonCalcFields()
fix enabled and disabled memberships, and return the count of how many were fixed |
static int |
internal_fixDisabled()
fix enabled and disabled memberships, and return the count of how many were fixed |
boolean |
isEnabled()
if this is enabled |
static void |
notifyWatcherAboutRegistration(java.lang.String identifier,
java.lang.String emailAddressToNotify,
java.lang.String emailAddressOfInvitee)
notify watcher about a registration. |
void |
onPreSave(HibernateSession hibernateSession)
before a save (insert) occurs |
void |
onPreUpdate(HibernateSession hibernateSession)
before an update occurs |
boolean |
removeAttribute(java.lang.String attributeName)
remove an attribute |
ExternalSubjectAttribute |
retrieveAttribute(java.lang.String attributeName,
boolean exceptionIfNotFound)
get an attributes for this subject |
java.util.Set<ExternalSubjectAttribute> |
retrieveAttributes()
get all attributes for this subject |
java.lang.String |
retrieveFieldValue(java.lang.String fieldOrAttributeName)
get the value by field name or attribute |
void |
setContextId(java.lang.String contextId1)
contextId links to audit tables |
void |
setCreateTimeDb(long createTime1)
create time |
void |
setCreatorMemberId(java.lang.String creatorMemberId1)
member id of creator |
void |
setDescription(java.lang.String description1)
description, which is generated from other attributes |
void |
setDisabledTime(java.util.Date theDisabledTime1)
when this was disabled, or when it will be disabled, millis from 1970 |
void |
setDisabledTimeDb(java.lang.Long disabledTime1)
when this was disabled, or when it will be disabled |
void |
setEmail(java.lang.String email1)
email address |
void |
setEnabled(boolean enabled1)
if this is enabled |
void |
setEnabledDb(java.lang.String enabled1)
if this is enabled, T or F |
void |
setIdentifier(java.lang.String identifier1)
the thing that the subject uses to login |
void |
setInstitution(java.lang.String institution1)
institution where the user is from |
void |
setModifierMemberId(java.lang.String modifierMemberId1)
member id of modifier |
void |
setModifyTimeDb(long modifyTime1)
last time modified |
void |
setName(java.lang.String name1)
name of subject |
void |
setSearchStringLower(java.lang.String searchStringLower1)
search string to find a subject, in all lower case |
void |
setUuid(java.lang.String uuid1)
uuid for row |
void |
setVettedEmailAddresses(java.lang.String vettedEmailAddresses1)
comma separated vetted email addresses |
static java.lang.String |
sourceId()
source id for external subjects |
static java.lang.String |
sourceName()
source name for external subjects |
void |
store()
store this object to the DB. |
void |
store(java.util.Set<ExternalSubjectAttribute> externalSubjectAttributes,
java.lang.String externalSubjectInviteName,
boolean validateAttributes,
boolean autoaddGroups,
boolean fromRecalcDaemon)
store this object to the DB. |
static boolean |
subjectCanEditExternalUser(edu.internet2.middleware.subject.Subject subject)
see if someone is allowed to edit, cache for 1 minute |
java.lang.String |
toString()
|
void |
validateIdentifier()
validate that the identifier is ok, based on grouper.properties |
| 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 TABLE_GROUPER_EXT_SUBJ
public static final java.lang.String COLUMN_CONTEXT_ID
public static final java.lang.String COLUMN_DESCRIPTION
public static final java.lang.String COLUMN_DISABLED_TIME
public static final java.lang.String COLUMN_EMAIL
public static final java.lang.String COLUMN_ENABLED
public static final java.lang.String COLUMN_IDENTIFIER
public static final java.lang.String COLUMN_INSTITUTION
public static final java.lang.String COLUMN_NAME
public static final java.lang.String COLUMN_SEARCH_STRING_LOWER
public static final java.lang.String COLUMN_VETTED_EMAIL_ADDRESSES
public static final java.lang.String COLUMN_UUID
public static final java.lang.String COLUMN_CREATE_TIME
public static final java.lang.String COLUMN_CREATOR_MEMBER_ID
public static final java.lang.String COLUMN_MODIFY_TIME
public static final java.lang.String COLUMN_MODIFIER_MEMBER_ID
public static final java.lang.String FIELD_CONTEXT_ID
public static final java.lang.String FIELD_CREATE_TIME
public static final java.lang.String FIELD_CREATOR_MEMBER_ID
public static final java.lang.String FIELD_DESCRIPTION
public static final java.lang.String FIELD_DISABLED_TIME
public static final java.lang.String FIELD_EMAIL
public static final java.lang.String FIELD_ENABLED
public static final java.lang.String FIELD_IDENTIFIER
public static final java.lang.String FIELD_INSTITUTION
public static final java.lang.String FIELD_MODIFIER_MEMBER_ID
public static final java.lang.String FIELD_MODIFY_TIME
public static final java.lang.String FIELD_NAME
public static final java.lang.String FIELD_SEARCH_STRING_LOWER
public static final java.lang.String FIELD_VETTED_EMAIL_ADDRESSES
public static final java.lang.String FIELD_UUID
| Constructor Detail |
|---|
public ExternalSubject()
| Method Detail |
|---|
public java.lang.String getVettedEmailAddresses()
public void setVettedEmailAddresses(java.lang.String vettedEmailAddresses1)
vettedEmailAddresses1 -
public static void notifyWatcherAboutRegistration(java.lang.String identifier,
java.lang.String emailAddressToNotify,
java.lang.String emailAddressOfInvitee)
identifier - emailAddressToNotify - emailAddressOfInvitee - public void addVettedEmailAddress(java.lang.String vettedEmailAddress)
vettedEmailAddress - public java.lang.Long getDisabledTimeDb()
public void setDisabledTimeDb(java.lang.Long disabledTime1)
disabledTime1 - public java.util.Date getDisabledTime()
public void setDisabledTime(java.util.Date theDisabledTime1)
theDisabledTime1 - public boolean isEnabled()
public java.lang.String getEnabledDb()
public void setEnabled(boolean enabled1)
enabled1 - public void setEnabledDb(java.lang.String enabled1)
enabled1 - public java.lang.String getContextId()
public java.lang.String getSearchStringLower()
public void setSearchStringLower(java.lang.String searchStringLower1)
searchStringLower1 - public java.lang.String getUuid()
public void setUuid(java.lang.String uuid1)
uuid1 - public java.lang.String getIdentifier()
public void setIdentifier(java.lang.String identifier1)
identifier1 - public java.lang.String getName()
public void setName(java.lang.String name1)
name1 - public java.lang.String getDescription()
public void setDescription(java.lang.String description1)
description1 - public java.lang.String getEmail()
public void setEmail(java.lang.String email1)
email1 - public java.lang.String getInstitution()
public void setInstitution(java.lang.String institution1)
institution1 - public ExternalSubject clone()
clone in interface GrouperCloneableclone in class GrouperAPIObject.clone()public void setContextId(java.lang.String contextId1)
setContextId in interface GrouperHasContextcontextId1 - public java.util.Date getCreateTime()
Date that this subject was created.public long getCreateTimeDb()
public java.lang.String getCreatorMemberId()
public java.lang.String getModifierMemberId()
public void setCreateTimeDb(long createTime1)
createTime1 - public void setCreatorMemberId(java.lang.String creatorMemberId1)
creatorMemberId1 - public void setModifierMemberId(java.lang.String modifierMemberId1)
modifierMemberId1 - public void setModifyTimeDb(long modifyTime1)
modifyTime1 - public java.util.Date getModifyTime()
Date that this subject was created.public long getModifyTimeDb()
public static boolean subjectCanEditExternalUser(edu.internet2.middleware.subject.Subject subject)
subject -
public void onPreSave(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreSave in interface HibGrouperLifecycleonPreSave in class GrouperAPIGrouperAPI.onPreSave(HibernateSession)public void onPreUpdate(HibernateSession hibernateSession)
HibGrouperLifecycle
onPreUpdate in interface HibGrouperLifecycleonPreUpdate in class GrouperAPIGrouperAPI.onPreUpdate(HibernateSession)public void store()
public java.lang.String retrieveFieldValue(java.lang.String fieldOrAttributeName)
fieldOrAttributeName -
public void store(java.util.Set<ExternalSubjectAttribute> externalSubjectAttributes,
java.lang.String externalSubjectInviteName,
boolean validateAttributes,
boolean autoaddGroups,
boolean fromRecalcDaemon)
externalSubjectAttributes - null to not worry, not null to affect the external subject attributes tooexternalSubjectInviteName - is a variable you could put in the URL to pass to the hook so you can
add the users to custom groups or whatnotvalidateAttributes - if required attributes should be validatedautoaddGroups - if groups should be auto-added (e.g. not from daemon)fromRecalcDaemon - if the recalc daemon is doing the storingpublic void validateIdentifier()
public static java.lang.String sourceName()
public static java.lang.String sourceId()
public void delete()
public static int internal_fixDisabled()
public static int internal_daemonCalcFields()
public boolean assignAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
attributeName - attributeValue -
public java.util.Set<ExternalSubjectAttribute> retrieveAttributes()
public ExternalSubjectAttribute retrieveAttribute(java.lang.String attributeName,
boolean exceptionIfNotFound)
attributeName - exceptionIfNotFound -
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public boolean removeAttribute(java.lang.String attributeName)
attributeName -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||