ball.tv.epg.sd

Class SDClient

java.lang.Object

ball.http.ProtocolClient<SDProtocol>

ball.tv.epg.sd.SDClient

All Implemented Interfaces:

HttpRequestInterceptor, HttpResponseInterceptor

public class SDClient
extends ProtocolClient<SDProtocol>

SDProtocol client.

Version:

$Revision: 5999 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SDClient.PostSchedulesMap getSchedules(Collection) and getSchedulesMD5(Collection) parameter: Use LinkedHashMap.values() as argument.

Field Summary

Fields inherited from class ball.http.ProtocolClient

charset, jaxb, mapper

Constructor Summary

Constructors

Modifier	Constructor and Description
	SDClient() No-argument constructor.
	SDClient(Path parent) Constructor to specify local parent directory.
protected	SDClient(Path parent, HttpClientBuilder builder) Protected constructor.

Method Summary

Modifier and Type	Method and Description
JsonNode	deleteLineup(String lineup) Method to invoke SDProtocol.deleteLineup(String,String).
JsonNode	getCelebrityMetadata(String id) Method to invoke SDProtocol.getCelebrityMetadata(String).
List<Headend>	getHeadends(String country, String postalcode) Method to invoke SDProtocol.getHeadends(String,String,String).
HttpEntity	getImage(String string) Method to invoke SDProtocol.getImage(URI) or SDProtocol.getImage(String) (as appropriate).
Lineup	getLineup(String lineup) Method to invoke SDProtocol.getLineup(String,Boolean,String).
SDProtocol.GetLineupsResponse	getLineups() Method to invoke SDProtocol.getLineups(String).
Path	getParent() Method to get the local parent Path.
JsonNode	getProgramMetadata(String id) Method to invoke SDProtocol.getProgramMetadata(String).
List<Program>	getPrograms(Collection<String> ids) Method to invoke SDProtocol.postPrograms(String,Collection).
JsonNode	getProgramsDescription(Collection<String> ids) Method to invoke SDProtocol.postProgramsDescription(String,Collection).
JsonNode	getProgramsMetadata(Collection<String> ids) Method to invoke SDProtocol.postProgramsMetadata(String,Collection).
List<SDProtocol.Schedules>	getSchedules(Collection<?> ids) Method to invoke SDProtocol.postSchedules(String,Collection).
JsonNode	getSchedulesMD5(Collection<?> ids) Method to invoke SDProtocol.postSchedulesMD5(String,Collection).
SDProtocol.GetStatusResponse	getStatus() Method to invoke SDProtocol.getStatus(String).
String	getToken() Method to invoke SDProtocol.postToken(File).
SDProtocol.GetVersionResponse	getVersion() Method to invoke SDProtocol.getVersion(String).
static String	hash(String password) Static method to generate a 40-digit SHA1 hash of a user password.
void	initialize(String username, String password) Method to initialize the user configuration.
JsonNode	postLineup(HttpEntity entity) Method to invoke SDProtocol.postLineup(String,HttpEntity) to attempt to auto-map a discovered HDHR Prime line-up.
JsonNode	postLineup(String lineup, HttpEntity entity) Method to invoke SDProtocol.postLineup(String,String,HttpEntity) to attempt to post a discovered HDHR Prime line-up to the server.
void	process(HttpRequest request, HttpContext context)
void	process(HttpResponse response, HttpContext context)
JsonNode	putLineup(String lineup) Method to invoke SDProtocol.putLineup(String,String).
String	toString()

Methods inherited from class ball.http.ProtocolClient

client, context, getCharset, getJAXBContext, getMarshaller, getObjectMapper, getUnmarshaller, handler, protocol, proxy

Methods inherited from class java.lang.Object

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

Constructor Detail

SDClient

public SDClient()

No-argument constructor.

SDClient

public SDClient(Path parent)

Constructor to specify local parent directory.

Parameters:

parent - The local parent Path.

SDClient

protected SDClient(Path parent,
                   HttpClientBuilder builder)

Protected constructor.

Parameters:

parent - The local parent Path.

builder - A configured HttpClientBuilder.

Method Detail

getParent

public Path getParent()

Method to get the local parent Path.

Returns:

The parent Path.

initialize

public void initialize(String username,
                       String password)
                throws Exception

Method to initialize the user configuration.

Parameters:

username - The user's name.

password - The user's password.

Throws:

Exception - If the hierarchy cannot be initialized.

getToken

public String getToken()
                throws Exception

Method to invoke SDProtocol.postToken(File).

Returns:

The token String if successful; null otherwise.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postToken(File).

getStatus

public SDProtocol.GetStatusResponse getStatus()
                                       throws Exception

Method to invoke SDProtocol.getStatus(String).

Returns:

The SDProtocol.GetStatusResponse.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getStatus(String).

getVersion

public SDProtocol.GetVersionResponse getVersion()
                                         throws Exception

Method to invoke SDProtocol.getVersion(String).

Returns:

The SDProtocol.GetVersionResponse.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getVersion(String).

