Package com.peterphi.carbon

Interface CarbonClient

All Known Implementing Classes:

CarbonClientImpl

public interface CarbonClient

Method Summary

Modifier and Type	Method	Description
String	createJob(CarbonProject project)
String	getEndpoint()
CarbonJobInfo	getJob(String guid)
CarbonProject	getJobDetails(String guid)	Get detailed information about a job
CarbonProfile	getProfile(String name)	Retrieve a profile by name (or GUID)
List<CarbonProfile>	getProfiles()	Retrieve a list of all destination profiles
CarbonProfile	getVideoFilter(String name)	Retrieve a video filter by name (or GUID)
List<CarbonProfile>	getVideoFilters()
boolean	isHealthy()	Perform a health check on the Carbon instance
List<String>	listJobs()
void	removeJob(String guid)
CarbonReply	send(org.jdom2.Element element)	Send an arbitrary XML request

Method Details

getEndpoint

String getEndpoint()

isHealthy

boolean isHealthy()

Perform a health check on the Carbon instance

Returns:

true if healthy, otherwise false

send

CarbonReply send(org.jdom2.Element element)
          throws CarbonException

Send an arbitrary XML request

Parameters:

element - the XML element

Returns:

Throws:

CarbonException

getJob

CarbonJobInfo getJob(String guid)
              throws CarbonException

Throws:

CarbonException

getJobDetails

CarbonProject getJobDetails(String guid)
                     throws CarbonException

Get detailed information about a job

Parameters:

guid -

Returns:

Throws:

CarbonException

createJob

String createJob(CarbonProject project)
          throws CarbonException

Throws:

CarbonException

listJobs

List<String> listJobs()
               throws CarbonException

Returns:

Throws:

CarbonException

getProfiles

List<CarbonProfile> getProfiles()
                         throws CarbonException

Retrieve a list of all destination profiles

Returns:

Throws:

CarbonException

getVideoFilters

List<CarbonProfile> getVideoFilters()
                             throws CarbonException

Throws:

CarbonException

getProfile

CarbonProfile getProfile(String name)
                  throws CarbonException

Retrieve a profile by name (or GUID)

Parameters:

name - the profile name (or GUID)

Returns:

Throws:

CarbonException

removeJob

void removeJob(String guid)
        throws CarbonException

Throws:

CarbonException

getVideoFilter

CarbonProfile getVideoFilter(String name)

Retrieve a video filter by name (or GUID)

Parameters:

name - the video filter name (or GUID)

Returns:

Throws:

CarbonException