LibreOffice Module ucbhelper (master)  1
Namespaces | Classes | Typedefs | Enumerations | Functions
ucbhelper Namespace Reference

Namespaces

 proxydecider_impl
 

Classes

class  ActiveDataSink_Base
 
class  ActiveDataStreamer
 This class implements the interface css::io::XActiveDataStreamer. More...
 
class  AuthenticationFallbackRequest
 This class implements a simple authentication interaction request used when programmatically authentication cannot succeed. More...
 
class  CommandEnvironment
 This class implements the interface css::ucb::XCommandEnvironment. More...
 
class  CommandEnvironment_Base
 
struct  CommandEnvironment_Impl
 
class  CommandProcessorInfo
 This class provides a command info ( the complete implementation of the interface XCommandInfo ) for an object derived from class ucb::ContentImplHelper. More...
 
class  Content
 This class simplifies access to UCB contents by providing a more convenient API for frequently used functionality then the "raw" UCB-API does. More...
 
class  Content_Impl
 
class  ContentIdentifier
 This class implements a simple identifier object for UCB contents. More...
 
struct  ContentIdentifier_Impl
 
class  ContentImplHelper
 This is an abstract base class for implementations of the service com.sun.star.ucb.Content. More...
 
struct  ContentProviderData
 Information about a content provider, passed to <method>configureUcb</method>. More...
 
class  ContentProviderImplHelper
 This is an abstract base class for implementations of the service com.sun.star.ucb.ContentProvider. More...
 
class  FdInputStream
 Implements a seekable InputStream working on a buffer. More...
 
class  InteractionAbort
 This class implements a standard interaction continuation, namely the interface XInteractionAbort. More...
 
class  InteractionAuthFallback
 
class  InteractionContinuation
 This class is the base for implementations of the interface XInteractionContinuation. More...
 
class  InteractionReplaceExistingData
 This class implements a standard interaction continuation, namely the interface XInteractionReplaceExistingData. More...
 
class  InteractionRequest
 This class implements the interface XInteractionRequest. More...
 
struct  InteractionRequest_Impl
 
class  InteractionRetry
 This class implements a standard interaction continuation, namely the interface XInteractionRetry. More...
 
class  InteractionSupplyName
 This class implements a standard interaction continuation, namely the interface XInteractionSupplyName. More...
 
class  InterceptedInteraction
 it wraps any other interaction handler and intercept its handle() requests. More...
 
class  InternetProxyDecider
 This class is able to decide whether and which internet proxy server is to be used to access a given URI. More...
 
struct  InternetProxyServer
 This struct describes a proxy server. More...
 
class  PropertySetInfo
 This class provides a propertyset info ( the complete implementation of the interface XPropertySetInfo ) for an object derived from class ucb::ContentImplHelper. More...
 
class  PropertyValues
 
class  PropertyValueSet
 This class implements the interface XRow. More...
 
class  ResultSet
 This is an implementation of the service com.sun.star.ucb.ContentResultSet. More...
 
struct  ResultSet_Impl
 
struct  ResultSetColumnData
 This is a structure that holds additional meta data for one column of a resultset. More...
 
class  ResultSetDataSupplier
 This is the base class for an object that supplies data to a result set. More...
 
class  ResultSetImplHelper
 This is an abstract base class for implementations of the service com.sun.star.ucb.DynamicResultSet, which is the result of the command "open" executed at a UCB folder content. More...
 
class  ResultSetMetaData
 This is an implementation of the interface XResultSetMetaData. More...
 
class  SimpleAuthenticationRequest
 This class implements a simple authentication interaction request. More...
 
class  SimpleCertificateValidationRequest
 This class implements a simple validation interaction request of a certificate. More...
 
class  SimpleInteractionRequest
 This class implements a simple interaction request. More...
 
class  SimpleIOErrorRequest
 This class implements a simple IO error interaction request. More...
 

Typedefs

typedef cppu::WeakImplHelper< css::io::XInputStream, css::io::XSeekable > FdInputStream_Base
 
typedef rtl::Reference< ContentImplHelperContentImplHelperRef
 
typedef std::vector< ContentImplHelperRefContentRefList
 
typedef std::vector< ContentProviderDataContentProviderDataList
 

Enumerations

enum  ResultSetInclude {
  INCLUDE_FOLDERS_ONLY,
  INCLUDE_DOCUMENTS_ONLY,
  INCLUDE_FOLDERS_AND_DOCUMENTS
}
 These are the possible values for the parameter eMode of method ucbhelper::Content::createCursor. More...
 
enum  InsertOperation {
  InsertOperation::Copy,
  InsertOperation::Move,
  InsertOperation::Checkin
}
 These are the possible values for the parameter eOperation of method ucbhelper::Content::insertNewContent. More...
 

Functions

static void ensureContentProviderForURL (const Reference< XUniversalContentBroker > &rBroker, const OUString &rURL)
 
