org.apereo.portal.tenants

Class TenantService

java.lang.Object

org.apereo.portal.tenants.TenantService

@Service
public class TenantService
extends java.lang.Object

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

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
TenantService()

Method Summary

Modifier and Type	Method and Description
org.apereo.portal.tenants.ITenant	createTenant(java.lang.String name, java.lang.String fname, java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Set<java.lang.String> skipListenerFnames, java.util.List<TenantOperationResponse> responses)
void	deleteTenantByFName(java.lang.String fname, java.util.List<TenantOperationResponse> responses)
boolean	fnameExists(java.lang.String fname) Returns true if a tenant with the specified fname exists, otherwise false.
ITenantManagementAction	getAction(java.lang.String fname)
java.util.Set<ITenantManagementAction>	getAllAvaialableActions() Complete set of actions from all listeners
java.util.List<ITenantOperationsListener>	getOptionalOperationsListeners() List of the fnames of currently configured ITenantOperationsListener objects that may be omitted, presented in their natural (sequential) order.
org.apereo.portal.tenants.ITenant	getTenantByFName(java.lang.String fname)
java.util.List<org.apereo.portal.tenants.ITenant>	getTenantsList() Provides the complete collection of tenants in the system in the default order (alphabetically by name).
void	init()
boolean	nameExists(java.lang.String name) Returns true if a tenant with the specified name exists, otherwise false.
org.apereo.portal.tenants.ITenant	updateTenant(org.apereo.portal.tenants.ITenant tenant, java.util.Map<java.lang.String,java.lang.String> attributes, java.util.List<TenantOperationResponse> responses)
void	validateAttribute(java.lang.String key, java.lang.String value) Throws an exception if any indicates that the specified value isn't allowable for the specified attribute.
void	validateFname(java.lang.String fname) Throws an exception if the specified String isn't a valid tenant fname.
void	validateName(java.lang.String name) Throws an exception if the specified String isn't a valid tenant name.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantService

public TenantService()

Method Detail

init

@PostConstruct
public void init()

Since:

4.3

getTenantByFName

public org.apereo.portal.tenants.ITenant getTenantByFName(java.lang.String fname)

Since:

4.3

getTenantsList

public java.util.List<org.apereo.portal.tenants.ITenant> getTenantsList()

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

createTenant

public org.apereo.portal.tenants.ITenant createTenant(java.lang.String name,
                                                      java.lang.String fname,
                                                      java.util.Map<java.lang.String,java.lang.String> attributes,
                                                      java.util.Set<java.lang.String> skipListenerFnames,
                                                      java.util.List<TenantOperationResponse> responses)

updateTenant

public org.apereo.portal.tenants.ITenant updateTenant(org.apereo.portal.tenants.ITenant tenant,
                                                      java.util.Map<java.lang.String,java.lang.String> attributes,
                                                      java.util.List<TenantOperationResponse> responses)

deleteTenantByFName

public void deleteTenantByFName(java.lang.String fname,
                                java.util.List<TenantOperationResponse> responses)

getOptionalOperationsListeners

public java.util.List<ITenantOperationsListener> getOptionalOperationsListeners()

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

Since:

4.3

getAllAvaialableActions

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

Complete set of actions from all listeners

Since:

4.3

getAction

public ITenantManagementAction getAction(java.lang.String fname)

Since:

4.3

nameExists

public boolean nameExists(java.lang.String name)

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

Since:

4.3

fnameExists

public boolean fnameExists(java.lang.String fname)

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

Since:

4.3

validateName

public void validateName(java.lang.String name)

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

Since:

4.3

validateFname

public void validateFname(java.lang.String fname)

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

Since:

4.3

validateAttribute

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

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

Throws:

java.lang.Exception

Since:

4.3