com.screenscraper.util.internal.services.cloudcontroller

Class CloudControllerClient

java.lang.Object

com.screenscraper.util.internal.services.cloudcontroller.CloudControllerClient

public class CloudControllerClient
extends java.lang.Object

Client for working with the cloud controller. The client is extremely simplified (it doesn't support much other than starting a scrape that is already there)

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
CloudControllerClient(ScrapingSession session, java.lang.String url, java.lang.String username, java.lang.String password) Constructs a cloud controller client

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getScrapes() Returns a set of names of scrapes that are imported into the cloud controller
boolean	startSession(java.lang.String sessionName) Tells the cloud controller to launch a new scraping session by name

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudControllerClient

public CloudControllerClient(ScrapingSession session,
                             java.lang.String url,
                             java.lang.String username,
                             java.lang.String password)

Constructs a cloud controller client

Parameters:

session - The current scraping session

url - The url where the cloud controller API is located

username - The username for authenticating to the API

password - The password for authenticating to the API

Method Detail

startSession

public boolean startSession(java.lang.String sessionName)
                     throws java.io.IOException

Tells the cloud controller to launch a new scraping session by name

Parameters:

sessionName - The name of the scraping session to launch

Returns:

Whether or not the operation succeeded

Throws:

java.io.IOException - If there is an error starting the scrape

getScrapes

@NotNull
public java.util.Set<java.lang.String> getScrapes()
                                                     throws java.io.IOException,
                                                            org.json.simple.parser.ParseException

Returns a set of names of scrapes that are imported into the cloud controller

Returns:

A set of scrape names that are in the cloud controller

Throws:

java.io.IOException - If there is an error getting the scrape list

org.json.simple.parser.ParseException - If the response comes back in a format that cannot be parsed