edu.internet2.middleware.grouper.externalSubjects
Class ExternalSubject

java.lang.Object
  edu.internet2.middleware.grouper.GrouperAPI
      edu.internet2.middleware.grouper.externalSubjects.ExternalSubject

All Implemented Interfaces:

HibGrouperLifecycle, Hib3GrouperVersioned, GrouperCloneable, GrouperHasContext, GrouperUtil.FieldValuable, java.io.Serializable, org.hibernate.classic.Lifecycle

public class ExternalSubject
extends GrouperAPI
implements GrouperHasContext, Hib3GrouperVersioned

database object for external subject

Author:

mchyzer

See Also:

Serialized Form

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

TABLE_GROUPER_EXT_SUBJ

public static final java.lang.String TABLE_GROUPER_EXT_SUBJ

table name for external subjects

See Also:

Constant Field Values

COLUMN_CONTEXT_ID

public static final java.lang.String COLUMN_CONTEXT_ID

column name for context id

See Also:

Constant Field Values

COLUMN_DESCRIPTION

public static final java.lang.String COLUMN_DESCRIPTION

column name for description

See Also:

Constant Field Values

COLUMN_DISABLED_TIME

public static final java.lang.String COLUMN_DISABLED_TIME

column name for disabled time

See Also:

Constant Field Values

COLUMN_EMAIL

public static final java.lang.String COLUMN_EMAIL

column name for email

See Also:

Constant Field Values

COLUMN_ENABLED

public static final java.lang.String COLUMN_ENABLED

column name for enabled

See Also:

Constant Field Values

COLUMN_IDENTIFIER

public static final java.lang.String COLUMN_IDENTIFIER

column name for identifier

See Also:

Constant Field Values

COLUMN_INSTITUTION

public static final java.lang.String COLUMN_INSTITUTION

column name for institution

See Also:

Constant Field Values

COLUMN_NAME

public static final java.lang.String COLUMN_NAME

column name for name

See Also:

Constant Field Values

COLUMN_SEARCH_STRING_LOWER

public static final java.lang.String COLUMN_SEARCH_STRING_LOWER

column name for searchStringLower

See Also:

Constant Field Values

COLUMN_VETTED_EMAIL_ADDRESSES

public static final java.lang.String COLUMN_VETTED_EMAIL_ADDRESSES

column name for vettedEmailAddresses

See Also:

Constant Field Values

COLUMN_UUID

public static final java.lang.String COLUMN_UUID

column name for uuid

See Also:

Constant Field Values

COLUMN_CREATE_TIME

public static final java.lang.String COLUMN_CREATE_TIME

column name for create time

See Also:

Constant Field Values

COLUMN_CREATOR_MEMBER_ID

public static final java.lang.String COLUMN_CREATOR_MEMBER_ID

column name for creator member id

See Also:

Constant Field Values

COLUMN_MODIFY_TIME

public static final java.lang.String COLUMN_MODIFY_TIME

column name for modify time

See Also:

Constant Field Values

COLUMN_MODIFIER_MEMBER_ID

public static final java.lang.String COLUMN_MODIFIER_MEMBER_ID

column name for modifier member id

See Also:

Constant Field Values

FIELD_CONTEXT_ID

public static final java.lang.String FIELD_CONTEXT_ID

constant for field name for: contextId

See Also:

Constant Field Values

FIELD_CREATE_TIME

public static final java.lang.String FIELD_CREATE_TIME

constant for field name for: createTime

See Also:

Constant Field Values

FIELD_CREATOR_MEMBER_ID

public static final java.lang.String FIELD_CREATOR_MEMBER_ID

constant for field name for: creatorMemberId

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final java.lang.String FIELD_DESCRIPTION

constant for field name for: description

See Also:

Constant Field Values

FIELD_DISABLED_TIME

public static final java.lang.String FIELD_DISABLED_TIME

constant for field name for: disabledTime

See Also:

Constant Field Values

FIELD_EMAIL

public static final java.lang.String FIELD_EMAIL

constant for field name for: email

See Also:

Constant Field Values

FIELD_ENABLED

public static final java.lang.String FIELD_ENABLED

constant for field name for: enabled

See Also:

Constant Field Values

FIELD_IDENTIFIER

public static final java.lang.String FIELD_IDENTIFIER

constant for field name for: identifier

See Also:

Constant Field Values

FIELD_INSTITUTION

