Package org.apache.sling.tenant
Interface Tenant
@ProviderType
public interface Tenant
The
Tenant
interface represents a tenant which may be used to
further customize request and other processing.
This interface is intended to be implemented by the implementor of the
TenantProvider
interface to be returned by the tenant accessor
methods.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The name of theproperty
whose string representation is used as this tenant'sdescription
(value is "sling.tenant.description").static final String
-
Method Summary
Modifier and TypeMethodDescriptionReturns a human readable description of this tenant.getId()
Returns the unique identifier of this tenant.getName()
Returns the name of the tenant.getProperty
(String name) Returns the named property ornull
if no such property exists or if the property value itself isnull
.<Type> Type
getProperty
(String name, Type type) Returns the named property converted to the requested type ornull
if the property does not exist, the property value itself isnull
or cannot be converted to the requested type.Returns an iterator or String values representing the names of defined properties of this tenant.
-
Field Details
-
PROP_NAME
The name of theproperty
whose string representation is used as this tenant'sname
(value is "sling.tenant.name").- See Also:
-
PROP_DESCRIPTION
The name of theproperty
whose string representation is used as this tenant'sdescription
(value is "sling.tenant.description").- See Also:
-
-
Method Details
-
getId
String getId()Returns the unique identifier of this tenant.The tenant identifier has not predefined mapping to a property and may be generated automatically by the TenantProvider.
-
getName
String getName()Returns the name of the tenant. This is a short name for quickly identifying this tenant. This name is not required to be globally unique.The name of the tenant is the string representation of the
PROP_NAME
property ornull
if the property is not defined. -
getDescription
String getDescription()Returns a human readable description of this tenant.The description of the tenant is the string representation of the
PROP_DESCRIPTION
property ornull
if the property is not defined. -
getProperty
Returns the named property ornull
if no such property exists or if the property value itself isnull
. -
getProperty
Returns the named property converted to the requested type ornull
if the property does not exist, the property value itself isnull
or cannot be converted to the requested type. -
getPropertyNames
Returns an iterator or String values representing the names of defined properties of this tenant.
-