# Index

C D G O P R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## C

change(Tenant) - Method in interface org.apache.sling.tenant.spi.TenantManagerHook
  Method called to update the given tenant.
create(String, Map<String, Object>) - Method in interface org.apache.sling.tenant.TenantManager
  Creates a new tenant with the given tenant ID and the initial set of properties.

## D

dispose() - Method in class org.apache.sling.tenant.internal.console.WebConsolePlugin
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.sling.tenant.internal.console.WebConsolePlugin
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.sling.tenant.internal.console.WebConsolePlugin

## G

getDescription() - Method in interface org.apache.sling.tenant.Tenant
  Returns a human readable description of this tenant.
getId() - Method in interface org.apache.sling.tenant.Tenant
  Returns the unique identifier of this tenant.
getName() - Method in interface org.apache.sling.tenant.Tenant
  Returns the name of the tenant.
getProperty(String) - Method in interface org.apache.sling.tenant.Tenant
  Returns the named property or `null` if no such property exists or if the property value itself is `null`.
getProperty(String, Type) - Method in interface org.apache.sling.tenant.Tenant
  Returns the named property converted to the requested type or `null` if the property does not exist, the property value itself is `null` or cannot be converted to the requested type.
getPropertyNames() - Method in interface org.apache.sling.tenant.Tenant
  Returns an iterator or String values representing the names of defined properties of this tenant.
getTenant(String) - Method in interface org.apache.sling.tenant.TenantProvider
  Returns the `Tenant` with the given `tenantId` or `null` if no such tenant exists.
getTenants() - Method in interface org.apache.sling.tenant.TenantProvider
  Returns an iterator of all `tenants` known to this provider.
getTenants(String) - Method in interface org.apache.sling.tenant.TenantProvider
  Returns an iterator of `tenants` matching the given `tenantFilter`.

## O

org.apache.sling.tenant - package org.apache.sling.tenant
org.apache.sling.tenant.internal.console - package org.apache.sling.tenant.internal.console
org.apache.sling.tenant.spi - package org.apache.sling.tenant.spi

## P

PROP_DESCRIPTION - Static variable in interface org.apache.sling.tenant.Tenant
  The name of the `property` whose string representation is used as this tenant's `description` (value is "sling.tenant.description").
PROP_NAME - Static variable in interface org.apache.sling.tenant.Tenant
  The name of the `property` whose string representation is used as this tenant's `name` (value is "sling.tenant.name").

## R

remove(Tenant) - Method in interface org.apache.sling.tenant.spi.TenantManagerHook
  Called to remove the setup for the given Tenant.
remove(Tenant) - Method in interface org.apache.sling.tenant.TenantManager
  Removes the given tenant.
remove(Tenant, ResourceResolver) - Method in interface org.apache.sling.tenant.spi.TenantCustomizer
  Deprecated.
  Called to remove the setup for the given Tenant.
removeProperties(Tenant, String...) - Method in interface org.apache.sling.tenant.TenantManager
  Removes one or more properties from the tenant.

## S

setProperties(Tenant, Map<String, Object>) - Method in interface org.apache.sling.tenant.TenantManager
  Sets or removes multiple properties on the tenant.
setProperty(Tenant, String, Object) - Method in interface org.apache.sling.tenant.TenantManager
  Sets a single property of the tenant to a new value or removes the property if the value is `null`.
setup(Tenant) - Method in interface org.apache.sling.tenant.spi.TenantManagerHook
  Method called to create the given tenant.
setup(Tenant, ResourceResolver) - Method in interface org.apache.sling.tenant.spi.TenantCustomizer
  Deprecated.
  Method called to create or update the given tenant.

## T

Tenant - Interface in org.apache.sling.tenant
  The `Tenant` interface represents a tenant which may be used to further customize request and other processing.
TenantCustomizer - Interface in org.apache.sling.tenant.spi
  Deprecated.
  This interface will not be supported in future versions. Use `TenantManagerHook` instead.
TenantManager - Interface in org.apache.sling.tenant
  The `TenantManager` service interface defines the API that administrative tools will use to created, update or remove Tenants.
TenantManagerHook - Interface in org.apache.sling.tenant.spi
  This is a service interface to customize tenant setup and administration.
TenantProvider - Interface in org.apache.sling.tenant
  The `TenantProvider` defines the service interface which may be asked for `tenant instances`.

## W

WebConsolePlugin - Class in org.apache.sling.tenant.internal.console
  This is a webconsole plugin displaying the active queues, some statistics and the configurations.
WebConsolePlugin(BundleContext, TenantProviderImpl, XSSAPI) - Constructor for class org.apache.sling.tenant.internal.console.WebConsolePlugin

C D G O P R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form