Package edu.suffolk.litlab.efspserver.services

Class CodesService

java.lang.Object
edu.suffolk.litlab.efspserver.services.CodesService
Direct Known Subclasses:
CourtsOnlyCodesService, EcfCodesService
@Produces("application/json") public abstract class CodesService extends Object
The endpoints for the court specific configurations that clients need to use to file properly. "Codes" is short for genericodes, a XML standard that ECF uses to communicate these configurations to EFSPs, and we use it to refer to any such court configurations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CodesService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static jakarta.ws.rs.core.Response
    cors(jakarta.ws.rs.core.Response.ResponseBuilder rb)
    Adds proper CORS headers to all responses to the codes API, which is public
    abstract jakarta.ws.rs.core.Response
    getAll()
     
    abstract jakarta.ws.rs.core.Response
    getCodesUnderCourt(String courtId)
     
    abstract jakarta.ws.rs.core.Response
    getCourtLocationCodes(String courtId)
     
    abstract jakarta.ws.rs.core.Response
    getCourts(jakarta.ws.rs.core.HttpHeaders httpHeaders, boolean fileable, boolean withNames)
     
    jakarta.ws.rs.core.Response
    options()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CodesService

      public CodesService()

  • Method Details

    • getAll

      @GET @Path("/") @Produces("application/json") public abstract jakarta.ws.rs.core.Response getAll()

    • getCourts

      @GET @Path("/courts") public abstract jakarta.ws.rs.core.Response getCourts(@Context jakarta.ws.rs.core.HttpHeaders httpHeaders, @DefaultValue("false") @QueryParam("fileable_only") boolean fileable, @DefaultValue("false") @QueryParam("with_names") boolean withNames)

    • getCodesUnderCourt

      @GET @Path("/courts/{court_id}") public abstract jakarta.ws.rs.core.Response getCodesUnderCourt(@PathParam("court_id") String courtId)

    • getCourtLocationCodes

      @GET @Path("/courts/{court_id}/codes") public abstract jakarta.ws.rs.core.Response getCourtLocationCodes(@PathParam("court_id") String courtId)

    • cors

      protected static jakarta.ws.rs.core.Response cors(jakarta.ws.rs.core.Response.ResponseBuilder rb)
      Adds proper CORS headers to all responses to the codes API, which is public

      See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS and https://stackoverflow.com/a/28996470/11416267.

    • options

      @OPTIONS @Path("{path : .*}") public jakarta.ws.rs.core.Response options()