org.apereo.portal.tenants

Class TemplateDataTenantOperationsListener

java.lang.Object

org.apereo.portal.tenants.AbstractTenantOperationsListener

org.apereo.portal.tenants.TemplateDataTenantOperationsListener

All Implemented Interfaces:

ITenantOperationsListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public final class TemplateDataTenantOperationsListener
extends AbstractTenantOperationsListener
implements org.springframework.context.ApplicationContextAware

Uses Import/Export to create some basic portal data for a new tenant. You can add to, adjust, or pare-down tenant template data in src/main/resources/org/apereo/portal/tenants/data.

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateDataTenantOperationsListener.DeleteTuple Used in the implementation of onDelete.

Constructor Summary

Constructors

Constructor and Description
TemplateDataTenantOperationsListener()

Method Summary

Modifier and Type	Method and Description
TenantOperationResponse	importWithResources(org.apereo.portal.tenants.ITenant tenant, java.util.Set<org.springframework.core.io.Resource> resources) High-level implementation method that brokers the queuing, importing, and reporting that is common to Create and Update.
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	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDataTypeImportOrder(java.util.List<org.apereo.portal.io.xml.IPortalDataType> dataTypeImportOrder) The @Autowired list will reflect the order in which data types should be imported.
void	setEntitiesToRemoveOnDelete(java.util.List<TemplateDataTenantOperationsListener.DeleteTuple> entitiesToRemoveOnDelete)
void	setEntityResourcesToImportOnUpdate(java.util.Set<java.lang.String> entityResourcesToImportOnUpdate)
void	setup()

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

createLocalizedMessage, getAvaialableActions, getFname, getName, isOptional, validateAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateDataTenantOperationsListener

public TemplateDataTenantOperationsListener()

Method Detail

setDataTypeImportOrder

@Autowired
public void setDataTypeImportOrder(java.util.List<org.apereo.portal.io.xml.IPortalDataType> dataTypeImportOrder)

The @Autowired list will reflect the order in which data types should be imported.

setEntityResourcesToImportOnUpdate

public void setEntityResourcesToImportOnUpdate(java.util.Set<java.lang.String> entityResourcesToImportOnUpdate)

setEntitiesToRemoveOnDelete

public void setEntitiesToRemoveOnDelete(java.util.List<TemplateDataTenantOperationsListener.DeleteTuple> entitiesToRemoveOnDelete)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setup

@PostConstruct
public void setup()
                          throws java.lang.Exception

Throws:

java.lang.Exception

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

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

Overrides:

onDelete in class AbstractTenantOperationsListener

importWithResources

public TenantOperationResponse importWithResources(org.apereo.portal.tenants.ITenant tenant,
                                                   java.util.Set<org.springframework.core.io.Resource> resources)

High-level implementation method that brokers the queuing, importing, and reporting that is common to Create and Update.