synapsi.main
Interface MainForGui

All Known Implementing Classes:
NeuronServer

public interface MainForGui


Method Summary
 int addClientToGroup(java.lang.String clientIP, java.lang.String groupID)
          Adds a new client to the specified group.
 int addGroup(java.lang.String groupID, java.lang.String version)
          Adds a new group to the system.
 int addNewPackage(java.lang.String pathToFiles, java.lang.String Id, java.lang.String version, java.lang.String os, byte[] MD5)
          Adds new software package to server.
 DataVersion getClientVersion(java.lang.String clientIP)
          Returns the version of client's software package.
 java.util.Vector getGroupClients(java.lang.String groupID)
          Returns the clients (client IP, version and current status) of the specified group.
 java.util.Vector getGroups()
          Returns all groups in the system.
 DataVersion getGroupVersion(java.lang.String groupID)
          Returns the software version currently assigned to the specified group.
 int getNSSettings()
          Retrieves the number of conncurrent clients
 java.util.Vector getPackages()
          Returns all the software package IDs currently in the system.
 int init()
          Initialize the data's from disk.
 int init(java.lang.String pathToFile)
          Initialize the data from the disk.
 int removeClientFromGroup(java.lang.String clientIP, java.lang.String groupID)
          Removes a client from the specified group.
 int removeGroup(java.lang.String groupID)
          Removes the specified group from the system.
 int removePackage(java.lang.String version)
          Removes an old package from the system.
 int save()
          Saves the data to disk.
 int save(java.lang.String pathToFile)
          Saves the data to the wanted location on the disk.
 int setClientToGroup(java.lang.String clientIP, java.lang.String GroupID)
          Set's the client to group
 int setGroupInfo(java.lang.String oldID, java.lang.String newID, java.lang.String version)
          Sets new group ID and/or software version to a group.
 void setNSSettings(int concurrentClients)
          Sets a new value to the number of concurrent clients.
 void TestClientInfo(java.lang.String ip, boolean b)
          Usefull method for testing / debugging purposes Set's the client online / offline
 

Method Detail

save


public int save()
Saves the data to disk. Uses the default name for file.
Returns:
0, if save successful.

save


public int save(java.lang.String pathToFile)
Saves the data to the wanted location on the disk.
Parameters:
pathToFile - Location where we wish to save.
Returns:
0, if save successful.

init


public int init()
Initialize the data's from disk. Uses the default name for serilized file.
Returns:
0, if init is successful.

init


public int init(java.lang.String pathToFile)
Initialize the data from the disk.
Parameters:
pathToFile - Path to the file where the data is saved.
Returns:
0, if save successful.

getGroups


public java.util.Vector getGroups()
Returns all groups in the system.
Returns:
A vector containing all groups.

getGroupClients


public java.util.Vector getGroupClients(java.lang.String groupID)
Returns the clients (client IP, version and current status) of the specified group.
Parameters:
groupID - The group which is handled.
Returns:
A vector of client information of this group.

getPackages


public java.util.Vector getPackages()
Returns all the software package IDs currently in the system.
Returns:
A vector of package IDs.

getClientVersion


public DataVersion getClientVersion(java.lang.String clientIP)
Returns the version of client's software package.
Parameters:
clientIP - The IP of the client to be handled.
Returns:
Version information of this client.

getGroupVersion


public DataVersion getGroupVersion(java.lang.String groupID)
Returns the software version currently assigned to the specified group.
Parameters:
groupID - The ID of the group to be handled.
Returns:
Version information of this group.

setGroupInfo


public int setGroupInfo(java.lang.String oldID,
                        java.lang.String newID,
                        java.lang.String version)
Sets new group ID and/or software version to a group.
Parameters:
oldID - Old group ID of the group.
newID - New group ID for the group (if only software version changed, the same as oldID).
version - New software version to the group.
Returns:
0 if OK else some error code

addGroup


public int addGroup(java.lang.String groupID,
                    java.lang.String version)
Adds a new group to the system.
Parameters:
groupID - The group ID of the new group.
version - Software version to the new group.
Returns:
0 if OK else some error code

removeGroup


public int removeGroup(java.lang.String groupID)
Removes the specified group from the system.
Parameters:
groupID - The group ID of the group to be removed.
Returns:
0 if OK else some error code

setNSSettings


public void setNSSettings(int concurrentClients)
Sets a new value to the number of concurrent clients.
Parameters:
concurrentClients - A new value to the number of concurrent clients.

getNSSettings


public int getNSSettings()
Retrieves the number of conncurrent clients
Returns:
the number of clients

TestClientInfo


public void TestClientInfo(java.lang.String ip,
                           boolean b)
Usefull method for testing / debugging purposes Set's the client online / offline
Parameters:
ip - client's IP which we want to set Online status
b - is the client online or not

addNewPackage


public int addNewPackage(java.lang.String pathToFiles,
                         java.lang.String Id,
                         java.lang.String version,
                         java.lang.String os,
                         byte[] MD5)
Adds new software package to server. Params need some refinement
Parameters:
pathToFiles - Path to file/files, where the update package is located.
Id - Unique version identification string for this software package
version - The version number
os - The OS this version is inteded
Returns:
none zero error-code if failed

removePackage


public int removePackage(java.lang.String version)
Removes an old package from the system.
Parameters:
version - The version of the package to be removed.
Returns:
none zero error-code if failed

addClientToGroup


public int addClientToGroup(java.lang.String clientIP,
                            java.lang.String groupID)
Adds a new client to the specified group.
Parameters:
clientIP - The IP of the client to be added.
groupID - The ID of the group where client is added.
Returns:
none zero error-code if failed

removeClientFromGroup


public int removeClientFromGroup(java.lang.String clientIP,
                                 java.lang.String groupID)
Removes a client from the specified group.
Parameters:
clientIP - The IP of the client to be removed.
groupID - The ID of the group where client is removed.
Returns:
none zero error-code if failed

setClientToGroup


public int setClientToGroup(java.lang.String clientIP,
                            java.lang.String GroupID)
Set's the client to group
Parameters:
clientIP - Client we are moving
GroupID - The group we are planning to move the client
Returns:
none zero error-code if failed