Package org.craftercms.profile.api

Class Tenant

  • public class Tenant
extends Object
    A tenant is normally an application that shares common configuration.
    Author:
    avasquez

    • Field Detail

      • cleanseAttributes

        protected boolean cleanseAttributes

    • Constructor Detail

      • Tenant

        public Tenant()

    • Method Detail

      • getId

        public org.bson.types.ObjectId getId()
        Returns the tenant's DB ID.

      • setId

        public void setId​(org.bson.types.ObjectId id)
        Sets the tenant's DB ID.
        Parameters:
        id - the ID

      • getName

        public String getName()
        Returns the name of the tenant.

      • setName

        public void setName​(String name)
        Sets the name of the tenant.

      • isVerifyNewProfiles

        public boolean isVerifyNewProfiles()
        Returns true if new profiles should be verified through email by the user, for the accounts or users of this tenant.

      • setVerifyNewProfiles

        public void setVerifyNewProfiles​(boolean verifyNewProfiles)
        Sets if new profiles should be verified through email by the user, for the accounts or users of this tenant.
        Parameters:
        verifyNewProfiles - true to verify new profiles, false otherwise

      • getAvailableRoles

        public Set<String> getAvailableRoles()
        Returns the available roles that can be assigned to users of this tenant.

      • setAvailableRoles

        public void setAvailableRoles​(Set<String> availableRoles)
        Sets the available roles that can be assigned to users of this tenant.
        Parameters:
        availableRoles - the available roles for users of the tenant.

      • isSsoEnabled

        public boolean isSsoEnabled()
        Returns true is single-sign on (SSO) is enabled for this tenant .

      • setSsoEnabled

        public void setSsoEnabled​(boolean ssoEnabled)
        Sets if single sign-on (SSO) should be enabled for this tenant.

      • getAttributeDefinitions

        public List<AttributeDefinition> getAttributeDefinitions()
        Returns the definitions of attributes that users of this tenant can have.

      • setAttributeDefinitions

        public void setAttributeDefinitions​(List<AttributeDefinition> attributeDefinitions)
        Sets the definitions of attributes that users of this tenant can have.
        Parameters:
        attributeDefinitions - the available attribute definitions for users of the tenant

      • isCleanseAttributes

        public boolean isCleanseAttributes()

      • setCleanseAttributes

        public void setCleanseAttributes​(boolean cleanseAttributes)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object