A C D F G I J N O R S T U V

A

AbstractTenantOperationsListener - Class in org.apereo.portal.tenants

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.

AbstractTenantOperationsListener(String) - Constructor for class org.apereo.portal.tenants.AbstractTenantOperationsListener

addMessage(String) - Method in class org.apereo.portal.tenants.TenantOperationResponse

ADMIN_CONTACT_EMAIL - Static variable in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

ADMIN_CONTACT_USERNAME - Static variable in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

attributes - Static variable in class org.apereo.portal.tenants.JpaTenant_

AttributeValidatingOperationsListener - Class in org.apereo.portal.tenants

Useful for extra user input validation in Create and Update tenant operations.

AttributeValidatingOperationsListener() - Constructor for class org.apereo.portal.tenants.AttributeValidatingOperationsListener

C

createLocalizedMessage(String, Object[]) - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

createTenant(String, String, Map<String, String>, Set<String>, List<TenantOperationResponse>) - Method in class org.apereo.portal.tenants.TenantService

D

deleteTenantByFName(String, List<TenantOperationResponse>) - Method in class org.apereo.portal.tenants.TenantService

DeleteTuple() - Constructor for class org.apereo.portal.tenants.TemplateDataTenantOperationsListener.DeleteTuple

F

fname - Static variable in class org.apereo.portal.tenants.JpaTenant_

fnameExists(String) - Method in class org.apereo.portal.tenants.TenantService

Returns true if a tenant with the specified fname exists, otherwise false.

G

getAction(String) - Method in class org.apereo.portal.tenants.TenantService

getAllAvaialableActions() - Method in class org.apereo.portal.tenants.TenantService

Complete set of actions from all listeners

getAvaialableActions() - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

getAvaialableActions() - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

Listeners may optionally define one or more operations that may be performed on an existing tenant.

getAvaialableActions() - Method in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

getFname() - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

getFname() - Method in interface org.apereo.portal.tenants.ITenantManagementAction

The (short) string that identifies this action uniquely.

getFname() - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

The (short) string that identifies this listener uniquely.

getMessageCode() - Method in interface org.apereo.portal.tenants.ITenantManagementAction

The key used with the Spring messageSurce to obtain the internationalized UI string for this operation.

getMessages() - Method in class org.apereo.portal.tenants.TenantOperationResponse

getName() - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

getName() - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

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

getOptionalOperationsListeners() - Method in class org.apereo.portal.tenants.TenantService

List of the fnames of currently configured ITenantOperationsListener objects that may be omitted, presented in their natural (sequential) order.

getResult() - Method in class org.apereo.portal.tenants.TenantOperationResponse

getSysid() - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener.DeleteTuple

getTenantByFName(String) - Method in class org.apereo.portal.tenants.TenantService

getTenantOperationsListener() - Method in class org.apereo.portal.tenants.TenantOperationResponse

getTenantsList() - Method in class org.apereo.portal.tenants.TenantService

Provides the complete collection of tenants in the system in the default order (alphabetically by name).

getType() - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener.DeleteTuple

I

id - Static variable in class org.apereo.portal.tenants.JpaTenant_

importWithResources(ITenant, Set<Resource>) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

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

init() - Method in class org.apereo.portal.tenants.TenantService

invoke(ITenant) - Method in interface org.apereo.portal.tenants.ITenantManagementAction

Invoke the intended behavior on the specified tenent.

isOptional() - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

isOptional() - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

Is skipping this listener permissable?

isOptional() - Method in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

This step is not required

ITenantManagementAction - Interface in org.apereo.portal.tenants

Represents a behavior of an ITenantOperationsListener that may be invoked independent of a Create, Update, or Delete operation.

ITenantOperationsListener - Interface in org.apereo.portal.tenants

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

J

JpaPersistenceTenantOperationsListener - Class in org.apereo.portal.tenants

This listener handles the JPA create/update/delete operations in the tenancy subsystem.

JpaPersistenceTenantOperationsListener() - Constructor for class org.apereo.portal.tenants.JpaPersistenceTenantOperationsListener

JpaTenant_ - Class in org.apereo.portal.tenants

