aboutsummaryrefslogtreecommitdiff
path: root/src/main/scala/xyz/driver/core/rest/ServiceDescriptor.scala
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/scala/xyz/driver/core/rest/ServiceDescriptor.scala')
-rw-r--r--src/main/scala/xyz/driver/core/rest/ServiceDescriptor.scala16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/main/scala/xyz/driver/core/rest/ServiceDescriptor.scala b/src/main/scala/xyz/driver/core/rest/ServiceDescriptor.scala
new file mode 100644
index 0000000..646fae8
--- /dev/null
+++ b/src/main/scala/xyz/driver/core/rest/ServiceDescriptor.scala
@@ -0,0 +1,16 @@
+package xyz.driver.core
+package rest
+import scala.annotation.implicitNotFound
+
+@implicitNotFound(
+ "Don't know how to communicate with service ${S}. Make sure an implicit ServiceDescriptor is" +
+ "available. A good place to put one is in the service's companion object.")
+trait ServiceDescriptor[S] {
+
+ /** The service's name. Must be unique among all services. */
+ def name: String
+
+ /** Get an instance of the service. */
+ def connect(transport: HttpRestServiceTransport, url: String): S
+
+}