org.apereo.portal.tenants

Interface ITenantOperationsListener

All Known Implementing Classes:

AbstractTenantOperationsListener, AttributeValidatingOperationsListener, JpaPersistenceTenantOperationsListener, ResetPasswordTenantOperationsListener, TemplateDataTenantOperationsListener

public interface ITenantOperationsListener

Interface that supports pluggable behavior when tenants are created, updated, or removed.

Since:

4.1

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.
java.lang.String	getFname() The (short) string that identifies this listener uniquely.
java.lang.String	getName() Provides a human-readable name for this listener suitable for displaying in the UI.
boolean	isOptional() Is skipping this listener permissable?
TenantOperationResponse	onCreate(org.apereo.portal.tenants.ITenant tenant) Allows the listener to respond to the creation of a new tenant.
TenantOperationResponse	onDelete(org.apereo.portal.tenants.ITenant tenant) Allows the listener to respond to the removal of a 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	validateAttribute(java.lang.String key, java.lang.String value) Throws an exception if the specified value isn't allowable for the specified attribute.

Method Detail

getName

java.lang.String getName()

Provides a human-readable name for this listener suitable for displaying in the UI. Internationalized.

getFname

java.lang.String getFname()

The (short) string that identifies this listener uniquely.

Since:

4.3

isOptional

boolean isOptional()

Is skipping this listener permissable?

Since:

4.3

onCreate

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

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

onUpdate

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.

onDelete

TenantOperationResponse onDelete(org.apereo.portal.tenants.ITenant tenant)

Allows the listener to respond to the removal of a tenant.

getAvaialableActions

java.util.Set<ITenantManagementAction> getAvaialableActions()

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'

Since:

4.3

validateAttribute

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

Throws an exception if the specified value isn't allowable for the specified attribute.

Throws:

java.lang.Exception

Since:

4.3