Package org.apereo.cas.ticket

Interface TicketDefinitionProperties

  • public interface TicketDefinitionProperties
    This is TicketDefinitionProperties. Ticket definition describes additional Properties and misc settings that may be associated with a given ticket to be used by registries. Each CAS module on start up has the ability to register/alter ticket metadata that may be requires for its own specific functionality. Given each CAS module may decide to create many forms of tickets, this facility is specifically provided to dynamically register ticket types and associated properties so modules that deal with registry functionality wouldn't have to statically link to all modules and APIs.

    Ticket definition properties are intended to be treated as generally as possible, so common settings can be shared across all modules that may have similar needs. When adding additional properties, be careful to not tie the setting to a specific technology or terminology, and opt for generality as much as possible.

    Since:
    5.1.0
    See Also:
    TicketCatalog

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getStorageName()
      Generic cache/storage name this ticket may want to associate with itself in cases where persistence is handled by an underlying cache, etc.
      java.lang.String getStoragePassword()
      Describes the credential required to access the storage, if any.
      long getStorageTimeout()
      Describes how long may this ticket definition exist in the underlying storage unit.
      boolean isCascadeRemovals()
      Generically describes if this ticket is linked to all ticket entities such that for normal CRUD operations, cascades may be required.
      boolean isExcludeFromCascade()
      Is exclude from cascade ?
      void setCascadeRemovals​(boolean cascadeTicket)
      Sets cascade ticket.
      void setExcludeFromCascade​(boolean value)
      Sets exclude from cascade.
      void setStorageName​(java.lang.String storageName)
      Sets store name.
      void setStoragePassword​(java.lang.String psw)
      Sets store password if any.
      void setStorageTimeout​(long timeout)
      Sets cache timeout.

    • Method Detail

      • setExcludeFromCascade

        void setExcludeFromCascade​(boolean value)
        Sets exclude from cascade.
        Parameters:
        value - the value

      • isExcludeFromCascade

        boolean isExcludeFromCascade()
        Is exclude from cascade ?
        Returns:
        true/false

      • isCascadeRemovals

        boolean isCascadeRemovals()
        Generically describes if this ticket is linked to all ticket entities such that for normal CRUD operations, cascades may be required.
        Returns:
        true /false

      • setCascadeRemovals

        void setCascadeRemovals​(boolean cascadeTicket)
        Sets cascade ticket.
        Parameters:
        cascadeTicket - the cascade ticket

      • getStorageName

        java.lang.String getStorageName()
        Generic cache/storage name this ticket may want to associate with itself in cases where persistence is handled by an underlying cache, etc.
        Returns:
        the cache name

      • setStorageName

        void setStorageName​(java.lang.String storageName)
        Sets store name.
        Parameters:
        storageName - the cache name

      • getStorageTimeout

        long getStorageTimeout()
        Describes how long may this ticket definition exist in the underlying storage unit. For cache-based storage services, this may translate to idle/max time-to-live, etc.
        Returns:
        the long

      • setStorageTimeout

        void setStorageTimeout​(long timeout)
        Sets cache timeout.
        Parameters:
        timeout - the cache timeout

      • getStoragePassword

        java.lang.String getStoragePassword()
        Describes the credential required to access the storage, if any.
        Returns:
        the psw

      • setStoragePassword

        void setStoragePassword​(java.lang.String psw)
        Sets store password if any.
        Parameters:
        psw - the password for the storage.