ball.tv.epg.sd

Interface SDProtocol

@Protocol(charset="UTF-8")
 @ApplicationPath(value="https://json.schedulesdirect.org/")
public interface SDProtocol

Protocol specification for SchedulesDirect/JSON-Service.

Version:

$Revision: 5830 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SDProtocol.GetLineupsResponse getLineups(String) return type.
static class	SDProtocol.GetStatusResponse getStatus(String) return type.
static class	SDProtocol.GetVersionResponse getVersion(String) return type.
static class	SDProtocol.LineupElement getStatus(String) line-up element.
static class	SDProtocol.PostTokenResponse postToken(HttpEntity) return type.
static class	SDProtocol.Schedules postSchedules(String,Collection) return type.

Method Summary

Modifier and Type	Method and Description
JsonNode	deleteLineup(String token, String lineup) Delete a lineup from a user's account
JsonNode	getAvailable() Obtain the list of available services
JsonNode	getAvailableCountries() Obtain the list of available services
JsonNode	getAvailableLanguages() Obtain the list of available services
JsonNode	getCelebrityMetadata(String celebrity) Retrieving images for a particular celebrity
List<Headend>	getHeadends(String token, String country, String postalcode) Obtain the list of headends in a postal code
HttpResponse	getImage(String uri) Retrieving an image
HttpResponse	getImage(URI uri) Retrieving an image
Lineup	getLineup(String token, Boolean verboseMap, String lineup) StationID / channel mapping for a lineup
SDProtocol.GetLineupsResponse	getLineups(String token) List the lineups a user has added to their account
JsonNode	getProgramMetadata(String root) Retrieving JSON index based on rootId
SDProtocol.GetStatusResponse	getStatus(String token) Gettting status
SDProtocol.GetVersionResponse	getVersion(String client) Determine if the client is the correct version
JsonNode	postLineup(String token, HttpEntity entity) Automapping a lineup
JsonNode	postLineup(String token, String lineup, HttpEntity entity) Automapping a lineup Submit a line-up.
List<Program>	postPrograms(String token, Collection<String> ids) Download program information
JsonNode	postProgramsDescription(String token, Collection<String> ids) Downloading a generic description of a program
JsonNode	postProgramsMetadata(String token, Collection<String> ids) Retrieving JSON index based on programID
List<SDProtocol.Schedules>	postSchedules(String token, Collection<Map<String,Object>> collection) Download the schedules for stationIDs
JsonNode	postSchedulesMD5(String token, Collection<Map<String,Object>> collection) Download the MD5 and lastModified for stationIDs
default SDProtocol.PostTokenResponse	postToken(File file) See postToken(HttpEntity).
SDProtocol.PostTokenResponse	postToken(HttpEntity entity) Obtain a token
JsonNode	putLineup(String token, String lineup) Add a lineup to a user's Schedules Direct account

Method Detail

postToken

@POST
 @Path(value="20141201/token")
SDProtocol.PostTokenResponse postToken(HttpEntity entity)
                                                                     throws HttpResponseException,
                                                                            ClientProtocolException,
                                                                            IOException

Obtain a token

Parameters:

entity - The user's credentials.

Returns:

The SDProtocol.PostTokenResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postToken

default SDProtocol.PostTokenResponse postToken(File file)
                                        throws HttpResponseException,
                                               ClientProtocolException,
                                               IOException

See postToken(HttpEntity).

Parameters:

file - The user's credential File.

Returns:

The SDProtocol.PostTokenResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getStatus

@GET
 @Path(value="20141201/status")
SDProtocol.GetStatusResponse getStatus(@HeaderParam(value="")
                                                                            String token)
                                                                     throws HttpResponseException,
                                                                            ClientProtocolException,
                                                                            IOException

Gettting status

Parameters:

token - The token.

Returns:

The SDProtocol.GetStatusResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getVersion

@GET
 @Path(value="20141201/version/{client}")
