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(AuthenticationSystemSupport authenticationSystemSupport, CredentialFactory credentialFactory, TicketRegistrySupport ticketRegistrySupport, ServiceFactory webApplicationServiceFactory, CentralAuthenticationService centralAuthenticationService)

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.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TicketsResource

public TicketsResource(AuthenticationSystemSupport authenticationSystemSupport,
                       CredentialFactory credentialFactory,
                       TicketRegistrySupport ticketRegistrySupport,
                       ServiceFactory webApplicationServiceFactory,
                       CentralAuthenticationService centralAuthenticationService)

Method Detail

createTicketGrantingTicket

@PostMapping(value="/v1/tickets",
             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

@GetMapping(value="/v1/tickets/{id:.+}")
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

@PostMapping(value="/v1/tickets/{tgtId:.+}",
             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

@DeleteMapping(value="/v1/tickets/{tgtId:.+}")
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.