code.grnet.gr Git - pithos-macos/blob - pithos-macos/PithosAccount.h

   1 //
   2 //  PithosAccount.h
   3 //  pithos-macos
   4 //
   5 // Copyright 2012 GRNET S.A. All rights reserved.
   6 //
   7 // Redistribution and use in source and binary forms, with or
   8 // without modification, are permitted provided that the following
   9 // conditions are met:
  10 //
  11 //   1. Redistributions of source code must retain the above
  12 //      copyright notice, this list of conditions and the following
  13 //      disclaimer.
  14 //
  15 //   2. Redistributions in binary form must reproduce the above
  16 //      copyright notice, this list of conditions and the following
  17 //      disclaimer in the documentation and/or other materials
  18 //      provided with the distribution.
  19 //
  20 // THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  21 // OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  24 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  27 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 // AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31 // POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // The views and conclusions contained in the software and
  34 // documentation are those of the authors and should not be
  35 // interpreted as representing official policies, either expressed
  36 // or implied, of GRNET S.A.
  37
  38 #import <Foundation/Foundation.h>
  39 @class PithosSyncDaemon;
  40 @class ASIPithos;
  41 @class PithosAccountNode;
  42
  43 @interface PithosAccount : NSObject <NSCoding> {
  44     NSString *uniqueName;
  45     BOOL active;
  46     NSString *name;
  47
  48     BOOL syncActive;
  49     NSString *syncDirectoryPath;
  50     NSMutableDictionary *syncContainersDictionary;
  51     NSDate *syncLastCompleted;
  52     PithosSyncDaemon *syncDaemon;
  53
  54     // Base for all necessary URLs, default "https://pithos.okeanos.grnet.gr"
  55     NSString *serverURL;
  56     // Appended to serverURL to get storageURLPrefix and authURL, default "v1"
  57     // Can be overriden by setting directly storageURLPrefix and authURL
  58     NSString *versionResource;
  59     // Appended to serverURL to get loginURLPrefix, default "login"
  60     // Can be overriden by setting directly loginURLPrefix
  61     NSString *loginResource;
  62     // Appended to serverURL to get publicURLPrefix, default nil
  63     // Can be overriden by setting directly publicURLPrefix
  64     NSString *publicResource;
  65
  66     NSString *authUser;
  67     NSString *authToken;
  68     NSString *storageURLPrefix;
  69     NSString *authURL;
  70     NSString *publicURLPrefix;
  71     NSString *loginURLPrefix;
  72
  73     ASIPithos *pithos;
  74     PithosAccountNode *accountNode;
  75
  76     BOOL updatePithos;
  77     BOOL resetSyncDaemonLocalState;
  78 }
  79
  80 @property (nonatomic, retain) NSString *uniqueName;
  81 @property (assign) BOOL active;
  82 @property (nonatomic, retain) NSString *name;
  83
  84 @property (nonatomic, assign) BOOL syncActive;
  85 @property (nonatomic, retain) NSString *syncDirectoryPath;
  86 @property (nonatomic, retain) NSMutableDictionary *syncContainersDictionary;
  87 @property (nonatomic, retain) NSDate *syncLastCompleted;
  88 @property (nonatomic, retain) PithosSyncDaemon *syncDaemon;
  89
  90 @property (nonatomic, retain) NSString *serverURL;
  91 @property (retain) NSString *versionResource;
  92 @property (retain) NSString *loginResource;
  93 @property (retain) NSString *publicResource;
  94
  95 @property (nonatomic, retain) NSString *authUser;
  96 @property (nonatomic, retain) NSString *authToken;
  97 @property (nonatomic, retain) NSString *storageURLPrefix;
  98 @property (nonatomic, retain) NSString *authURL;
  99 @property (nonatomic, retain) NSString *publicURLPrefix;
 100 @property (nonatomic, retain) NSString *loginURLPrefix;
 101
 102 @property (readonly) ASIPithos *pithos;
 103 @property (readonly) PithosAccountNode *accountNode;
 104
 105 + (id)pithosAccount;
 106
 107 - (BOOL)urlIsValid:(NSString *)urlString;
 108 - (void)authenticateWithServerURL:(NSString *)aServerURL authUser:(NSString *)anAuthUser authToken:(NSString *)anAuthToken;
 109 - (void)loginWithServerURL:(NSString *)aServerURL;
 110 - (void)updateSyncWithSyncActive:(BOOL)aSyncActive
 111                syncDirectoryPath:(NSString *)aSyncDirectoryPath
 112         syncContainersDictionary:(NSMutableDictionary *)aSyncContainersDictionary;
 113
 114 @end