org.apereo.portal.tenants

Class ResetPasswordTenantOperationsListener

java.lang.Object

org.apereo.portal.tenants.AbstractTenantOperationsListener

org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

All Implemented Interfaces:

ITenantOperationsListener

public final class ResetPasswordTenantOperationsListener
extends AbstractTenantOperationsListener

Integrates with the 'forgot-password' framework portlet to grant the tenant admin contact access via local authentication when a new tenant is created.

This behavior is completely optional. You can add or remove it by adjusting the 'tenantOperationsListeners' bean in servicesContext.xml.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_CONTACT_EMAIL
static java.lang.String	ADMIN_CONTACT_USERNAME

Constructor Summary

Constructors

Constructor and Description
ResetPasswordTenantOperationsListener()

Method Summary

Modifier and Type	Method and Description
java.util.Set<ITenantManagementAction>	getAvaialableActions() Listeners may optionally define one or more operations that may be performed on an existing tenant.
boolean	isOptional() This step is not required
TenantOperationResponse	onCreate(org.apereo.portal.tenants.ITenant tenant) Allows the listener to respond to the creation of a new tenant.
TenantOperationResponse	onUpdate(org.apereo.portal.tenants.ITenant tenant) Allows the listener to respond to a change in the metadata originally used to define a tenant.
void	setPasswordResetNotification(org.apereo.portal.portlets.account.IPasswordResetNotification passwordResetNotification)
void	validateAttribute(java.lang.String key, java.lang.String value) Default implementation is a no-op.

Methods inherited from class org.apereo.portal.tenants.AbstractTenantOperationsListener

createLocalizedMessage, getFname, getName, onDelete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADMIN_CONTACT_USERNAME

public static final java.lang.String ADMIN_CONTACT_USERNAME

See Also:

Constant Field Values

ADMIN_CONTACT_EMAIL

public static final java.lang.String ADMIN_CONTACT_EMAIL

See Also:

Constant Field Values

Constructor Detail

ResetPasswordTenantOperationsListener

public ResetPasswordTenantOperationsListener()

Method Detail

setPasswordResetNotification

@Autowired
public void setPasswordResetNotification(org.apereo.portal.portlets.account.IPasswordResetNotification passwordResetNotification)

isOptional

public boolean isOptional()

This step is not required

Specified by:

isOptional in interface ITenantOperationsListener

Overrides:

isOptional in class AbstractTenantOperationsListener

onCreate

public TenantOperationResponse onCreate(org.apereo.portal.tenants.ITenant tenant)

Description copied from interface: ITenantOperationsListener

Allows the listener to respond to the creation of a new tenant.

Specified by:

onCreate in interface ITenantOperationsListener

Overrides:

onCreate in class AbstractTenantOperationsListener

onUpdate

public TenantOperationResponse onUpdate(org.apereo.portal.tenants.ITenant tenant)

Description copied from interface: ITenantOperationsListener

Allows the listener to respond to a change in the metadata originally used to define a tenant.

Specified by:

onUpdate in interface ITenantOperationsListener

Overrides:

onUpdate in class AbstractTenantOperationsListener

getAvaialableActions

public java.util.Set<ITenantManagementAction> getAvaialableActions()

Description copied from interface: ITenantOperationsListener

Listeners may optionally define one or more operations that may be performed on an existing tenant. Normally these actions might be the same as, or similar too, the behavior they implement for tenant CrUD operations. Example: 'Re-send Tenant Admin Email'

Specified by:

getAvaialableActions in interface ITenantOperationsListener

Overrides:

getAvaialableActions in class AbstractTenantOperationsListener

Since:

4.3

validateAttribute

public void validateAttribute(java.lang.String key,
                              java.lang.String value)
                       throws java.lang.Exception

Description copied from class: AbstractTenantOperationsListener

Default implementation is a no-op.

Specified by:

validateAttribute in interface ITenantOperationsListener

Overrides:

validateAttribute in class AbstractTenantOperationsListener

Throws:

java.lang.Exception