Package org.apereo.cas.authentication.principal

Interface ResponseBuilder<T extends WebApplicationService>

Type Parameters:

T - the type parameter

All Superinterfaces:

org.springframework.core.Ordered, Serializable

public interface ResponseBuilder<T extends WebApplicationService>
extends Serializable, org.springframework.core.Ordered

Represents the task of building a CAS response that is returned by a service.

Since:

4.2.0

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
Response	build(T service, String serviceTicketId, Authentication authentication)	Build response.
default boolean	supports(T service)	Supports this service.

Methods inherited from interface org.springframework.core.Ordered

getOrder

Method Details

build

Response build(T service,
 String serviceTicketId,
 Authentication authentication)

Build response. The implementation must produce a response that is based on the type passed. Given the protocol used, the ticket id may be passed as part of the response. If the response type is not recognized, an error must be thrown back.

Parameters:

service - the service

serviceTicketId - the service ticket id

authentication - the authentication

Returns:

the response

supports

default boolean supports(T service)

Supports this service.

Parameters:

service - the service

Returns:

true /false