org.apereo.portal.tenants

Class AbstractTenantOperationsListener

java.lang.Object

org.apereo.portal.tenants.AbstractTenantOperationsListener

All Implemented Interfaces:

ITenantOperationsListener

Direct Known Subclasses:

AttributeValidatingOperationsListener, JpaPersistenceTenantOperationsListener, ResetPasswordTenantOperationsListener, TemplateDataTenantOperationsListener

public abstract class AbstractTenantOperationsListener
extends java.lang.Object
implements ITenantOperationsListener

Implements all methods of ITenantOperationsListener as no-ops and can therefore serve as a base class for concrete listeners that need to override some but not all of the methods.

Since:

4.1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTenantOperationsListener(java.lang.String fname)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createLocalizedMessage(java.lang.String messageCode, java.lang.Object[] args)
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) Default implementation is a no-op.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTenantOperationsListener

protected AbstractTenantOperationsListener(java.lang.String fname)

Method Detail

getName

public final java.lang.String getName()

Description copied from interface: ITenantOperationsListener

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

Specified by:

getName in interface ITenantOperationsListener

getFname

public final java.lang.String getFname()

Description copied from interface: ITenantOperationsListener

The (short) string that identifies this listener uniquely.

Specified by:

getFname in interface ITenantOperationsListener

Since:

4.3

isOptional

public boolean isOptional()

Description copied from interface: ITenantOperationsListener

Is skipping this listener permissable?

Specified by:

isOptional in interface ITenantOperationsListener

Since:

4.3

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

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

onDelete

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

Description copied from interface: ITenantOperationsListener

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

Specified by:

onDelete in interface ITenantOperationsListener

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

Since:

4.3

validateAttribute

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

Default implementation is a no-op.

Specified by:

validateAttribute in interface ITenantOperationsListener

Throws:

java.lang.Exception

createLocalizedMessage

protected java.lang.String createLocalizedMessage(java.lang.String messageCode,
                                                  java.lang.Object[] args)

Since:

4.3