SDProtocol.GetVersionResponse getVersion(@PathParam(value="")
                                                                                        String client)
                                                                                 throws HttpResponseException,
                                                                                        ClientProtocolException,
                                                                                        IOException

Determine if the client is the correct version

Parameters:

client - The client identifier.

Returns:

The SDProtocol.GetVersionResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getAvailable

@GET
 @Path(value="20141201/available")
JsonNode getAvailable()
                                                       throws HttpResponseException,
                                                              ClientProtocolException,
                                                              IOException

Obtain the list of available services

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getAvailableCountries

@GET
 @Path(value="20141201/available/countries")
JsonNode getAvailableCountries()
                                                                          throws HttpResponseException,
                                                                                 ClientProtocolException,
                                                                                 IOException

Obtain the list of available services

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getAvailableLanguages

@GET
 @Path(value="20141201/available/languages")
JsonNode getAvailableLanguages()
                                                                          throws HttpResponseException,
                                                                                 ClientProtocolException,
                                                                                 IOException

Obtain the list of available services

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getHeadends

@GET
 @Path(value="20141201/headends")
List<Headend> getHeadends(@HeaderParam(value="")
                                                                 String token,
                                                                 @QueryParam(value="")
                                                                 String country,
                                                                 @QueryParam(value="")
                                                                 String postalcode)
                                                          throws HttpResponseException,
                                                                 ClientProtocolException,
                                                                 IOException

Obtain the list of headends in a postal code

Parameters:

token - The token.

country - The country.

postalcode - The postal (ZIP) code.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getLineups

@GET
 @Path(value="20141201/lineups")
SDProtocol.GetLineupsResponse getLineups(@HeaderParam(value="")
                                                                               String token)
                                                                        throws HttpResponseException,
                                                                               ClientProtocolException,
                                                                               IOException

List the lineups a user has added to their account

Parameters:

token - The token.

Returns:

The SDProtocol.GetLineupsResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

deleteLineup

@DELETE
 @Path(value="20141201/lineups/{lineup}")
JsonNode deleteLineup(@HeaderParam(value="")
                                                                        String token,
                                                                        @PathParam(value="")
                                                                        String lineup)
                                                                 throws HttpResponseException,
                                                                        ClientProtocolException,
                                                                        IOException

Delete a lineup from a user's account

Parameters:

token - The token.

lineup - The line-up to be deleted.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

putLineup

@PUT
 @Path(value="20141201/lineups/{lineup}")
JsonNode putLineup(@HeaderParam(value="")
                                                                  String token,
                                                                  @PathParam(value="")
                                                                  String lineup)
                                                           throws HttpResponseException,
                                                                  ClientProtocolException,
                                                                  IOException

Add a lineup to a user's Schedules Direct account

Parameters:

token - The token.

lineup - The line-up to add.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getLineup

@GET
 @Path(value="20141201/lineups/{lineup}")
Lineup getLineup(@HeaderParam(value="")
                                                                String token,
                                                                @HeaderParam(value="")
                                                                Boolean verboseMap,
                                                                @PathParam(value="")
                                                                String lineup)
                                                         throws HttpResponseException,
                                                                ClientProtocolException,
                                                                IOException

StationID / channel mapping for a lineup

Parameters:

token - The token.

verboseMap - Whether or not tp provide a verbose map.

lineup - The lineup (may be null).

Returns:

The Lineup.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postLineup

@POST
 @Path(value="20141201/map/lineup/")
JsonNode postLineup(@HeaderParam(value="")
                                                               String token,
                                                               HttpEntity entity)
                                                        throws HttpResponseException,
                                                               ClientProtocolException,
                                                               IOException

Automapping a lineup

Parameters:

token - The token.

entity - The HttpEntity.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postLineup

@POST
 @Path(value="20141201/map/lineup/{lineup}")
