Interface and implementation stubs

nucleus/interfaces/client.go

-package interfaces
-
-// Client provides an interface for
-// SBI protocol clients
-type Client interface {
-	GetConfig() ClientConfig
-}

nucleus/interfaces/interfaces.go

+package interfaces
+
+// Port provides an interface for
+// the device's ports
+type Port interface {
+}
+
+// Client provides an interface for
+// SBI client implementations
+type Client interface {
+	GetConfig() ClientConfig
+	ListPorts() map[int]Port
+	PushReceiver() error
+}
+
+// PrincipalNetworkDomain provides an
+// interface for PND implementations
+type PrincipalNetworkDomain interface {
+	Destroy() error
+	AddSbi() error
+	RemoveSbi() error
+}
+
+// SouthboundInterface provides an
+// interface for SBI implementations
+type SouthboundInterface interface {
+	AddClient() error
+	RemoveClient() error
+	CollectHeartbeats() error
+	ListClients() map[int]Client
+}

nucleus/principalNetworkDomain.go

+package nucleus
+
+type pndImplementation struct {
+}
+
+// Interface satisfaction
+func (pnd *pndImplementation) Destroy() error {
+	return destroy()
+}
+
+func (pnd *pndImplementation) AddSbi() error {
+	return addSbi()
+}
+
+func (pnd *pndImplementation) RemoveSbi() error {
+	return removeSbi()
+}
+
+// Actual implementation, bind to struct if
+// neccessary
+func destroy() error {
+	return nil
+}
+
+func addSbi() error {
+	return nil
+}
+
+func removeSbi() error {
+	return nil
+}

sbi/restconf/client/ciena/client.go

@@ -29,6 +29,18 @@ func (c MCPClient) GetConfig() interfaces.ClientConfig {
 	return *c.config
 }
 
+// ListPorts is a stub to satisfy the interface
+// TODO: Implement
+func (c MCPClient) ListPorts() map[int]interfaces.Port {
+	return nil
+}
+
+// PushReceiver is a stub to satisfy the interface
+// TODO: Implement
+func (c MCPClient) PushReceiver() error {
+	return nil
+}
+
 //NewMCPClient creates a Ciena flavores TAPI client
 func NewMCPClient(endpoint, username, password string, database *database.Database, config *interfaces.ClientConfig) *MCPClient {
 	// create the transport

sbi/restconf/southboundInterface.go

+package restconf
+
+type southboundInterface struct {
+}
+
+// Interface satisfaction
+func (sbi *southboundInterface) AddClient() error {
+	return addClient()
+}
+
+func (sbi *southboundInterface) RemoveClient() error {
+	return removeClient()
+}
+
+func (sbi *southboundInterface) CollectHeartbeats() error {
+	return collectHeartbeats()
+}
+
+func (sbi *southboundInterface) ListClients() error {
+	return listClients()
+}
+
+// Actual implementation, bind to struct if
+// neccessary
+func addClient() error {
+	return nil
+}
+
+func removeClient() error {
+	return nil
+}
+
+func collectHeartbeats() error {
+	return nil
+}
+
+func listClients() error {
+	return nil
+}