org.apereo.cas.support.rest

Class TicketsResource

java.lang.Object

org.apereo.cas.support.rest.TicketsResource

@RestController(value="ticketResourceRestController")
public class TicketsResource
extends java.lang.Object

RestController implementation of CAS' REST API.

This class implements main CAS RESTful resource for vending/deleting TGTs and vending STs:

• POST /v1/tickets
• POST /v1/tickets/{TGT-id}
• GET /v1/tickets/{TGT-id}
• DELETE /v1/tickets/{TGT-id}

Since:

4.1.0

Constructor Summary

Constructors

Constructor and Description
TicketsResource()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<java.lang.String>	createServiceTicket(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> requestBody, java.lang.String tgtId) Create new service ticket.
org.springframework.http.ResponseEntity<java.lang.String>	createTicketGrantingTicket(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> requestBody, javax.servlet.http.HttpServletRequest request) Create new ticket granting ticket.
org.springframework.http.ResponseEntity<java.lang.String>	deleteTicketGrantingTicket(java.lang.String tgtId) Destroy ticket granting ticket.
org.apereo.cas.authentication.AuthenticationSystemSupport	getAuthenticationSystemSupport()
org.apereo.cas.CentralAuthenticationService	getCentralAuthenticationService()
CredentialFactory	getCredentialFactory()
org.apereo.cas.ticket.registry.TicketRegistrySupport	getTicketRegistrySupport()
org.springframework.http.ResponseEntity<java.lang.String>	getTicketStatus(java.lang.String id) Determine the status of a given ticket id, whether it's valid, exists, expired, etc.
org.apereo.cas.authentication.principal.ServiceFactory	getWebApplicationServiceFactory()
void	setAuthenticationSystemSupport(org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)
void	setCentralAuthenticationService(org.apereo.cas.CentralAuthenticationService centralAuthenticationService)
void	setCredentialFactory(CredentialFactory credentialFactory)
void	setTicketRegistrySupport(org.apereo.cas.ticket.registry.TicketRegistrySupport ticketRegistrySupport)
void	setWebApplicationServiceFactory(org.apereo.cas.authentication.principal.ServiceFactory webApplicationServiceFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

TicketsResource

public TicketsResource()

Method Detail

createTicketGrantingTicket

@RequestMapping(value="/v1/tickets",
                method=POST,
                consumes="application/x-www-form-urlencoded")
public org.springframework.http.ResponseEntity<java.lang.String> createTicketGrantingTicket(@RequestBody
                                                                                                                                                                                                                               org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> requestBody,
                                                                                                                                                                                                                               javax.servlet.http.HttpServletRequest request)
                                                                                                                                                                                                                        throws com.fasterxml.jackson.core.JsonProcessingException

Create new ticket granting ticket.

Parameters:

requestBody - username and password application/x-www-form-urlencoded values

request - raw HttpServletRequest used to call this method

Returns:

ResponseEntity representing RESTful response

Throws:

com.fasterxml.jackson.core.JsonProcessingException - in case of JSON parsing failure

getTicketStatus

@RequestMapping(value="/v1/tickets/{id:.+}",
                method=GET)
public org.springframework.http.ResponseEntity<java.lang.String> getTicketStatus(@PathVariable(value="id")
                                                                                                                                                            java.lang.String id)

Determine the status of a given ticket id, whether it's valid, exists, expired, etc.

Parameters:

id - ticket id

Returns:

ResponseEntity representing RESTful response

createServiceTicket

@RequestMapping(value="/v1/tickets/{tgtId:.+}",
                method=POST,
                consumes="application/x-www-form-urlencoded")
public org.springframework.http.ResponseEntity<java.lang.String> createServiceTicket(@RequestBody
                                                                                                                                                                                                                                   org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> requestBody,
                                                                                                                                                                                                                                   @PathVariable(value="tgtId")
                                                                                                                                                                                                                                   java.lang.String tgtId)

Create new service ticket.

Parameters:

requestBody - service application/x-www-form-urlencoded value

tgtId - ticket granting ticket id URI path param

Returns:

ResponseEntity representing RESTful response

deleteTicketGrantingTicket

@RequestMapping(value="/v1/tickets/{tgtId:.+}",
                method=DELETE)
public org.springframework.http.ResponseEntity<java.lang.String> deleteTicketGrantingTicket(@PathVariable(value="tgtId")
                                                                                                                                                                             java.lang.String tgtId)

Destroy ticket granting ticket.

Parameters:

tgtId - ticket granting ticket id URI path param

Returns:

ResponseEntity representing RESTful response. Signals HttpStatus.OK when successful.

setAuthenticationSystemSupport

public void setAuthenticationSystemSupport(org.apereo.cas.authentication.AuthenticationSystemSupport authenticationSystemSupport)

setWebApplicationServiceFactory

public void setWebApplicationServiceFactory(org.apereo.cas.authentication.principal.ServiceFactory webApplicationServiceFactory)

setTicketRegistrySupport

public void setTicketRegistrySupport(org.apereo.cas.ticket.registry.TicketRegistrySupport ticketRegistrySupport)

setCentralAuthenticationService

public void setCentralAuthenticationService(org.apereo.cas.CentralAuthenticationService centralAuthenticationService)

getCentralAuthenticationService

public org.apereo.cas.CentralAuthenticationService getCentralAuthenticationService()

getAuthenticationSystemSupport

public org.apereo.cas.authentication.AuthenticationSystemSupport getAuthenticationSystemSupport()

getCredentialFactory

public CredentialFactory getCredentialFactory()

getWebApplicationServiceFactory

public org.apereo.cas.authentication.principal.ServiceFactory getWebApplicationServiceFactory()

getTicketRegistrySupport

public org.apereo.cas.ticket.registry.TicketRegistrySupport getTicketRegistrySupport()

setCredentialFactory

public void setCredentialFactory(CredentialFactory credentialFactory)