JsonNode postLineup(@HeaderParam(value="")
                                                                       String token,
                                                                       @PathParam(value="")
                                                                       String lineup,
                                                                       HttpEntity entity)
                                                                throws HttpResponseException,
                                                                       ClientProtocolException,
                                                                       IOException

Automapping a lineup Submit a line-up.

Parameters:

token - The token.

lineup - The lineup.

entity - The HttpEntity.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postPrograms

@POST
 @Path(value="20141201/programs")
List<Program> postPrograms(@HeaderParam(value="")
                                                                   String token,
                                                                   Collection<String> ids)
                                                            throws HttpResponseException,
                                                                   ClientProtocolException,
                                                                   IOException

Download program information

Parameters:

token - The token.

ids - The program IDs.

Returns:

The List of Programs.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postProgramsDescription

@POST
 @Path(value="20141201/metadata/description")
JsonNode postProgramsDescription(@HeaderParam(value="")
                                                                                     String token,
                                                                                     Collection<String> ids)
                                                                              throws HttpResponseException,
                                                                                     ClientProtocolException,
                                                                                     IOException

Downloading a generic description of a program

Parameters:

token - The token.

ids - The program IDs.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postProgramsMetadata

@POST
 @Path(value="20141201/metadata/programs")
JsonNode postProgramsMetadata(@HeaderParam(value="")
                                                                               String token,
                                                                               Collection<String> ids)
                                                                        throws HttpResponseException,
                                                                               ClientProtocolException,
                                                                               IOException

Retrieving JSON index based on programID

Parameters:

token - The token.

ids - The program IDs.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getProgramMetadata

@GET
 @Path(value="20141201/metadata/programs/{root}")
JsonNode getProgramMetadata(@PathParam(value="")
                                                                                   String root)
                                                                            throws HttpResponseException,
                                                                                   ClientProtocolException,
                                                                                   IOException

Retrieving JSON index based on rootId

Parameters:

root - The root ID.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postSchedules

@POST
 @Path(value="20141201/schedules")
List<SDProtocol.Schedules> postSchedules(@HeaderParam(value="")
                                                                                  String token,
                                                                                  Collection<Map<String,Object>> collection)
                                                                           throws HttpResponseException,
                                                                                  ClientProtocolException,
                                                                                  IOException

Download the schedules for stationIDs

Parameters:

token - The token.

collection - The Collection (use SDClient.PostSchedulesMap.values()).

Returns:

The List of SDProtocol.Schedules.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

postSchedulesMD5

@POST
 @Path(value="20141201/schedules/md5")
JsonNode postSchedulesMD5(@HeaderParam(value="")
                                                                       String token,
                                                                       Collection<Map<String,Object>> collection)
                                                                throws HttpResponseException,
                                                                       ClientProtocolException,
                                                                       IOException

Download the MD5 and lastModified for stationIDs

Parameters:

token - The token.

collection - The Collection (use SDClient.PostSchedulesMap.values()).

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getCelebrityMetadata

@GET
 @Path(value="20141201/metadata/celebrity/{celebrity}")
JsonNode getCelebrityMetadata(@PathParam(value="")
                                                                                           String celebrity)
                                                                                    throws HttpResponseException,
                                                                                           ClientProtocolException,
                                                                                           IOException

Retrieving images for a particular celebrity

Parameters:

celebrity - The celebrity.

Returns:

The JsonNode.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getImage

@GET
 @Path(value="20141201/image/assets/{uri}")
HttpResponse getImage(@PathParam(value="")
                                                                       String uri)
                                                                throws HttpResponseException,
                                                                       ClientProtocolException,
                                                                       IOException

Retrieving an image

Parameters:

uri - The relative URI path.

Returns:

The HttpResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getImage

@GET
HttpResponse getImage(URI uri)
                    throws HttpResponseException,
                           ClientProtocolException,
                           IOException

Retrieving an image

Parameters:

uri - The URI.

Returns:

The HttpResponse.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.