CusHttpLnkResourceServerAPIWrapper Class Reference

Inheritance diagram for CusHttpLnkResourceServerAPIWrapper:

Public Types
typedef CPMUnknown < IHTTPLinkResourceServerAPIWrapper >	inherited

Public Member Functions
	CusHttpLnkResourceServerAPIWrapper (IPMUnknown *boss)
virtual AssetStatusWithMetadataPtr	RequestAssetStatusWithMetadata (IHTTPLinkResourceConnection *connection, const URI &assetURI)
virtual bool16	AsyncRequestAssetStatusWithMetadata (IHTTPLinkResourceConnection *connection, const URI &assetURI, RequestAssetStatusCompletionFunction completionFunction)
virtual bool16	AsyncRequestBatchAssetStatusWithMetadata (IHTTPLinkResourceConnection *connection, const URIVector &assetURIVector, RequestBatchAssetStatusCompletionFunction completionFunction)
virtual bool16	GenerateSessionToken (IHTTPLinkResourceConnection *connection, std::string &token)
virtual bool16	GetConfiguredBatchLimits (IHTTPLinkResourceConnection *connection, int32 &batchLimit, long &maxTimeinMs, long &minTimeinMs)
virtual bool16	IsServerAccessible (IHTTPLinkResourceConnection *connection, bool16 &serverAccessible)
virtual bool16	FetchAssetPathAndRequestHeadersForDownload (IHTTPLinkResourceConnection *connection, const URI &inURI, URI &assetURL, HTTPLinkSubsystemTypes::Headers &headers) const
virtual bool16	IsBatchUpdateSupported (const URI &uri) const
URI	GetAssetURI (const URI &inURI, ILinkResourceRenditionData::ResourceRenditionType type) const
virtual ILinkResourceRenditionData::ResourceRenditionType	GetURIRenditionType (const URI &inURI) const
virtual AssetMetadataContentPtr	RequestAssetTextFragmentContent (IHTTPLinkResourceConnection *connection, const URI &inURI, ErrorCode err=kCantPlaceMetadataError)
bool16	GetHTTPBatchRequestObjectType (const URI &uri, HTTPLinkSubsystemTypes::BatchRequestObjectType &objType) const
virtual bool16	AdjustURI (const URI &inUri, URI &outUri)
Public Member Functions inherited from CPMUnknown< IHTTPLinkResourceServerAPIWrapper >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Protected Member Functions inherited from CPMUnknown< IHTTPLinkResourceServerAPIWrapper >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IHTTPLinkResourceServerAPIWrapper >
HelperInterface	fHelperInterface

Member Function Documentation

virtual bool16 CusHttpLnkResourceServerAPIWrapper::AdjustURI ( const URI &  inUri, URI &  outUri  )

inlinevirtual

For internal use only

Implements IHTTPLinkResourceServerAPIWrapper.

bool16 CusHttpLnkResourceServerAPIWrapper::AsyncRequestAssetStatusWithMetadata ( IHTTPLinkResourceConnection *  connection, const URI &  assetURI, RequestAssetStatusCompletionFunction  completionFunction  )

virtual

Async mode request for the status of metadata asset for given asset URI.

Parameters

connection	[IN] HTTP Link Resource connection
assetURI	[IN] asset URI for status check
completionFunction	[IN] Asset Status Completion function

Returns

kTrue on success else kFalse.

Implements IHTTPLinkResourceServerAPIWrapper.

bool16 CusHttpLnkResourceServerAPIWrapper::AsyncRequestBatchAssetStatusWithMetadata ( IHTTPLinkResourceConnection *  connection, const URIVector &  assetURIVector, RequestBatchAssetStatusCompletionFunction  completionFunction  )

virtual

Async mode for batch request for the status of metadata for passed vector of asset URIs.

Parameters

connection	[IN] HTTP Link Resource connection
assetURIVector	[IN] vector of asset URIs for batch status check
completionFunction	[IN] Asset Status Completion Function

Returns

kTrue on success else kFalse.

Implements IHTTPLinkResourceServerAPIWrapper.

bool16 CusHttpLnkResourceServerAPIWrapper::GenerateSessionToken ( IHTTPLinkResourceConnection *  connection, std::string &  token  )

virtual

Generates the session token for the given connection

Implements IHTTPLinkResourceServerAPIWrapper.

URI CusHttpLnkResourceServerAPIWrapper::GetAssetURI ( const URI &  inURI, ILinkResourceRenditionData::ResourceRenditionType  type  ) const

inlinevirtual

For a given sample asset: Original URI format : http://localhost:3000/image/abc.jpeg FPO URI format : http://localhost:3000/image/abc.jpeg/fpo

Implements IHTTPLinkResourceServerAPIWrapper.

virtual bool16 CusHttpLnkResourceServerAPIWrapper::GetConfiguredBatchLimits ( IHTTPLinkResourceConnection *  connection, int32 &  batchLimit, long &  maxTimeinMs, long &  minTimeinMs  )

inlinevirtual

Set the configured batch limit for batch request Set the timeinMs to the configured maximum time limit for batch request Set minium time between two batch calls

Implements IHTTPLinkResourceServerAPIWrapper.

bool16 CusHttpLnkResourceServerAPIWrapper::GetHTTPBatchRequestObjectType ( const URI &  uri, HTTPLinkSubsystemTypes::BatchRequestObjectType &  objType  ) const

inlinevirtual

This API is for internal use only Set the objType to kAsset

Implements IHTTPLinkResourceServerAPIWrapper.

virtual ILinkResourceRenditionData::ResourceRenditionType CusHttpLnkResourceServerAPIWrapper::GetURIRenditionType ( const URI &  inURI ) const

inlinevirtual

GetURIRenditionType

Implements IHTTPLinkResourceServerAPIWrapper.

IHTTPLinkResourceServerAPIWrapper::AssetStatusWithMetadataPtr CusHttpLnkResourceServerAPIWrapper::RequestAssetStatusWithMetadata ( IHTTPLinkResourceConnection *  connection, const URI &  assetURI  )

virtual

Request the status of the Metadata asset specified by the assetURI on connection. e.g missing, modified etc

Implements IHTTPLinkResourceServerAPIWrapper.

virtual AssetMetadataContentPtr CusHttpLnkResourceServerAPIWrapper::RequestAssetTextFragmentContent ( IHTTPLinkResourceConnection *  connection, const URI &  inURI, ErrorCode  err = kCantPlaceMetadataError  )

inlinevirtual

For internal use only

Implements IHTTPLinkResourceServerAPIWrapper.