IHTTPLinkUtils Class Reference

#include <IHTTPLinkUtils.h>

Inheritance diagram for IHTTPLinkUtils:

Public Types
enum	{ kDefaultIID = IID_IHTTPLINKUTILS }

Public Member Functions
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
virtual void	ShutdownHTTPLinksSubsystem () const =0
virtual PMString	GetHTTPAssetCachePath () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Experimental interface - will be modified/documented in future.

Member Function Documentation

virtual PMString IHTTPLinkUtils::GetHTTPAssetCachePath ( ) const

pure virtual

Fetches the full path of HTTP Asset Cache

Returns

HTTP Asset Cache Path.

virtual InterfacePtr<IHTTPLinkResourceConnection> IHTTPLinkUtils::GetHTTPLinkResourceConnection ( const URI &  uri ) const

pure virtual

Fetches the Http Link resource connection on the given uri.

Parameters

uri	[IN] uri of the asset.

Returns

Http Link resource Connection on the given uri.

virtual InterfacePtr<IHTTPLinkResourceServerCache> IHTTPLinkUtils::GetHTTPLinkResourceServerCache ( const URI &  uri ) const

pure virtual

Fetches the Http Link resource Server cache on the given uri.

Parameters

uri	[IN] uri of the asset.

Returns

Http Link resource Server cache on the given uri.

virtual bool16 IHTTPLinkUtils::GetOriginalURIForResource ( const ILinkResource *  iLinkResource, URI &  uri  ) const

pure virtual

API to get the URI for original asset based on the information in the input UIDRef

Parameters

iLinkResource	[IN] Input Link Resource
URI	[OUT] The asset original URI for the input Link Resource

Returns

kTrue if the operation is successful else kFalse

virtual bool16 IHTTPLinkUtils::GetRenditionURIForResource ( const ILinkResource *  iLinkResource, URI &  uri  ) const

pure virtual

API to get the URI for rendition of the original asset based on the information in the input UIDRef

Parameters

iLinkResource	[IN] Input Link Resource
URI	[OUT] The rendition URI for the input Link Resource

Returns

kTrue if the operation is successful else kFalse

virtual URI IHTTPLinkUtils::GetServerURI ( const URI &  inAssetUri ) const

pure virtual

Fetches the server URI for the asset URI

Parameters

inAssetUri

[IN] uri of the asset.

Returns

server URI for the asset.

virtual WideString IHTTPLinkUtils::GetShortName ( const URI &  uri ) const

pure virtual

Gets Short Resource Name for the input URI

Parameters

uri	[IN] uri of the asset.

Returns

Short Name.

virtual bool16 IHTTPLinkUtils::IsHTTPLinksSupportedURI ( const URI &  uri ) const

pure virtual

If the URI is HTTP Link Supported

Parameters

uri	[IN] uri of the asset.

Returns

kTrue if the uri is Http Link supported else return kFalse.

virtual bool16 IHTTPLinkUtils::IsValidDataBaseForHttpLink ( IDataBase *  db ) const

pure virtual

Checks if Database is valid for the HTTP Link

Parameters

db	[IN] database for HTTP Link. return kTrue if the db is valid else return kFalse.

virtual AString IHTTPLinkUtils::WideStringToAString ( const WideString &  wString ) const

pure virtual

Utility API to change WideString to AString

Parameters

wString

[IN] input WideString.

Returns

Output AString.