public static final java.lang.String FIELD_INSTITUTION

constant for field name for: institution

See Also:

Constant Field Values

FIELD_MODIFIER_MEMBER_ID

public static final java.lang.String FIELD_MODIFIER_MEMBER_ID

constant for field name for: modifierMemberId

See Also:

Constant Field Values

FIELD_MODIFY_TIME

public static final java.lang.String FIELD_MODIFY_TIME

constant for field name for: modifyTime

See Also:

Constant Field Values

FIELD_NAME

public static final java.lang.String FIELD_NAME

constant for field name for: name

See Also:

Constant Field Values

FIELD_SEARCH_STRING_LOWER

public static final java.lang.String FIELD_SEARCH_STRING_LOWER

constant for field name for: searchStringLower

See Also:

Constant Field Values

FIELD_VETTED_EMAIL_ADDRESSES

public static final java.lang.String FIELD_VETTED_EMAIL_ADDRESSES

constant for field name for: vettedEmailAddresses

See Also:

Constant Field Values

FIELD_UUID

public static final java.lang.String FIELD_UUID

constant for field name for: uuid

See Also:

Constant Field Values

Constructor Detail

ExternalSubject

public ExternalSubject()

Method Detail

getVettedEmailAddresses

public java.lang.String getVettedEmailAddresses()

comma separated vetted email addresses

Returns:

comma separated vetted email addresses

setVettedEmailAddresses

public void setVettedEmailAddresses(java.lang.String vettedEmailAddresses1)

comma separated vetted email addresses

Parameters:

vettedEmailAddresses1 -

notifyWatcherAboutRegistration

public static void notifyWatcherAboutRegistration(java.lang.String identifier,
                                                  java.lang.String emailAddressToNotify,
                                                  java.lang.String emailAddressOfInvitee)

notify watcher about a registration. If there is a problem, just log the exception

Parameters:

identifier -

emailAddressToNotify -

emailAddressOfInvitee -

addVettedEmailAddress

public void addVettedEmailAddress(java.lang.String vettedEmailAddress)

add a vetted email address and store this object if necessary

Parameters:

vettedEmailAddress -

getDisabledTimeDb

public java.lang.Long getDisabledTimeDb()

when this was disabled, or when it will be disabled

Returns:

the millis from 1970

setDisabledTimeDb

public void setDisabledTimeDb(java.lang.Long disabledTime1)

when this was disabled, or when it will be disabled

Parameters:

disabledTime1 -

getDisabledTime

public java.util.Date getDisabledTime()

when this was disabled, or when it will be disabled, millis from 1970

Returns:

disabled time

setDisabledTime

public void setDisabledTime(java.util.Date theDisabledTime1)

when this was disabled, or when it will be disabled, millis from 1970

Parameters:

theDisabledTime1 -

isEnabled

public boolean isEnabled()

if this is enabled

Returns:

true if enabled

getEnabledDb

public java.lang.String getEnabledDb()

if this is enabled

Returns:

T or F

setEnabled

public void setEnabled(boolean enabled1)

if this is enabled

Parameters:

enabled1 -

setEnabledDb

public void setEnabledDb(java.lang.String enabled1)

if this is enabled, T or F

Parameters:

enabled1 -

getContextId

public java.lang.String getContextId()

contextId links to audit tables

Returns:

context id

getSearchStringLower

public java.lang.String getSearchStringLower()

search string to find a subject, in all lower case

Returns:

search string lower

setSearchStringLower

public void setSearchStringLower(java.lang.String searchStringLower1)

search string to find a subject, in all lower case

Parameters:

searchStringLower1 -

getUuid

public java.lang.String getUuid()

uuid for row

Returns:

uuid

setUuid

public void setUuid(java.lang.String uuid1)

uuid for row

Parameters:

uuid1 -

getIdentifier

public java.lang.String getIdentifier()

the thing that the subject uses to login

Returns:

identifier

setIdentifier

public void setIdentifier(java.lang.String identifier1)

the thing that the subject uses to login

Parameters:

identifier1 -

getName

public java.lang.String getName()

name of subject

Returns:

name

setName

public void setName(java.lang.String name1)

name of subject

Parameters:

name1 -

getDescription

public java.lang.String getDescription()

description, which is generated from other attributes

Returns:

description

setDescription

public void setDescription(java.lang.String description1)

description, which is generated from other attributes

Parameters:

