Package org.apereo.cas.services

Class RegisteredServiceAccessStrategyUtils

java.lang.Object

org.apereo.cas.services.RegisteredServiceAccessStrategyUtils

public class RegisteredServiceAccessStrategyUtils
extends java.lang.Object

This is RegisteredServiceAccessStrategyUtils that encapsulates common operations relevant to registered service access strategy and authorizations. This is a support utility class that acts as a façade around common authorization and access strategy presented in CAS.

Since:

5.0.0

Constructor Summary

Constructors

Constructor	Description
RegisteredServiceAccessStrategyUtils()

Method Summary

Modifier and Type	Method	Description
static boolean	ensurePrincipalAccessIsAllowedForService(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService, java.lang.String principalId, java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)	Ensure principal access is allowed for service.
static void	ensureServiceAccessIsAllowed(java.lang.String service, org.apereo.cas.services.RegisteredService registeredService)	Ensure service access is allowed.
static void	ensureServiceAccessIsAllowed(org.apereo.cas.authentication.principal.Service service, org.apereo.cas.services.RegisteredService registeredService)	Ensure service access is allowed.
static void	ensureServiceAccessIsAllowed(org.apereo.cas.services.RegisteredService registeredService)	Ensure service access is allowed.
static boolean	ensureServiceIsNotExpired(org.apereo.cas.services.RegisteredService registeredService)	Ensure service is not expired.
static void	ensureServiceSsoAccessIsAllowed(org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket)	Ensure service sso access is allowed.
static void	ensureServiceSsoAccessIsAllowed(org.apereo.cas.services.RegisteredService registeredService, org.apereo.cas.authentication.principal.Service service, org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket, boolean credentialsProvided)	Ensure service sso access is allowed.
static java.util.function.Predicate<org.apereo.cas.services.RegisteredService>	getRegisteredServiceExpirationPolicyPredicate()	Gets registered service expiration policy predicate.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredServiceAccessStrategyUtils

public RegisteredServiceAccessStrategyUtils()

Method Detail

ensureServiceAccessIsAllowed

public static void ensureServiceAccessIsAllowed(org.apereo.cas.services.RegisteredService registeredService)

Ensure service access is allowed.

Parameters:

registeredService - the registered service

ensureServiceAccessIsAllowed

public static void ensureServiceAccessIsAllowed(java.lang.String service,
                                                org.apereo.cas.services.RegisteredService registeredService)

Ensure service access is allowed.

Parameters:

service - the service

registeredService - the registered service

ensureServiceAccessIsAllowed

public static void ensureServiceAccessIsAllowed(org.apereo.cas.authentication.principal.Service service,
                                                org.apereo.cas.services.RegisteredService registeredService)

Ensure service access is allowed.

Parameters:

service - the service

registeredService - the registered service

ensureServiceIsNotExpired

public static boolean ensureServiceIsNotExpired(org.apereo.cas.services.RegisteredService registeredService)

Ensure service is not expired.

Parameters:

registeredService - the service

Returns:

boolean - true if service is not expired

ensureServiceSsoAccessIsAllowed

public static void ensureServiceSsoAccessIsAllowed(org.apereo.cas.services.RegisteredService registeredService,
                                                   org.apereo.cas.authentication.principal.Service service,
                                                   org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket)

Ensure service sso access is allowed.

Parameters:

registeredService - the registered service

service - the service

ticketGrantingTicket - the ticket granting ticket

ensureServiceSsoAccessIsAllowed

public static void ensureServiceSsoAccessIsAllowed(org.apereo.cas.services.RegisteredService registeredService,
                                                   org.apereo.cas.authentication.principal.Service service,
                                                   org.apereo.cas.ticket.TicketGrantingTicket ticketGrantingTicket,
                                                   boolean credentialsProvided)

Ensure service sso access is allowed.

Parameters:

registeredService - the registered service

service - the service

ticketGrantingTicket - the ticket granting ticket

credentialsProvided - the credentials provided

ensurePrincipalAccessIsAllowedForService

public static boolean ensurePrincipalAccessIsAllowedForService(org.apereo.cas.authentication.principal.Service service,
                                                               org.apereo.cas.services.RegisteredService registeredService,
                                                               java.lang.String principalId,
                                                               java.util.Map<java.lang.String,java.util.List<java.lang.Object>> attributes)

Ensure principal access is allowed for service.

Parameters:

service - the service

registeredService - the registered service

principalId - the principal id

attributes - the attributes

Returns:

the boolean

getRegisteredServiceExpirationPolicyPredicate

public static java.util.function.Predicate<org.apereo.cas.services.RegisteredService> getRegisteredServiceExpirationPolicyPredicate()

Gets registered service expiration policy predicate.

Returns:

the registered service expiration policy predicate