IHTTPLinkManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Sanyam Jain
// 
// $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 __IHTTPLinkManager__
#define __IHTTPLinkManager__

#include "IPMUnknown.h"
#include "LinksID.h"
#include "URI.h"

#include "IHTTPLinkResourceServerAPIWrapper.h"
#include "ILinkResourceHandler.h"
#include "ILinkResourceStateUpdater.h"
#include "IHTTPLinkResourceServerCache.h"
#include "IHTTPLinkAssetURIPreprocessor.h"

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

class IHTTPLinkManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHTTPLINKMANGER };

 virtual bool16 Initialize() = 0;

 virtual bool16 Shutdown() = 0;

 /*
 Gets the registered HTTP schemes.
 @param schemes [OUT] returns the registered HTTP schemes .
 */
 virtual void GetSchemes(K2Vector<WideString>& schemes) const = 0;

 /*
 Gets the resource handler for the specified uri.
 @param inAssetURI [IN] uri of the Link Resource.
 @param db [IN] database corresponding to the link resource.
 @return resource handler for the specified Link Resource.
 */
 virtual ILinkResourceHandler* QueryHandler(const URI& inAssetURI, IDataBase* db) = 0;

 /*
 Gets the resource state updater for the specified uri.
 @param inAssetURI [IN] uri of the Link Resource.
 @param db [IN] database corresponding to the link resource.
 @return resource state updater for the specified Link Resource.
 */
 virtual ILinkResourceStateUpdater* QueryStateUpdater(const URI& inAssetURI, IDataBase* db) = 0;

 /*
 Gets the resource server api wrapper for the specified uri.
 @param inAssetURI [IN] uri scheme e.g aem/file/cclibrary schemes of the Link Resource.
 @param db [IN] database corresponding to the link resource.
 @return resource server api wrapper for the specified Link Resource.
 */
 virtual IHTTPLinkResourceServerAPIWrapper* GetHTTPLinkResourceServerAPIWrapper(const URI& inAssetURI) = 0;

 /*
 Gets the resource server cache the specified uri.
 @param inAssetURI [IN] uri scheme e.g aem/file/cclibrary schemes of the Link Resource.
 @return resource server cache the specified Link Resource.
 */
 virtual IHTTPLinkResourceServerCache* QueryHTTPLinkResourceServerCache(const URI& inAssetURI) = 0;

 /*
 Gets the resource connection for the specified uri.
 @param inAssetURI [IN] uri scheme e.g aem/file/cclibrary schemes of the Link Resource.
 @return resource connection for the specified Link Resource.
 */
 virtual IHTTPLinkResourceConnection* QueryHTTPLinkResourceConnection(const URI& inAssetURI) = 0;

 /*
 Gets the URI Preprocessor for the specified uri.
 @param inAssetURI [IN] uri scheme e.g aem/file/cclibrary schemes of the Link Resource.
 @return URI Preprocessor for the specified Link Resource.
 */
 virtual IHTTPLinkAssetURIPreprocessor* GetHTTPLinkAssetURIPreprocessor(const URI& inAssetURI) = 0;

 virtual void ReadWriteSnapshotForBackgroundThread(IPMStream* s) = 0;
};

#endif // __IHTTPLinkManager__