Synnefo » Pithos MacOS & iOS Common Lib

//  ASIPithosContainerRequest.h

//  Based on ASICloudFilesContainerRequest.h

//

// Copyright 2011 GRNET S.A. All rights reserved.

//

// Redistribution and use in source and binary forms, with or

// without modification, are permitted provided that the following

// conditions are met:

// 

//   1. Redistributions of source code must retain the above

//      copyright notice, this list of conditions and the following

//      disclaimer.

// 

//   2. Redistributions in binary form must reproduce the above

//      copyright notice, this list of conditions and the following

//      disclaimer in the documentation and/or other materials

//      provided with the distribution.

// 

// THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

// OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

// USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

// AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

// POSSIBILITY OF SUCH DAMAGE.

// 

// The views and conclusions contained in the software and

// documentation are those of the authors and should not be

// interpreted as representing official policies, either expressed

// or implied, of GRNET S.A.

#import "ASIPithosRequest.h"

#if !TARGET_OS_IPHONE || (TARGET_OS_IPHONE && __IPHONE_OS_VERSION_MAX_ALLOWED < __IPHONE_4_0)

#import "ASINSXMLParserCompat.h"

#endif

@class ASIPithosContainer;

@class ASIPithosObject;

@interface ASIPithosContainerRequest : ASIPithosRequest <NSXMLParserDelegate> {

    NSString *containerName;

    NSMutableDictionary *policy;

    NSMutableDictionary *metadata;

    NSMutableArray *objects;

        // Internally used while parsing the response

        ASIPithosObject *currentObject;

}

@property (retain) NSString *containerName;

@property (retain) ASIPithosObject *currentObject;

// HEAD storageURL/container

+ (id)containerMetadataRequestWithContainerName:(NSString *)containerName;

// HEAD storageURL/container?[until=untilTimestamp]

+ (id)containerMetadataRequestWithContainerName:(NSString *)containerName until:(NSDate *)untilTimestamp;

// HEAD storageURL/container?[until=untilTimestamp] [If-Modified-Since]

+ (id)containerMetadataRequestWithContainerName:(NSString *)containerName 

                                          until:(NSDate *)untilTimestamp 

                                ifModifiedSince:(NSDate *)sinceTimestamp;

// HEAD storageURL/container?[until=untilTimestamp] [If-Unmodified-Since]

+ (id)containerMetadataRequestWithContainerName:(NSString *)containerName 

                                          until:(NSDate *)untilTimestamp 

                              ifUnmodifiedSince:(NSDate *)sinceTimestamp;

- (NSUInteger)objectCount;

- (NSUInteger)bytesUsed;

- (NSUInteger)blockSize;

- (NSString *)blockHash;

- (NSDate *)untilTimestamp;

- (NSArray *)objectMeta;

- (NSDictionary *)policy;

- (NSDictionary *)metadata;

- (NSDate *)lastModified;

- (ASIPithosContainer *)container;

// GET storageURL/container

+ (id)listObjectsRequestWithContainerName:(NSString *)containerName;

// GET storageURL?[limit=limit]&[marker=marker]&[prefix=prefix]&[delimiter=delimiter]&[path=path]&[meta=meta]&[shared=]&[until=untilTimestamp]

+ (id)listObjectsRequestWithContainerName:(NSString *)containerName

                                    limit:(NSUInteger)limit 

                                   marker:(NSString *)marker 

                                   prefix:(NSString *)prefix 

                                delimiter:(NSString *)delimiter 

                                     path:(NSString *)path 

                                     meta:(NSArray *)meta 

                                   shared:(BOOL)shared

                                    until:(NSDate *)untilTimestamp;

// GET storageURL?[limit=limit]&[marker=marker]&[prefix=prefix]&[delimiter=delimiter]&[path=path]&[meta=meta]&[shared=]&[until=untilTimestamp] [If-Modified-Since]

+ (id)listObjectsRequestWithContainerName:(NSString *)containerName

                                    limit:(NSUInteger)limit 

                                   marker:(NSString *)marker 

                                   prefix:(NSString *)prefix 

                                delimiter:(NSString *)delimiter 

                                     path:(NSString *)path 

                                     meta:(NSArray *)meta 

                                   shared:(BOOL)shared

                                    until:(NSDate *)untilTimestamp 

                          ifModifiedSince:(NSDate *)sinceTimestamp;

// GET storageURL?[limit=limit]&[marker=marker]&[prefix=prefix]&[delimiter=delimiter]&[path=path]&[meta=meta]&[shared=]&[until=untilTimestamp] [If-Unmodified-Since]

+ (id)listObjectsRequestWithContainerName:(NSString *)containerName

                                    limit:(NSUInteger)limit 

                                   marker:(NSString *)marker 

                                   prefix:(NSString *)prefix 

                                delimiter:(NSString *)delimiter 

                                     path:(NSString *)path 

                                     meta:(NSArray *)meta 

                                   shared:(BOOL)shared

                                    until:(NSDate *)untilTimestamp 

                        ifUnmodifiedSince:(NSDate *)sinceTimestamp;

- (NSArray *)objects;

// PUT storageURL/container

+ (id)createOrUpdateContainerRequestWithContainerName:(NSString *)containerName;

// PUT storageURL/container [X-Container-Policy-*] [X-Container-Meta-*]

+ (id)createOrUpdateContainerRequestWithContainerName:(NSString *)containerName 

                                               policy:(NSDictionary *)policy 

                                             metadata:(NSDictionary *)metadata;

// POST storageURL/container

+ (id)updateContainerMetadataRequestWithContainerName:(NSString *)containerName;

// POST storageURL/container?[update=] [X-Container-Policy-*] [X-Container-Meta-*]

+ (id)updateContainerMetadataRequestWithContainerName:(NSString *)containerName 

                                               policy:(NSDictionary *)policy 

                                             metadata:(NSDictionary *)metadata 

                                               update:(BOOL)update;

// POST storageURL/container?[update=] [X-Container-Policy-*] [X-Container-Meta-*] (update data from ASIPithosObject with data)

+ (id)updateContainerDataRequestWithContainerName:(NSString *)containerName 

                                           policy:(NSDictionary *)policy 

                                         metadata:(NSDictionary *)metadata 

                                           update:(BOOL)update

                                           object:(ASIPithosObject *)object;

// POST storageURL/container?[update=] [X-Container-Policy-*] [X-Container-Meta-*] (update data from NSData)

+ (id)updateContainerDataRequestWithContainerName:(NSString *)containerName 

                                           policy:(NSDictionary *)policy 

                                         metadata:(NSDictionary *)metadata 

                                           update:(BOOL)update

                                             data:(NSData *)data;

// POST storageURL/container?[update=] [X-Container-Policy-*] [X-Container-Meta-*] (update data from file)

+ (id)updateContainerDataRequestWithContainerName:(NSString *)containerName 

                                           policy:(NSDictionary *)policy 

                                         metadata:(NSDictionary *)metadata 

                                           update:(BOOL)update

                                             file:(NSString *)filePath;

// DELETE storageURL/container

+ (id)deleteContainerRequestWithContainerName:(NSString *)containerName;

// DELETE storageURL/container?[until=untilTimestamp]

+ (id)deleteContainerRequestWithContainerName:(NSString *)containerName until:(NSDate *)untilTimestamp;

@end