Package org.apereo.cas.configuration.model.support.saml.sps

Class AbstractSamlSPProperties

java.lang.Object
org.apereo.cas.configuration.model.support.saml.sps.AbstractSamlSPProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SamlServiceProviderProperties.AcademicHealthPlans, SamlServiceProviderProperties.AdobeCloud, SamlServiceProviderProperties.Amazon, SamlServiceProviderProperties.AppDynamics, SamlServiceProviderProperties.ArcGIS, SamlServiceProviderProperties.ArmsSoftware, SamlServiceProviderProperties.Asana, SamlServiceProviderProperties.BenefitFocus, SamlServiceProviderProperties.BlackBaud, SamlServiceProviderProperties.Box, SamlServiceProviderProperties.Bynder, SamlServiceProviderProperties.CaliforniaCommunityColleges, SamlServiceProviderProperties.CherWell, SamlServiceProviderProperties.ConcurSolutions, SamlServiceProviderProperties.Confluence, SamlServiceProviderProperties.CraniumCafe, SamlServiceProviderProperties.CrashPlan, SamlServiceProviderProperties.DocuSign, SamlServiceProviderProperties.Dropbox, SamlServiceProviderProperties.EasyIep, SamlServiceProviderProperties.Egnyte, SamlServiceProviderProperties.Emma, SamlServiceProviderProperties.EverBridge, SamlServiceProviderProperties.Evernote, SamlServiceProviderProperties.Famis, SamlServiceProviderProperties.Gartner, SamlServiceProviderProperties.Gitlab, SamlServiceProviderProperties.GiveCampus, SamlServiceProviderProperties.InCommon, SamlServiceProviderProperties.InfiniteCampus, SamlServiceProviderProperties.Jira, SamlServiceProviderProperties.NeoGov, SamlServiceProviderProperties.NetPartner, SamlServiceProviderProperties.NewRelic, SamlServiceProviderProperties.Office365, SamlServiceProviderProperties.OpenAthens, SamlServiceProviderProperties.PagerDuty, SamlServiceProviderProperties.PollEverywhere, SamlServiceProviderProperties.Qualtrics, SamlServiceProviderProperties.RocketChat, SamlServiceProviderProperties.SafariOnline, SamlServiceProviderProperties.Salesforce, SamlServiceProviderProperties.SAManage, SamlServiceProviderProperties.SecuringTheHuman, SamlServiceProviderProperties.ServiceNow, SamlServiceProviderProperties.Slack, SamlServiceProviderProperties.SunshineStateEdResearchAlliance, SamlServiceProviderProperties.Symplicity, SamlServiceProviderProperties.Tableau, SamlServiceProviderProperties.TopHat, SamlServiceProviderProperties.WarpWire, SamlServiceProviderProperties.WebAdvisor, SamlServiceProviderProperties.Webex, SamlServiceProviderProperties.Workday, SamlServiceProviderProperties.Yuja, SamlServiceProviderProperties.Zendesk, SamlServiceProviderProperties.Zimbra, SamlServiceProviderProperties.Zoom
@RequiresModule(name="cas-server-support-saml-idp") public abstract class AbstractSamlSPProperties extends Object implements Serializable
This is AbstractSamlSPProperties.
Since:
5.0.0
See Also:

  • Constructor Details

    • AbstractSamlSPProperties

      public AbstractSamlSPProperties()

  • Method Details

    • getMetadata

      public String getMetadata()
      The location of the metadata for this service provider. Can be a URL or another form of resource.

    • getName

      public String getName()
      Name of this service provider.

    • getDescription

      public String getDescription()
      Description of this service provider as it's stored in the registry.

    • getNameIdAttribute

      public String getNameIdAttribute()
      Attribute to use when generating nameids for this SP.

    • getNameIdFormat

      public String getNameIdFormat()
      The forced nameId format to use when generating a response.

    • getAttributes

      public List<String> getAttributes()
      Set up the attribute release policy for this service. Allow attributes that are to be released to this SP. Attributes should be separated by commas and can be virtually mapped and renamed.

    • getSignatureLocation

      public String getSignatureLocation()
      Signature location used to verify metadata.

    • getEntityIds

      public List<String> getEntityIds()
      List of entityIds allowed for this service provider. Multiple ids can be specified in the event that the metadata is an aggregate.

    • isSignResponses

      public boolean isSignResponses()
      Indicate whether responses should be signed.

    • getSignAssertions

      public TriStateBoolean getSignAssertions()
      Indicate whether assertions should be signed.

    • setMetadata

      public AbstractSamlSPProperties setMetadata(String metadata)
      The location of the metadata for this service provider. Can be a URL or another form of resource.
      Returns:
      this.

    • setName

      public AbstractSamlSPProperties setName(String name)
      Name of this service provider.
      Returns:
      this.

    • setDescription

      public AbstractSamlSPProperties setDescription(String description)
      Description of this service provider as it's stored in the registry.
      Returns:
      this.

    • setNameIdAttribute

      public AbstractSamlSPProperties setNameIdAttribute(String nameIdAttribute)
      Attribute to use when generating nameids for this SP.
      Returns:
      this.

    • setNameIdFormat

      public AbstractSamlSPProperties setNameIdFormat(String nameIdFormat)
      The forced nameId format to use when generating a response.
      Returns:
      this.

    • setAttributes

      public AbstractSamlSPProperties setAttributes(List<String> attributes)
      Set up the attribute release policy for this service. Allow attributes that are to be released to this SP. Attributes should be separated by commas and can be virtually mapped and renamed.
      Returns:
      this.

    • setSignatureLocation

      public AbstractSamlSPProperties setSignatureLocation(String signatureLocation)
      Signature location used to verify metadata.
      Returns:
      this.

    • setEntityIds

      public AbstractSamlSPProperties setEntityIds(List<String> entityIds)
      List of entityIds allowed for this service provider. Multiple ids can be specified in the event that the metadata is an aggregate.
      Returns:
      this.

    • setSignResponses

      public AbstractSamlSPProperties setSignResponses(boolean signResponses)
      Indicate whether responses should be signed.
      Returns:
      this.

    • setSignAssertions

      public AbstractSamlSPProperties setSignAssertions(TriStateBoolean signAssertions)
      Indicate whether assertions should be signed.
      Returns:
      this.