ExternalSubjectAttrFramework (Grouper API 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouper.externalSubjects.ExternalSubjectAttrFramework

public class ExternalSubjectAttrFramework
extends Object

data and logic about attributes for external subjects

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXTERNAL_SUBJECT_EMAIL_ADDRESS`
`static String`	`EXTERNAL_SUBJECT_INVITE_CONFIG_DEF` main attribute definition assigned to stems
`static String`	`EXTERNAL_SUBJECT_INVITE_DATE`
`static String`	`EXTERNAL_SUBJECT_INVITE_EMAIL`
`static String`	`EXTERNAL_SUBJECT_INVITE_EMAIL_WHEN_REGISTERED`
`static String`	`EXTERNAL_SUBJECT_INVITE_EXPIRE_DATE`
`static String`	`EXTERNAL_SUBJECT_INVITE_GROUP_UUIDS`
`static String`	`EXTERNAL_SUBJECT_INVITE_MEMBER_ID`
`static String`	`EXTERNAL_SUBJECT_INVITE_UUID`
`static String`	`EXTERNAL_SUBJECT_INVITE_VALUE_DEF` main attribute definition assigned to stem assignment

Constructor Summary

Constructors
Constructor and Description

ExternalSubjectAttrFramework()

Constructors
Constructor and Description
`ExternalSubjectAttrFramework()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`attributeExternalSubjectInviteStemName()` return the stem name where the attribute extenral subject attributes go, without colon on end
`static long`	`expireMillisAfter1970()`
`static AttributeDefName`	`externalSubjectInviteAttributeDefName()` return the rule attribute def name, assign this to an object to attach a rule.
`static String`	`externalSubjectInviteDateName()` full externalSubjectInviteDateName
`static AttributeDefName`	`externalSubjectInviteEmailAddressAttributeDefName()` return the email address attribute def name this throws exception if cant find
`static String`	`externalSubjectInviteEmailAddressName()` full externalSubjectInviteEmailAddress
`static String`	`externalSubjectInviteEmailName()` full externalSubjectInviteEmailName
`static String`	`externalSubjectInviteEmailWhenRegisteredName()` full externalSubjectInviteEmailWhenRegisteredName
`static String`	`externalSubjectInviteExpireDateName()` full externalSubjectInviteExpireDateName
`static String`	`externalSubjectInviteGroupUuidsName()` full externalSubjectInviteGroupUuidsName
`static String`	`externalSubjectInviteMemberIdName()` full externalSubjectInviteMemberIdName
`static AttributeDefName`	`externalSubjectInviteUuidAttributeDefName()` return the uuid attribute def name this throws exception if cant find
`static String`	`externalSubjectInviteUuidName()` full externalSubjectInviteUuidName
`static String`	`inviteExternalUsers(Set<String> emailAddresses, ExternalSubjectInviteBean externalSubjectInviteBean, String emailSubject, String email)` invite external users to register with grouper.
`static AttributeDef`	`retrieveAttributeDefBaseDef()` attribute value def assigned to stem or group
`static AttributeDef`	`retrieveAttributeDefValueDef()` attribute value def assigned to stem or group

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTERNAL_SUBJECT_INVITE_CONFIG_DEF
```
public static final String EXTERNAL_SUBJECT_INVITE_CONFIG_DEF
```
    main attribute definition assigned to stems
    
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_VALUE_DEF
```
public static final String EXTERNAL_SUBJECT_INVITE_VALUE_DEF
```
    main attribute definition assigned to stem assignment
    
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_EMAIL_WHEN_REGISTERED
```
public static final String EXTERNAL_SUBJECT_INVITE_EMAIL_WHEN_REGISTERED
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_EMAIL
```
public static final String EXTERNAL_SUBJECT_INVITE_EMAIL
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_MEMBER_ID
```
public static final String EXTERNAL_SUBJECT_INVITE_MEMBER_ID
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_GROUP_UUIDS
```
public static final String EXTERNAL_SUBJECT_INVITE_GROUP_UUIDS
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_UUID
```
public static final String EXTERNAL_SUBJECT_INVITE_UUID
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_EMAIL_ADDRESS
```
public static final String EXTERNAL_SUBJECT_EMAIL_ADDRESS
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_EXPIRE_DATE
```
public static final String EXTERNAL_SUBJECT_INVITE_EXPIRE_DATE
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_SUBJECT_INVITE_DATE
```
public static final String EXTERNAL_SUBJECT_INVITE_DATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExternalSubjectAttrFramework
```
public ExternalSubjectAttrFramework()
```
- Method Detail
  - inviteExternalUsers
```
public static String inviteExternalUsers(Set<String> emailAddresses,
                                         ExternalSubjectInviteBean externalSubjectInviteBean,
                                         String emailSubject,
                                         String email)
```
    invite external users to register with grouper. Note, there needs to a wheel/root grouper session open when calling this method
    
    Parameters:
    
    emailAddresses -
    
    externalSubjectInviteBean - put most of the data in this bean
    
    email - to send, must have $inviteLink$ variable in it, or it will be added to the end
    
    emailSubject - of the email or null to get the default
    
    Returns:
    
    the error message or null if ok
  - expireMillisAfter1970
```
public static long expireMillisAfter1970()
```
    Returns:
    
    millis that this will expire
  - externalSubjectInviteAttributeDefName
```
public static AttributeDefName externalSubjectInviteAttributeDefName()
```
    return the rule attribute def name, assign this to an object to attach a rule. this throws exception if cant find
    
    Returns:
    
    the attribute def name
  - externalSubjectInviteUuidAttributeDefName
```
public static AttributeDefName externalSubjectInviteUuidAttributeDefName()
```
    return the uuid attribute def name this throws exception if cant find
    
    Returns:
    
    the attribute def name
  - externalSubjectInviteEmailAddressAttributeDefName
```
public static AttributeDefName externalSubjectInviteEmailAddressAttributeDefName()
```
    return the email address attribute def name this throws exception if cant find
    
    Returns:
    
    the attribute def name
  - externalSubjectInviteEmailWhenRegisteredName
```
public static String externalSubjectInviteEmailWhenRegisteredName()
```
    full externalSubjectInviteEmailWhenRegisteredName
    
    Returns:
    
    name
  - externalSubjectInviteEmailName
```
public static String externalSubjectInviteEmailName()
```
    full externalSubjectInviteEmailName
    
    Returns:
    
    name
  - externalSubjectInviteMemberIdName
```
public static String externalSubjectInviteMemberIdName()
```
    full externalSubjectInviteMemberIdName
    
    Returns:
    
    name
  - externalSubjectInviteGroupUuidsName
```
public static String externalSubjectInviteGroupUuidsName()
```
    full externalSubjectInviteGroupUuidsName
    
    Returns:
    
    name
  - externalSubjectInviteUuidName
```
public static String externalSubjectInviteUuidName()
```
    full externalSubjectInviteUuidName
    
    Returns:
    
    name
  - externalSubjectInviteEmailAddressName
```
public static String externalSubjectInviteEmailAddressName()
```
    full externalSubjectInviteEmailAddress
    
    Returns:
    
    name
  - externalSubjectInviteExpireDateName
```
public static String externalSubjectInviteExpireDateName()
```
    full externalSubjectInviteExpireDateName
    
    Returns:
    
    name
  - externalSubjectInviteDateName
```
public static String externalSubjectInviteDateName()
```
    full externalSubjectInviteDateName
    
    Returns:
    
    name
  - attributeExternalSubjectInviteStemName
```
public static String attributeExternalSubjectInviteStemName()
```
    return the stem name where the attribute extenral subject attributes go, without colon on end
    
    Returns:
    
    stem name
  - retrieveAttributeDefBaseDef
```
public static AttributeDef retrieveAttributeDefBaseDef()
```
    attribute value def assigned to stem or group
    
    Returns:
    
    the attribute def
  - retrieveAttributeDefValueDef
```
public static AttributeDef retrieveAttributeDefValueDef()
```
    attribute value def assigned to stem or group
    
    Returns:
    
    the attribute def

Class ExternalSubjectAttrFramework

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTERNAL_SUBJECT_INVITE_CONFIG_DEF

EXTERNAL_SUBJECT_INVITE_VALUE_DEF

EXTERNAL_SUBJECT_INVITE_EMAIL_WHEN_REGISTERED

EXTERNAL_SUBJECT_INVITE_EMAIL

EXTERNAL_SUBJECT_INVITE_MEMBER_ID

EXTERNAL_SUBJECT_INVITE_GROUP_UUIDS

EXTERNAL_SUBJECT_INVITE_UUID

EXTERNAL_SUBJECT_EMAIL_ADDRESS

EXTERNAL_SUBJECT_INVITE_EXPIRE_DATE

EXTERNAL_SUBJECT_INVITE_DATE

Constructor Detail

ExternalSubjectAttrFramework

Method Detail

inviteExternalUsers

expireMillisAfter1970

externalSubjectInviteAttributeDefName

externalSubjectInviteUuidAttributeDefName

externalSubjectInviteEmailAddressAttributeDefName

externalSubjectInviteEmailWhenRegisteredName

externalSubjectInviteEmailName

externalSubjectInviteMemberIdName

externalSubjectInviteGroupUuidsName

externalSubjectInviteUuidName

externalSubjectInviteEmailAddressName

externalSubjectInviteExpireDateName

externalSubjectInviteDateName

attributeExternalSubjectInviteStemName

retrieveAttributeDefBaseDef

retrieveAttributeDefValueDef