getHeadends

public List<Headend> getHeadends(String country,
                                 String postalcode)
                          throws Exception

Method to invoke SDProtocol.getHeadends(String,String,String).

Parameters:

country - The country.

postalcode - The postal (ZIP) code.

Returns:

The Headends.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getHeadends(String,String,String).

putLineup

public JsonNode putLineup(String lineup)
                   throws Exception

Method to invoke SDProtocol.putLineup(String,String).

Parameters:

lineup - The line-up to add.

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.putLineup(String,String).

getLineups

public SDProtocol.GetLineupsResponse getLineups()
                                         throws Exception

Method to invoke SDProtocol.getLineups(String).

Returns:

The SDProtocol.GetLineupsResponse.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getLineups(String).

deleteLineup

public JsonNode deleteLineup(String lineup)
                      throws Exception

Method to invoke SDProtocol.deleteLineup(String,String).

Parameters:

lineup - The line-up to delete.

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.deleteLineup(String,String).

getLineup

public Lineup getLineup(String lineup)
                 throws Exception

Method to invoke SDProtocol.getLineup(String,Boolean,String).

Parameters:

lineup - The line-up to get.

Returns:

The Lineup.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getLineup(String,Boolean,String).

postLineup

public JsonNode postLineup(HttpEntity entity)
                    throws Exception

Method to invoke SDProtocol.postLineup(String,HttpEntity) to attempt to auto-map a discovered HDHR Prime line-up.

Parameters:

entity - The JSON entity retrieved from the HDHR Prime.

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postLineup(String,HttpEntity).

See Also:

HDHRPrimeClient.getLineup()

postLineup

public JsonNode postLineup(String lineup,
                           HttpEntity entity)
                    throws Exception

Method to invoke SDProtocol.postLineup(String,String,HttpEntity) to attempt to post a discovered HDHR Prime line-up to the server.

Parameters:

lineup - The name of the line-up.

entity - The JSON entity retrieved from the HDHR Prime.

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postLineup(String,String,HttpEntity).

See Also:

HDHRPrimeClient.getLineup()

getPrograms

public List<Program> getPrograms(Collection<String> ids)
                          throws Exception

Method to invoke SDProtocol.postPrograms(String,Collection).

Parameters:

ids - The Collection of program IDs,

Returns:

The List of Programs.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postPrograms(String,Collection).

getProgramsDescription

public JsonNode getProgramsDescription(Collection<String> ids)
                                throws Exception

Method to invoke SDProtocol.postProgramsDescription(String,Collection).

Parameters:

ids - The Collection of program IDs,

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postProgramsDescription(String,Collection).

getProgramsMetadata

public JsonNode getProgramsMetadata(Collection<String> ids)
                             throws Exception

Method to invoke SDProtocol.postProgramsMetadata(String,Collection).

Parameters:

ids - The Collection of program IDs,

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postProgramsMetadata(String,Collection).

getProgramMetadata

public JsonNode getProgramMetadata(String id)
                            throws Exception

Method to invoke SDProtocol.getProgramMetadata(String).

Parameters:

id - The root ID,

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getProgramMetadata(String).

getSchedules

public List<SDProtocol.Schedules> getSchedules(Collection<?> ids)
                                        throws Exception

Method to invoke SDProtocol.postSchedules(String,Collection).

Parameters:

ids - The Collection of station IDs,

Returns:

The List of SDProtocol.Schedules.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postSchedules(String,Collection).

getSchedulesMD5

public JsonNode getSchedulesMD5(Collection<?> ids)
                         throws Exception

Method to invoke SDProtocol.postSchedulesMD5(String,Collection).

Parameters:

ids - The Collection of station IDs,

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.postSchedulesMD5(String,Collection).

getCelebrityMetadata

public JsonNode getCelebrityMetadata(String id)
                              throws Exception

Method to invoke SDProtocol.getCelebrityMetadata(String).

Parameters:

id - The root ID,

Returns:

The JsonNode.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getCelebrityMetadata(String).

getImage

public HttpEntity getImage(String string)
                    throws Exception

Method to invoke SDProtocol.getImage(URI) or SDProtocol.getImage(String) (as appropriate).

Parameters:

string - The image URI (as String).

Returns:

The HttpEntity.

Throws:

Exception - If an exception is encountered invoking SDProtocol.getImage(URI) or SDProtocol.getImage(String).

process

public void process(HttpRequest request,
                    HttpContext context)
             throws IOException

Specified by:

process in interface HttpRequestInterceptor

Overrides:

process in class ProtocolClient<SDProtocol>

Throws:

IOException

process

public void process(HttpResponse response,
                    HttpContext context)
             throws IOException

Specified by:

process in interface HttpResponseInterceptor

Overrides:

process in class ProtocolClient<SDProtocol>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

hash

public static String hash(String password)

Static method to generate a 40-digit SHA1 hash of a user password.

Parameters:

password - The user password.

Returns:

The hash (as a 40-Character String.