Celartem::ResourceBroker

Celartem::ResourceBroker Class Reference

#include <cel_broker.h>

Inheritance diagram for Celartem::ResourceBroker:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual AutoPtr< Storage > locateFile (const String &inUriOrFileName)=0

Static Public Member Functions

static AutoPtr< ResourceBroker > create ()
static AutoPtr< ResourceBroker > create (const String &inUserAgentName, CredentialProvider *inCredentialProvider=NULL)
static AutoPtr< ResourceBroker > create (HttpManager *inHttpManager)

Detailed Description

This class provides the default broker mechanism for cooperating with resources.

Definition at line 26 of file cel_broker.h.

Member Function Documentation

virtual AutoPtr<Storage> Celartem::ResourceBroker::locateFile ( const String &  inUriOrFileName  )  [pure virtual]

This method locates the resource and returns a pointer to read-only Storage instance.

Parameters:
inUriOrFileName URI or local file name of the resource. The default implementation can deal with URIs starts from http, https, file or local file names.
Returns:
Pointer to the Storage instance of the specified resource.

static AutoPtr<ResourceBroker> Celartem::ResourceBroker::create (  )  [static]

Get the default ResourceBroker implementation.
This method actually does not create a new one but returns a shared instance. This is very useful when you don't need your own ResourceBroker instance.

Returns:
Pointer to the default ResourceBroker instance.

static AutoPtr<ResourceBroker> Celartem::ResourceBroker::create ( const String &  inUserAgentName,
CredentialProvider *  inCredentialProvider = NULL 
) [static]

Create a ResourceBroker.
This method internally calls HttpManager::create to create its own HttpManager instance. For more information, see HttpManager.

Parameters:
inUserAgentName User Agent Name for your application. If this value is not specified (or NullString), it uses system default.
inCredentialProvider Pointer to a class instance to get credential information. If it is NULL, no authentication mechanism is supported by the newly created ResourceBroker instance.
Returns:
Pointer to the newly created ResourceBroker instance.

static AutoPtr<ResourceBroker> Celartem::ResourceBroker::create ( HttpManager *  inHttpManager  )  [static]

Create a new ResourceBroker instance.

Parameters:
inHttpManager Pointer to a HttpManager instance. If you don't plan to use HTTP based resources, it can be NULL.

The documentation for this class was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:13 2008.