Package org.apereo.cas.support.saml.web.idp.metadata

Class SamlRegisteredServiceCachedMetadataEndpoint

java.lang.Object

org.apereo.cas.web.BaseCasActuatorEndpoint

org.apereo.cas.support.saml.web.idp.metadata.SamlRegisteredServiceCachedMetadataEndpoint

@RestControllerEndpoint(id="samlIdPRegisteredServiceMetadataCache",
                        enableByDefault=false)
public class SamlRegisteredServiceCachedMetadataEndpoint
extends org.apereo.cas.web.BaseCasActuatorEndpoint

This is SamlRegisteredServiceCachedMetadataEndpoint.

Since:

6.1.0

Field Summary

Fields inherited from class org.apereo.cas.web.BaseCasActuatorEndpoint

casProperties, MEDIA_TYPE_CAS_YAML, MEDIA_TYPE_SPRING_BOOT_V2_JSON, MEDIA_TYPE_SPRING_BOOT_V3_JSON

Constructor Summary

Constructors

Constructor

Description

SamlRegisteredServiceCachedMetadataEndpoint(org.apereo.cas.configuration.CasConfigurationProperties casProperties, org.apereo.cas.support.saml.services.idp.metadata.cache.SamlRegisteredServiceCachingMetadataResolver cachingMetadataResolver, org.apereo.cas.services.ServicesManager servicesManager, org.apereo.cas.audit.AuditableExecution registeredServiceAccessStrategyEnforcer, org.apereo.cas.support.saml.OpenSamlConfigBean openSamlConfigBean)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<? extends Map>	getCachedMetadataObject(String serviceId, String entityId, boolean force)	Gets cached metadata object.
org.springframework.http.ResponseEntity	invalidate(String serviceId, String entityId)	Invalidate.

Methods inherited from class java.lang.Object

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

Constructor Details

SamlRegisteredServiceCachedMetadataEndpoint

public SamlRegisteredServiceCachedMetadataEndpoint(org.apereo.cas.configuration.CasConfigurationProperties casProperties,
 org.apereo.cas.support.saml.services.idp.metadata.cache.SamlRegisteredServiceCachingMetadataResolver cachingMetadataResolver,
 org.apereo.cas.services.ServicesManager servicesManager,
 org.apereo.cas.audit.AuditableExecution registeredServiceAccessStrategyEnforcer,
 org.apereo.cas.support.saml.OpenSamlConfigBean openSamlConfigBean)

Method Details

invalidate

@DeleteMapping
public org.springframework.http.ResponseEntity invalidate(@Nullable @RequestParam(required=false)
 String serviceId,
 @Nullable @RequestParam(required=false)
 String entityId)

Invalidate.

Parameters:

serviceId - the service id

entityId - the entity id

Returns:

the response entity

getCachedMetadataObject

@GetMapping(produces={"application/vnd.spring-boot.actuator.v2+json","application/vnd.spring-boot.actuator.v3+json","application/x-www-form-urlencoded","application/json","application/vnd.cas.services+yaml"})
public org.springframework.http.ResponseEntity<? extends Map> getCachedMetadataObject(@RequestParam
 String serviceId,
 @Nullable @RequestParam(required=false)
 String entityId,
 @RequestParam(required=false,defaultValue="true")
 boolean force)

Gets cached metadata object.

Parameters:

serviceId - the service id

entityId - the entity id

Returns:

the cached metadata object