static Reference< XContentIdentifier > getContentIdentifierThrow (const Reference< XUniversalContentBroker > &rBroker, const OUString &rURL)
 
static Reference< XContentIdentifier > getContentIdentifierNoThrow (const Reference< XUniversalContentBroker > &rBroker, const OUString &rURL)
 
static Reference< XContent > getContentThrow (const Reference< XUniversalContentBroker > &rBroker, const Reference< XContentIdentifier > &xId)
 
static Reference< XContent > getContentNoThrow (const Reference< XUniversalContentBroker > &rBroker, const Reference< XContentIdentifier > &xId)
 
void cancelCommandExecution (const uno::Any &rException, const uno::Reference< ucb::XCommandEnvironment > &xEnv)
 
void cancelCommandExecution (const ucb::IOErrorCode eError, const uno::Sequence< uno::Any > &rArgs, const uno::Reference< ucb::XCommandEnvironment > &xEnv, const OUString &rMessage, const uno::Reference< ucb::XCommandProcessor > &xContext)
 
 XTYPEPROVIDER_IMPL_10 (ContentImplHelper, lang::XTypeProvider, lang::XServiceInfo, lang::XComponent, css::ucb::XContent, css::ucb::XCommandProcessor, beans::XPropertiesChangeNotifier, css::ucb::XCommandInfoChangeNotifier, beans::XPropertyContainer, beans::XPropertySetInfoChangeNotifier, container::XChild)
 
bool registerAtUcb (uno::Reference< ucb::XContentProviderManager > const &rManager, uno::Reference< uno::XComponentContext > const &rxContext, OUString const &rName, OUString const &rArguments, OUString const &rTemplate)
 
UCBHELPER_DLLPUBLIC void cancelCommandExecution (const css::uno::Any &rException, const css::uno::Reference< css::ucb::XCommandEnvironment > &xEnv)
 Cancel the execution of a command by throwing the appropriate exception. More...
 
UCBHELPER_DLLPUBLIC void cancelCommandExecution (const css::ucb::IOErrorCode eError, const css::uno::Sequence< css::uno::Any > &rArgs, const css::uno::Reference< css::ucb::XCommandEnvironment > &xEnv, const OUString &rMessage=OUString(), const css::uno::Reference< css::ucb::XCommandProcessor > &xContext=nullptr)
 Cancel the execution of a command by throwing the appropriate exception. More...
 
UCBHELPER_DLLPUBLIC bool registerAtUcb (css::uno::Reference< css::ucb::XContentProviderManager > const &rManager, css::uno::Reference< css::uno::XComponentContext > const &rxContext, OUString const &rName, OUString const &rArguments, OUString const &rTemplate)
 Register a content provider at a Universal Content Broker. More...
 

Typedef Documentation

Definition at line 45 of file providerhelper.hxx.

Definition at line 60 of file registerucb.hxx.

Definition at line 47 of file providerhelper.hxx.

typedef cppu::WeakImplHelper< css::io::XInputStream, css::io::XSeekable > ucbhelper::FdInputStream_Base

Definition at line 35 of file fd_inputstream.hxx.

Enumeration Type Documentation

These are the possible values for the parameter eOperation of method ucbhelper::Content::insertNewContent.

Enumerator
Copy 
Move 
Checkin 

Definition at line 78 of file content.hxx.

These are the possible values for the parameter eMode of method ucbhelper::Content::createCursor.

Enumerator
INCLUDE_FOLDERS_ONLY 
INCLUDE_DOCUMENTS_ONLY 
INCLUDE_FOLDERS_AND_DOCUMENTS 

Definition at line 67 of file content.hxx.

Function Documentation

void ucbhelper::cancelCommandExecution ( const uno::Any rException,
const uno::Reference< ucb::XCommandEnvironment > &  xEnv 
)
UCBHELPER_DLLPUBLIC void ucbhelper::cancelCommandExecution ( const css::uno::Any &  rException,
const css::uno::Reference< css::ucb::XCommandEnvironment > &  xEnv 
)

Cancel the execution of a command by throwing the appropriate exception.

If an Interaction Handler is given with the command environment and the handler handles the exception by selecting the supplied continuation, then this function will put the original exception supplied into a css::ucb::CommandFailedException and throw the CommandFailedException. If no handler was given or the handler was not able to handle the exception, then the given exception will be thrown directly.

NOTE THAT THIS FUNCTION NEVER RETURNS! IT ALWAYS THROWS AN EXCEPTION!

Parameters
rExceptionis the exception describing the error to handle.
xEnvis the command environment that may contain an Interaction Handler to use before throwing the appropriate exception.
Exceptions
css::uno::Exception
void ucbhelper::cancelCommandExecution ( const ucb::IOErrorCode  eError,
const uno::Sequence< uno::Any > &  rArgs,
const uno::Reference< ucb::XCommandEnvironment > &  xEnv,
const OUString &  rMessage,
const uno::Reference< ucb::XCommandProcessor > &  xContext 
)

