JarCasting
JarCasting JarCasting

CueServer HTTP client

Client library for the CueServer HTTP interface.

License

License
Categories

Categories

CLI User Interface
GroupId

GroupId

org.urbanbyte.cueserver
ArtifactId

ArtifactId

cueserver-client
Last Version

Last Version

1.0.1
Release Date

Release Date
Type

Type

jar
Description

Description

CueServer HTTP client
Client library for the CueServer HTTP interface.
Project URL

Project URL

http://urbanbyte.org
Source Code Management

Source Code Management

https://github.com/creising/CueServer-Client

Download cueserver-client

Filename Size
cueserver-client-1.0.1.pom
cueserver-client-1.0.1.jar 24 KB
cueserver-client-1.0.1-sources.jar 16 KB
cueserver-client-1.0.1-javadoc.jar 96 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.urbanbyte.cueserver/cueserver-client/ -->
<dependency>
    <groupId>org.urbanbyte.cueserver</groupId>
    <artifactId>cueserver-client</artifactId>
    <version>1.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.urbanbyte.cueserver/cueserver-client/
implementation 'org.urbanbyte.cueserver:cueserver-client:1.0.1'
// https://jarcasting.com/artifacts/org.urbanbyte.cueserver/cueserver-client/
implementation ("org.urbanbyte.cueserver:cueserver-client:1.0.1")
'org.urbanbyte.cueserver:cueserver-client:jar:1.0.1'
<dependency org="org.urbanbyte.cueserver" name="cueserver-client" rev="1.0.1">
  <artifact name="cueserver-client" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.urbanbyte.cueserver', module='cueserver-client', version='1.0.1')
)
libraryDependencies += "org.urbanbyte.cueserver" % "cueserver-client" % "1.0.1"
[org.urbanbyte.cueserver/cueserver-client "1.0.1"]

Dependencies

compile (3)

Group / Artifact Type Version
com.google.guava : guava jar 18.0
org.apache.httpcomponents : httpclient jar 4.3.5
org.slf4j : slf4j-api jar 1.7.5

test (2)

Group / Artifact Type Version
junit : junit jar 4.11
org.mockito : mockito-core jar 1.10.7

Project Modules

There are no modules declared in this project.

Build Status

Build Status Coverage Status

Introduction

The CueSever Java client library is intended to facilitate interaction with CueServer's HTTP interface. In addition to the client, there is also a simple command line interface to demonstrate the use of the CueServer client.

Currently, the client library does not throttle requests to the CueServer. As noted in CueServer's documentation, new requests should only be sent after a response from the previous request has been received from CueServer.

###Documentation All Javadoc can be found here.

###Project Structure ./client contains all code related to the client library. ./cli contains all of the code related to the example command line interface.

###Compilation The client library uses the Gradle build system. If you're new to Gradle, here are a couple of common commands to get you started. All commands should be run from the root directory.

./gradlew build: Compiles all code and runs the unit tests.

./gradle javadoc: Generate Javadoc.

./gradlew clean: Removes the build directories.

./gradlew cli:installApp: Creates a JVM application along with libs and OS specific scripts. Once this command is run, the application can be found in: cli/build/install/.

####Artifacts Artifacts can be found on The Central Repository.

####Dependencies The client library has the following dependencies:

  • Google's guava v18.0
  • Apache's httpclient v4.3.5
  • Your favorite SLF4J library for logging

Additional Reading

For further information regarding the CueServer, please visit: Interactive Technologies.

Supported Operations

The client library currently supports the following operations:

  • Retrieval of system information
  • Retrieval of playback information
  • Retrieval of level from the DMX output
  • Play a cue on a playback
  • Clear a playback
  • Set a channel
  • Set a range of channels
  • Record a cue
  • Update a cue
  • Delete a cue

Questions? Feel free to contact me at [email protected]

Versions

Version
1.0.1
1.0