Package org.apereo.cas.services

Class AbstractRegisteredService

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<org.apereo.cas.services.RegisteredService>, org.apereo.cas.services.RegisteredService
    Direct Known Subclasses:
    RegexRegisteredService
    public abstract class AbstractRegisteredService
extends java.lang.Object
implements org.apereo.cas.services.RegisteredService
    Base class for mutable, persistable registered services.
    Since:
    3.0.0
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String serviceId
      The unique identifier for this service.

      • Fields inherited from interface org.apereo.cas.services.RegisteredService

        INITIAL_IDENTIFIER_VALUE

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int compareTo​(org.apereo.cas.services.RegisteredService other)  
      java.util.Set<java.lang.String> getRequiredHandlers()
      Deprecated.
      void initialize()  
      protected abstract AbstractRegisteredService newInstance()
      Create a new service instance.
      void setRequiredHandlers​(java.util.Set<java.lang.String> requiredHandlers)
      Deprecated.
      Since 6.2
      abstract void setServiceId​(java.lang.String id)
      Sets the service identifier.

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apereo.cas.services.RegisteredService

        getAcceptableUsagePolicy, getAccessStrategy, getAttributeReleasePolicy, getAuthenticationPolicy, getContacts, getDescription, getEnvironments, getEvaluationOrder, getEvaluationPriority, getExpirationPolicy, getFriendlyName, getId, getInformationUrl, getLogo, getLogoutType, getLogoutUrl, getMatchingStrategy, getMultifactorPolicy, getName, getPrivacyUrl, getProperties, getProxyGrantingTicketExpirationPolicy, getProxyPolicy, getProxyTicketExpirationPolicy, getPublicKey, getRedirectUrl, getResponseType, getServiceId, getServiceTicketExpirationPolicy, getSingleSignOnParticipationPolicy, getTheme, getTicketGrantingTicketExpirationPolicy, getUsernameAttributeProvider, matches, matches, setEvaluationOrder, setId

    • Field Detail

      • serviceId

        protected java.lang.String serviceId
        The unique identifier for this service.

    • Constructor Detail

      • AbstractRegisteredService

        public AbstractRegisteredService()

    • Method Detail

      • setServiceId

        public abstract void setServiceId​(java.lang.String id)
        Sets the service identifier. Extensions are to define the format.
        Parameters:
        id - the new service id

      • compareTo

        public int compareTo​(org.apereo.cas.services.RegisteredService other)
        Specified by:
        compareTo in interface java.lang.Comparable<org.apereo.cas.services.RegisteredService>

      • getRequiredHandlers

        @Deprecated(since="6.2.0")
public java.util.Set<java.lang.String> getRequiredHandlers()
        Deprecated.
        Specified by:
        getRequiredHandlers in interface org.apereo.cas.services.RegisteredService

      • setRequiredHandlers

        @Deprecated(since="6.2.0")
public void setRequiredHandlers​(java.util.Set<java.lang.String> requiredHandlers)
        Deprecated.
        Since 6.2
        Sets required handlers.
        Parameters:
        requiredHandlers - the required handlers

      • initialize

        public void initialize()
        Specified by:
        initialize in interface org.apereo.cas.services.RegisteredService

      • newInstance

        protected abstract AbstractRegisteredService newInstance()
        Create a new service instance.
        Returns:
        the registered service