Definition at line 80 of file cancelcommandexecution.cxx.

References cppu::throwException().

UCBHELPER_DLLPUBLIC void ucbhelper::cancelCommandExecution ( const css::ucb::IOErrorCode  eError,
const css::uno::Sequence< css::uno::Any > &  rArgs,
const css::uno::Reference< css::ucb::XCommandEnvironment > &  xEnv,
const OUString &  rMessage = OUString(),
const css::uno::Reference< css::ucb::XCommandProcessor > &  xContext = nullptr 
)

Cancel the execution of a command by throwing the appropriate exception.

If an Interaction Handler is given with the command environment and the handler handles the exception by selecting the supplied continuation, then this function will put the original exception supplied into a css::ucb::CommandFailedException and throw the CommandFailedException. If no handler was given or the handler was not able to handle the exception, then the given exception will be thrown directly.

NOTE THAT THIS FUNCTION NEVER RETURNS! IT ALWAYS THROWS AN EXCEPTION!

Parameters
eErroris an IO error code.
rArgsis a sequence containing the arguments to pass along with the exception. Each IO error code can be combined with one or more additional arguments. Refer to com/sun/star/ucb/IOErroprCode.idl for details.
xEnvis the command environment that may contain an Interaction Handler to use before throwing the appropriate exception.
rMessageis a text containing additional error information. Used as debugging aid only. Passed to the member 'Message' of the uno::Exception thrown by this function.
xContextis the command processor executing the command to cancel. Used as debugging aid only. Passed to the member 'Context' of the uno::Exception thrown by this function.
Exceptions
css::uno::Exception
static void ucbhelper::ensureContentProviderForURL ( const Reference< XUniversalContentBroker > &  rBroker,
const OUString &  rURL 
)
static
Exceptions
ContentCreationException
RuntimeException

Definition at line 196 of file content.cxx.

Referenced by getContentIdentifierThrow(), and getContentThrow().

static Reference< XContentIdentifier > ucbhelper::getContentIdentifierNoThrow ( const Reference< XUniversalContentBroker > &  rBroker,
const OUString &  rURL 
)
static
Exceptions
RuntimeException

Definition at line 233 of file content.cxx.

static Reference< XContentIdentifier > ucbhelper::getContentIdentifierThrow ( const Reference< XUniversalContentBroker > &  rBroker,
const OUString &  rURL 
)
static
Exceptions
ContentCreationException
RuntimeException

Definition at line 212 of file content.cxx.

References ensureContentProviderForURL(), and xId.

static Reference< XContent > ucbhelper::getContentNoThrow ( const Reference< XUniversalContentBroker > &  rBroker,
const Reference< XContentIdentifier > &  xId 
)
static
Exceptions
RuntimeException

Definition at line 272 of file content.cxx.

References SAL_WARN, and xContent.

static Reference< XContent > ucbhelper::getContentThrow ( const Reference< XUniversalContentBroker > &  rBroker,
const Reference< XContentIdentifier > &  xId 
)
static
Exceptions
ContentCreationException
RuntimeException

Definition at line 242 of file content.cxx.

References ensureContentProviderForURL(), and xContent.

bool ucbhelper::registerAtUcb ( uno::Reference< ucb::XContentProviderManager > const &  rManager,
uno::Reference< uno::XComponentContext > const &  rxContext,
OUString const &  rName,
OUString const &  rArguments,
OUString const &  rTemplate 
)

Definition at line 41 of file registerucb.cxx.

References copy().

UCBHELPER_DLLPUBLIC bool ucbhelper::registerAtUcb ( css::uno::Reference< css::ucb::XContentProviderManager > const &  rManager,
css::uno::Reference< css::uno::XComponentContext > const &  rxContext,
OUString const &  rName,
OUString const &  rArguments,
OUString const &  rTemplate 
)

Register a content provider at a Universal Content Broker.

Parameters
rManagerA content provider manager (normally, this would be a UCB). May be null, which is only useful if the content provider is an XParameterizedContentProviders.
rServiceFactoryA factory through which to obtain the required services.
rNameThe service name of the content provider. If it is the empty string, a null provider will be used (see the documentation of the Provider argument to com.sun.star.ucb.XContentProviderManager.registerContentProvider).
rArgumentsAny arguments to instantiate the content provider with.
rTemplateThe URL template to register the content provider on.
pInfoIf not null, this output parameter is filled with information about the (attemptively) registered provider.
Exceptions
css::uno::RuntimeException
ucbhelper::XTYPEPROVIDER_IMPL_10 ( ContentImplHelper  ,
lang::XTypeProvider  ,
lang::XServiceInfo  ,
lang::XComponent  ,
css::ucb::XContent  ,
css::ucb::XCommandProcessor  ,
beans::XPropertiesChangeNotifier  ,
css::ucb::XCommandInfoChangeNotifier  ,
beans::XPropertyContainer  ,
beans::XPropertySetInfoChangeNotifier  ,
container::XChild   
)