JpaTenant_() - Constructor for class org.apereo.portal.tenants.JpaTenant_

N

name - Static variable in class org.apereo.portal.tenants.JpaTenant_

nameExists(String) - Method in class org.apereo.portal.tenants.TenantService

Returns true if a tenant with the specified name exists, otherwise false.

O

onCreate(ITenant) - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

onCreate(ITenant) - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

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

onCreate(ITenant) - Method in class org.apereo.portal.tenants.JpaPersistenceTenantOperationsListener

onCreate(ITenant) - Method in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

onCreate(ITenant) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

onDelete(ITenant) - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

onDelete(ITenant) - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

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

onDelete(ITenant) - Method in class org.apereo.portal.tenants.JpaPersistenceTenantOperationsListener

onDelete(ITenant) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

onUpdate(ITenant) - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

onUpdate(ITenant) - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

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

onUpdate(ITenant) - Method in class org.apereo.portal.tenants.JpaPersistenceTenantOperationsListener

onUpdate(ITenant) - Method in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

onUpdate(ITenant) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

org.apereo.portal.tenants - package org.apereo.portal.tenants

R

ResetPasswordTenantOperationsListener - Class in org.apereo.portal.tenants

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

ResetPasswordTenantOperationsListener() - Constructor for class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

S

setApplicationContext(ApplicationContext) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

setDataTypeImportOrder(List<IPortalDataType>) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

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

setEntitiesToRemoveOnDelete(List<TemplateDataTenantOperationsListener.DeleteTuple>) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

setEntityResourcesToImportOnUpdate(Set<String>) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

setPasswordResetNotification(IPasswordResetNotification) - Method in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

setRequiredAttributes(Set<String>) - Method in class org.apereo.portal.tenants.AttributeValidatingOperationsListener

setSysid(String) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener.DeleteTuple

setType(String) - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener.DeleteTuple

setup() - Method in class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

T

TemplateDataTenantOperationsListener - Class in org.apereo.portal.tenants

Uses Import/Export to create some basic portal data for a new tenant.

TemplateDataTenantOperationsListener() - Constructor for class org.apereo.portal.tenants.TemplateDataTenantOperationsListener

TemplateDataTenantOperationsListener.DeleteTuple - Class in org.apereo.portal.tenants

Used in the implementation of onDelete.

TenantOperationResponse - Class in org.apereo.portal.tenants

This class encapsulates the different items of information that a concrete ITenantOperationsListener might want to communicate back to the service about the process.

TenantOperationResponse(ITenantOperationsListener, TenantOperationResponse.Result) - Constructor for class org.apereo.portal.tenants.TenantOperationResponse

TenantOperationResponse.Result - Enum in org.apereo.portal.tenants

TenantService - Class in org.apereo.portal.tenants

Defines the contract for Tenant operations vis-a-vis other subsystems.

TenantService() - Constructor for class org.apereo.portal.tenants.TenantService

U

updateTenant(ITenant, Map<String, String>, List<TenantOperationResponse>) - Method in class org.apereo.portal.tenants.TenantService

V

validateAttribute(String, String) - Method in class org.apereo.portal.tenants.AbstractTenantOperationsListener

Default implementation is a no-op.

validateAttribute(String, String) - Method in class org.apereo.portal.tenants.AttributeValidatingOperationsListener

validateAttribute(String, String) - Method in interface org.apereo.portal.tenants.ITenantOperationsListener

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

validateAttribute(String, String) - Method in class org.apereo.portal.tenants.ResetPasswordTenantOperationsListener

validateAttribute(String, String) - Method in class org.apereo.portal.tenants.TenantService

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

validateFname(String) - Method in class org.apereo.portal.tenants.TenantService

Throws an exception if the specified String isn't a valid tenant fname.

validateName(String) - Method in class org.apereo.portal.tenants.TenantService

Throws an exception if the specified String isn't a valid tenant name.

valueOf(String) - Static method in enum org.apereo.portal.tenants.TenantOperationResponse.Result

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apereo.portal.tenants.TenantOperationResponse.Result

Returns an array containing the constants of this enum type, in the order they are declared.

A C D F G I J N O R S T U V