ULServerInterface.h

/*
   Project: AdunServer

   Copyright (C) 2005 Michael Johnston & Jordi Villˆ--Freixa

   Author: Michael Johnston

   Created: 2005-05-31 15:42:00 +0200 by michael johnston

   This application is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This application is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
*/

#ifndef _ULSERVERINTERFACE_
#define _ULSERVERINTERFACE_

#include <ULFramework/ULFileSystemDatabaseBackend.h>

#define ULDatabaseSharingErrorDomain @"ULDatabaseSharing.ErrorDomain"

typedef enum 
{
        ULDatabaseAccessNotAvailableError,      
        ULDatabasePublicationError,             
        ULDatabaseRetractionError,              
        ULCannotAddSharedDatabaseError,         
        ULCannotRemoveSharedDatabaseError,      
}
ULDatabaseSharingErrorCodes;

@protocol ULServerCommandInterface
- (bycopy id) execute: (NSDictionary*) commandDict error: (out NSError**) errorResult process: (id) process;
- (NSMutableDictionary*) optionsForCommand: (NSString*) command process: (id) process;
- (NSArray*) validCommandsForProcess: (id) process;
@end

@protocol ULServerConfigurationInterface
- (int) port;
- (BOOL) isDistributed;
- (NSHost*) serverHost;
- (NSString*) socketAddress;
- (NSString*) registeredName;
@end

@protocol ULServerInterface <NSObject, ULServerCommandInterface>
- (oneway void) haltProcess: (id) process;
- (oneway void) terminateProcess: (id) process;
- (oneway void) restartProcess: (id) process;
- (NSError*) startSimulation: (id) process;
- (void) processWillDisconnect: (id) process;
- (BOOL) reconnectProcess: (id) process;
- (void) removeDataForProcess: (id)process;
@end

@protocol ULRemoteDataAccess
- (id) clientForDatabase: (NSString*) databaseName 
              clientName: (NSString*) clientName
                    user: (NSString*) userName
                password: (NSString*) password
          requestingHost: (NSString*) hostname
                   error: (out NSError**) error;
- (void) removeClientWithName: (NSString*) clientName
            accessingDatabase:  (NSString*) databaseName 
                         user: (NSString*) userName
                     password: (NSString*) password
               requestingHost: (NSString*) hostname;    
- (NSArray*) publishedDatabases;                             
@end

@protocol ULRemoteDataManagement
- (BOOL) publishDatabase: (NSString*) databaseIdentifier error: (out NSError**) error;
- (BOOL) retractDatabase: (NSString*) databaseIdentifier error: (out NSError**) error;
- (BOOL) addDatabaseToP2PShares: (NSString*) databaseIdentifer 
         withConfiguration: (NSDictionary*) configuration  
         error: (out NSError**) error;
- (BOOL) removeDatabaseFromP2PShares: (NSString*) databaseIdentifier error: (out NSError**) error;
- (NSArray*) P2PShares;
- (NSArray*) publishedDatabaseIdentifiers;
@end


#endif