Use go module as dependency tool instead of glide

[src/xds/xds-server.git] / lib / xdsserver / folder-interface.go

diff --git a/lib/xdsserver/folder-interface.go b/lib/xdsserver/folder-interface.go
index c2b2ada..65a2ed0 100644 (file)
--- a/lib/xdsserver/folder-interface.go
+++ b/lib/xdsserver/folder-interface.go
@@ -1,22 +1,41 @@
+/*
+ * Copyright (C) 2017-2018 "IoT.bzh"
+ * Author Sebastien Douheret <sebastien@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package xdsserver
 
-import "github.com/iotbzh/xds-server/lib/xsapiv1"
+import "gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
 
+// FolderEventCBData Data format of FolderEvent events
 type FolderEventCBData map[string]interface{}
+
+// FolderEventCB Callback prototype for FolderEvent events
 type FolderEventCB func(cfg *xsapiv1.FolderConfig, data *FolderEventCBData)
 
 // IFOLDER Folder interface
 type IFOLDER interface {
-       NewUID(suffix string) string                                          // Get a new folder UUID
-       Add(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)              // Add a new folder
-       GetConfig() xsapiv1.FolderConfig                                        // Get folder public configuration
-       GetFullPath(dir string) string                                        // Get folder full path
-       ConvPathCli2Svr(s string) string                                      // Convert path from Client to Server
-       ConvPathSvr2Cli(s string) string                                      // Convert path from Server to Client
-       Remove() error                                                        // Remove a folder
-       Update(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)           // Update a new folder
-       RegisterEventChange(cb *FolderEventCB, data *FolderEventCBData) error // Request events registration (sent through WS)
-       UnRegisterEventChange() error                                         // Un-register events
-       Sync() error                                                          // Force folder files synchronization
-       IsInSync() (bool, error)                                              // Check if folder files are in-sync
+       NewUID(suffix string) string                                    // Get a new folder UUID
+       Add(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)    // Add a new folder
+       Setup(prj xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)  // Local setup of the folder
+       GetConfig() xsapiv1.FolderConfig                                // Get folder public configuration
+       GetFullPath(dir string) string                                  // Get folder full path
+       ConvPathCli2Svr(s string) string                                // Convert path from Client to Server
+       ConvPathSvr2Cli(s string) string                                // Convert path from Server to Client
+       Remove() error                                                  // Remove a folder
+       Update(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error) // Update a new folder
+       Sync() error                                                    // Force folder files synchronization
+       IsInSync() (bool, error)                                        // Check if folder files are in-sync
 }