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
    @Entity
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 
      Modifier and Type Method Description
      int compareTo​(org.apereo.cas.services.RegisteredService other)  
      java.util.List<org.apereo.cas.services.RegisteredServiceContact> getContacts()  
      java.util.Map<java.lang.String,​org.apereo.cas.services.RegisteredServiceProperty> getProperties()  
      void initialize()  
      protected abstract AbstractRegisteredService newInstance()
      Create a new service instance.
      void setContacts​(java.util.List<org.apereo.cas.services.RegisteredServiceContact> contacts)  
      void setProperties​(java.util.Map<java.lang.String,​org.apereo.cas.services.RegisteredServiceProperty> properties)  
      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

        getAccessStrategy, getAttributeReleasePolicy, getDescription, getEnvironments, getEvaluationOrder, getExpirationPolicy, getFriendlyName, getId, getInformationUrl, getLogo, getLogoutType, getLogoutUrl, getMultifactorPolicy, getName, getPrivacyUrl, getProxyPolicy, getPublicKey, getRequiredHandlers, getResponseType, getServiceId, getTheme, 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

      • initialize

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

      • 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>

      • newInstance

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

      • getProperties

        public java.util.Map<java.lang.String,​org.apereo.cas.services.RegisteredServiceProperty> getProperties()
        Specified by:
        getProperties in interface org.apereo.cas.services.RegisteredService

      • setProperties

        public void setProperties​(java.util.Map<java.lang.String,​org.apereo.cas.services.RegisteredServiceProperty> properties)

      • getContacts

        public java.util.List<org.apereo.cas.services.RegisteredServiceContact> getContacts()
        Specified by:
        getContacts in interface org.apereo.cas.services.RegisteredService

      • setContacts

        public void setContacts​(java.util.List<org.apereo.cas.services.RegisteredServiceContact> contacts)