Package com.peterphi.carbon

Class CarbonClientImpl

java.lang.Object

com.peterphi.carbon.CarbonClientImpl

All Implemented Interfaces:

CarbonClient

public class CarbonClientImpl
extends Object
implements CarbonClient

Constructor Summary

Constructors

Constructor	Description
CarbonClientImpl(String host)
CarbonClientImpl(String host, Integer port)

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 query)	Retrieve a profile by name (or GUID)
List<CarbonProfile>	getProfiles()	Retrieve a list of all destination profiles
CarbonProfile	getVideoFilter(String query)	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 some XML

Methods inherited from class java.lang.Object

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

Constructor Details

CarbonClientImpl

public CarbonClientImpl(String host)

CarbonClientImpl

@Inject
public CarbonClientImpl(String host,
 Integer port)

Method Details

getEndpoint

public String getEndpoint()

Specified by:

getEndpoint in interface CarbonClient

isHealthy

public boolean isHealthy()

Description copied from interface: CarbonClient

Perform a health check on the Carbon instance

Specified by:

isHealthy in interface CarbonClient

Returns:

true if healthy, otherwise false

send

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

Send some XML

Specified by:

send in interface CarbonClient

Parameters:

doc -

Returns:

Throws:

CarbonException

getJob

public CarbonJobInfo getJob(String guid)
                     throws CarbonException

Specified by:

getJob in interface CarbonClient

Throws:

CarbonException

getJobDetails

public CarbonProject getJobDetails(String guid)
                            throws CarbonException

Description copied from interface: CarbonClient

Get detailed information about a job

Specified by:

getJobDetails in interface CarbonClient

Returns:

Throws:

CarbonException

createJob

public String createJob(CarbonProject project)
                 throws CarbonException

Specified by:

createJob in interface CarbonClient

Throws:

CarbonException

listJobs

public List<String> listJobs()
                      throws CarbonException

Specified by:

listJobs in interface CarbonClient

Returns:

Throws:

CarbonException

getProfiles

public List<CarbonProfile> getProfiles()
                                throws CarbonException

Description copied from interface: CarbonClient

Retrieve a list of all destination profiles

Specified by:

getProfiles in interface CarbonClient

Returns:

Throws:

CarbonException

getProfile

public CarbonProfile getProfile(String query)
                         throws CarbonException

Description copied from interface: CarbonClient

Retrieve a profile by name (or GUID)

Specified by:

getProfile in interface CarbonClient

Parameters:

query - the profile name (or GUID)

Returns:

Throws:

CarbonException

getVideoFilter

public CarbonProfile getVideoFilter(String query)

Description copied from interface: CarbonClient

Retrieve a video filter by name (or GUID)

Specified by:

getVideoFilter in interface CarbonClient

Parameters:

query - the video filter name (or GUID)

Returns:

getVideoFilters

public List<CarbonProfile> getVideoFilters()
                                    throws CarbonException

Specified by:

getVideoFilters in interface CarbonClient

Throws:

CarbonException

removeJob

public void removeJob(String guid)
               throws CarbonException

Specified by:

removeJob in interface CarbonClient

Throws:

CarbonException