description1 -

getEmail

public java.lang.String getEmail()

email address

Returns:

email

setEmail

public void setEmail(java.lang.String email1)

email address

Parameters:

email1 -

getInstitution

public java.lang.String getInstitution()

institution where the user is from

Returns:

institution

setInstitution

public void setInstitution(java.lang.String institution1)

institution where the user is from

Parameters:

institution1 -

clone

public ExternalSubject clone()

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:

Object.clone()

setContextId

public void setContextId(java.lang.String contextId1)

contextId links to audit tables

Specified by:

setContextId in interface GrouperHasContext

Parameters:

contextId1 -

getCreateTime

public java.util.Date getCreateTime()

Get creation time for this subject.

Returns:

Date that this subject was created.

getCreateTimeDb

public long getCreateTimeDb()

Returns:

create time

getCreatorMemberId

public java.lang.String getCreatorMemberId()

Returns:

creator

getModifierMemberId

public java.lang.String getModifierMemberId()

Returns:

the modifier member id

setCreateTimeDb

public void setCreateTimeDb(long createTime1)

create time

Parameters:

createTime1 -

setCreatorMemberId

public void setCreatorMemberId(java.lang.String creatorMemberId1)

member id of creator

Parameters:

creatorMemberId1 -

setModifierMemberId

public void setModifierMemberId(java.lang.String modifierMemberId1)

member id of modifier

Parameters:

modifierMemberId1 -

setModifyTimeDb

public void setModifyTimeDb(long modifyTime1)

last time modified

Parameters:

modifyTime1 -

getModifyTime

public java.util.Date getModifyTime()

Get modify time for this subject.

Returns:

Date that this subject was created.

getModifyTimeDb

public long getModifyTimeDb()

Returns:

modify time

subjectCanEditExternalUser

public static boolean subjectCanEditExternalUser(edu.internet2.middleware.subject.Subject subject)

see if someone is allowed to edit, cache for 1 minute

Parameters:

subject -

Returns:

true if allowed to edit

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)

store

public void store()

store this object to the DB.

retrieveFieldValue

public java.lang.String retrieveFieldValue(java.lang.String fieldOrAttributeName)

get the value by field name or attribute

Parameters:

fieldOrAttributeName -

Returns:

the value

store

public void store(java.util.Set<ExternalSubjectAttribute> externalSubjectAttributes,
                  java.lang.String externalSubjectInviteName,
                  boolean validateAttributes,
                  boolean autoaddGroups,
                  boolean fromRecalcDaemon)

store this object to the DB.

Parameters:

externalSubjectAttributes - null to not worry, not null to affect the external subject attributes too

externalSubjectInviteName - is a variable you could put in the URL to pass to the hook so you can add the users to custom groups or whatnot

validateAttributes - if required attributes should be validated

autoaddGroups - if groups should be auto-added (e.g. not from daemon)

fromRecalcDaemon - if the recalc daemon is doing the storing

validateIdentifier

public void validateIdentifier()

validate that the identifier is ok, based on grouper.properties

sourceName

public static java.lang.String sourceName()

source name for external subjects

Returns:

name

sourceId

public static java.lang.String sourceId()

source id for external subjects

Returns:

id

delete

public void delete()

delete this object from the DB.

internal_fixDisabled

public static int internal_fixDisabled()

fix enabled and disabled memberships, and return the count of how many were fixed

Returns:

the number of records affected

internal_daemonCalcFields

public static int internal_daemonCalcFields()

fix enabled and disabled memberships, and return the count of how many were fixed

Returns:

the number of records affected

assignAttribute

public boolean assignAttribute(java.lang.String attributeName,
                               java.lang.String attributeValue)

assign an attribute to this subject, change value if already exists, add if not

Parameters:

attributeName -

attributeValue -

Returns:

true if changed anything, false if not

retrieveAttributes

public java.util.Set<ExternalSubjectAttribute> retrieveAttributes()

get all attributes for this subject

Returns:

the attributes

retrieveAttribute

public ExternalSubjectAttribute retrieveAttribute(java.lang.String attributeName,
                                                  boolean exceptionIfNotFound)

get an attributes for this subject

Parameters:

attributeName -

exceptionIfNotFound -

Returns:

the attributes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

removeAttribute

public boolean removeAttribute(java.lang.String attributeName)

remove an attribute

Parameters:

attributeName -

Returns:

true if did anything