org.apereo.cas.services

Class JsonServiceRegistryDao

java.lang.Object

org.apereo.cas.services.AbstractServiceRegistryDao

org.apereo.cas.services.AbstractResourceBasedServiceRegistryDao

org.apereo.cas.services.JsonServiceRegistryDao

All Implemented Interfaces:

org.apereo.cas.services.ResourceBasedServiceRegistryDao, org.apereo.cas.services.ServiceRegistryDao

public class JsonServiceRegistryDao
extends org.apereo.cas.services.AbstractResourceBasedServiceRegistryDao

Implementation of ServiceRegistryDao that reads services definition from JSON configuration file at the Spring Application Context initialization time. JSON files are expected to be found inside a directory location and this registry will recursively look through the directory structure to find relevant JSON files. Files are expected to have the extension. An example of the JSON file is included here:

 {
 "@class" : "RegexRegisteredService",
 "id" : 103935657744185,
 "description" : "This is the application description",
 "serviceId" : "https://app.school.edu",
 "name" : "testSaveAttributeReleasePolicyAllowedAttrRulesAndFilter",
 "theme" : "testtheme",
 "proxyPolicy" : {
 "@class" : "RegexMatchingRegisteredServiceProxyPolicy",
 "pattern" : "https://.+"
 },
 "enabled" : true,
 "ssoEnabled" : false,
 "evaluationOrder" : 1000,
 "usernameAttributeProvider" : {
 "@class" : "DefaultRegisteredServiceUsernameProvider"
 },
 "logoutType" : "BACK_CHANNEL",
 "requiredHandlers" : [ "java.util.HashSet", [ "handler1", "handler2" ] ],
 "attributeReleasePolicy" : {
 "@class" : "ReturnAllowedAttributeReleasePolicy",
 "attributeFilter" : {
 "@class" : "RegisteredServiceRegexAttributeFilter",
 "pattern" : "\\w+"
 },
 "allowedAttributes" : [ "java.util.ArrayList", [ "uid", "sn", "cn" ] ]
 }
 }
 

Since:

4.1.0

Field Summary

Fields inherited from class org.apereo.cas.services.AbstractResourceBasedServiceRegistryDao

serviceRegistryDirectory

Fields inherited from class org.apereo.cas.services.AbstractServiceRegistryDao

casEventConsumer

Constructor Summary

Constructors

Constructor and Description
JsonServiceRegistryDao(java.nio.file.Path configDirectory, boolean enableWatcher, org.springframework.context.ApplicationEventPublisher eventPublisher) Instantiates a new Json service registry dao.
JsonServiceRegistryDao(org.springframework.core.io.Resource configDirectory, boolean enableWatcher, org.springframework.context.ApplicationEventPublisher eventPublisher) Instantiates a new Json service registry dao.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getExtension()

Methods inherited from class org.apereo.cas.services.AbstractResourceBasedServiceRegistryDao

delete, destroy, findServiceById, findServiceById, load, load, makeFile, save, size, toString, update

Methods inherited from class org.apereo.cas.services.AbstractServiceRegistryDao

findServiceByExactServiceId, getName, publishEvent, setEventPublisher

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.services.ServiceRegistryDao

findServiceByExactServiceId, getName

Constructor Detail

JsonServiceRegistryDao

public JsonServiceRegistryDao(java.nio.file.Path configDirectory,
                              boolean enableWatcher,
                              org.springframework.context.ApplicationEventPublisher eventPublisher)

Instantiates a new Json service registry dao. Sets the path to the directory where JSON service registry entries are stored. Uses the DefaultRegisteredServiceJsonSerializer by default.

Parameters:

configDirectory - the config directory where service registry files can be found.

enableWatcher - the enable watcher

eventPublisher - the event publisher

JsonServiceRegistryDao

public JsonServiceRegistryDao(org.springframework.core.io.Resource configDirectory,
                              boolean enableWatcher,
                              org.springframework.context.ApplicationEventPublisher eventPublisher)
                       throws java.lang.Exception

Instantiates a new Json service registry dao. Sets the path to the directory where JSON service registry entries are stored. Uses the DefaultRegisteredServiceJsonSerializer by default.

Parameters:

configDirectory - the config directory where service registry files can be found.

enableWatcher - the enable watcher

eventPublisher - the event publisher

Throws:

java.lang.Exception - the IO exception

Method Detail

getExtension

protected java.lang.String getExtension()

Specified by:

getExtension in class org.apereo.cas.services.AbstractResourceBasedServiceRegistryDao