IHTTPLinkUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Arvinder Singh
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 2016 Adobe 
// All Rights Reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in 
// accordance with the terms of the Adobe license agreement accompanying 
// it. If you have received this file from a source other than Adobe, 
// then your use, modification, or distribution of it requires the prior 
// written permission of Adobe.
// 
//========================================================================================
#ifndef __IHTTPLinkUtils__
#define __IHTTPLinkUtils__

#include "IPMUnknown.h"

#include "Utils.h"
#include "ILink.h"
#include "ILinkResource.h"
#include "IDataBase.h"
#include "IDatabaseSnapshot.h"

#include "string"
#include "WideString.h"


class IHTTPLinkResourceConnection;
class IHTTPLinkResourceServerCache;

/*
 AdobePatentID="P7137-US"
 AdobePatentID="P7225-US"
 AdobePatentID="P7609-US"
 */

class IHTTPLinkUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHTTPLINKUTILS };

 virtual bool16 GetOriginalURIForResource(const ILinkResource* iLinkResource, URI& uri) const = 0;

 virtual bool16 GetRenditionURIForResource(const ILinkResource* iLinkResource, URI& uri) const = 0;

 virtual WideString GetShortName(const URI& uri) const = 0;
 
 virtual AString WideStringToAString(const WideString& wString) const = 0;

 virtual URI GetServerURI(const URI& inAssetUri) const = 0;

 virtual bool16 IsHTTPLinksSupportedURI(const URI& uri) const = 0;

 virtual bool16 IsValidDataBaseForHttpLink(IDataBase *db) const = 0;


 virtual InterfacePtr<IHTTPLinkResourceConnection> GetHTTPLinkResourceConnection(const URI& uri) const = 0;

 virtual InterfacePtr<IHTTPLinkResourceServerCache> GetHTTPLinkResourceServerCache(const URI& uri) const = 0;

 virtual void ReadWriteSnapshotForBackgroundThread(DatabaseSnapshotPtr db, bool16 isReadingMode) const = 0;

 // Do not call it from outside world, this is for our internal purpose only.
 virtual void ShutdownHTTPLinksSubsystem() const = 0;

 virtual PMString GetHTTPAssetCachePath() const = 0;
};

#endif // __IHTTPLinkUtils__