binfilter/inc/bf_so3/transprt.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: transprt.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _TRANSPRT_HXX
  32 #define _TRANSPRT_HXX "$Revision: 1.5 $"
  33
  34 #ifndef _SOLAR_H
  35 #include <tools/solar.h>
  36 #endif
  37
  38 #ifndef _ERRCODE_HXX
  39 #include <tools/errcode.hxx>
  40 #endif
  41
  42 #ifndef _STREAM_HXX
  43 #include <tools/stream.hxx>
  44 #endif
  45
  46 #ifndef _STRING_HXX
  47 #include <tools/string.hxx>
  48 #endif
  49
  50 #ifndef _BINDING_HXX
  51 #include <bf_so3/binding.hxx>
  52 #endif
  53
  54 #ifndef INCLUDED_SO3DLLAPI_H
  55 #include "bf_so3/so3dllapi.h"
  56 #endif
  57
  58 class DateTime;
  59
  60 namespace binfilter {
  61 class SvBindingTransport;
  62 class SvBindingTransportFactory;
  63 class SvBindingTransportCallback;
  64 class SvBindingTransportContext;
  65
  66 #ifndef COPYCTOR_API
  67 #define COPYCTOR_API(C) C (const C&); C& operator= (const C&)
  68 #endif
  69
  70 /*========================================================================
  71  *
  72  * SvBindingTransport interface.
  73  *
  74  *======================================================================*/
  75 class SO3_DLLPUBLIC SvBindingTransport
  76 {
  77     /** Not implemented.
  78     */
  79     SO3_DLLPRIVATE COPYCTOR_API(SvBindingTransport);
  80
  81 public:
  82     SvBindingTransport (void);
  83     virtual ~SvBindingTransport (void);
  84
  85     virtual void Start (void) = 0;
  86     virtual void Abort (void) = 0;
  87 };
  88
  89 /*========================================================================
  90  *
  91  * SvBindingTransportFactory interface.
  92  *
  93  *======================================================================*/
  94 class SO3_DLLPUBLIC SvBindingTransportFactory
  95 {
  96     /** Not implemented.
  97     */
  98     SO3_DLLPRIVATE COPYCTOR_API(SvBindingTransportFactory);
  99
 100 public:
 101     SvBindingTransportFactory (void);
 102     virtual ~SvBindingTransportFactory (void);
 103
 104     virtual BOOL HasTransport (
 105         const String &rUrl) = 0;
 106
 107     virtual SvBindingTransport* CreateTransport (
 108         const String               &rUrl,
 109         SvBindingTransportContext  &rCtx,
 110         SvBindingTransportCallback *pCallback) = 0;
 111 };
 112
 113 /*========================================================================
 114  *
 115  * SvBindingTransportCallback interface.
 116  *
 117  *======================================================================*/
 118 class SO3_DLLPUBLIC SvBindingTransportCallback
 119 {
 120 public:
 121     virtual void OnStart (void) = 0;
 122
 123     virtual void OnError (ErrCode eErrCode) = 0;
 124
 125     virtual void OnMimeAvailable (const String &rMime) = 0;
 126
 127     virtual void OnExpiresAvailable (const DateTime &rExpires) = 0;
 128
 129     virtual void OnHeaderAvailable (
 130         const String &rName, const String &rValue) = 0;
 131
 132     virtual void OnDataAvailable (
 133         SvStatusCallbackType eType,
 134         ULONG nSize, SvLockBytes *pLockBytes) = 0;
 135
 136     virtual void OnProgress (
 137         ULONG nNow, ULONG nEnd, SvBindStatus eStatus) = 0;
 138
 139     virtual void OnRedirect (const String &rUrl) = 0;
 140 };
 141
 142 /*========================================================================
 143  *
 144  * SvBindingTransportContext.
 145  *
 146  *======================================================================*/
 147 class SO3_DLLPUBLIC SvBindingTransportContext
 148 {
 149     /** Representation.
 150     */
 151     SvBindAction   m_eBindAction;
 152     SvBindMode     m_eBindMode;
 153     StreamMode     m_eStrmMode;
 154     USHORT         m_nPriority;
 155     String         m_aReferer;
 156     String         m_aSendMimeType;
 157     SvLockBytesRef m_xPostLockBytes;
 158
 159 public:
 160     virtual ~SvBindingTransportContext (void);
 161
 162     /** BindAction.
 163     */
 164     SvBindAction GetBindAction (void) const { return m_eBindAction; }
 165     void SetBindAction (SvBindAction eAction) { m_eBindAction = eAction; }
 166
 167     /** BindMode.
 168     */
 169     SvBindMode GetBindMode (void) const { return m_eBindMode; }
 170     void SetBindMode (SvBindMode eMode) { m_eBindMode = eMode; }
 171
 172     /** StreamMode.
 173     */
 174     StreamMode GetStreamMode (void) const { return m_eStrmMode; }
 175     void SetStreamMode (StreamMode eMode) { m_eStrmMode = eMode; }
 176
 177     /** Priority.
 178     */
 179     USHORT GetPriority (void) const { return m_nPriority; }
 180     void SetPriority (USHORT nPriority) { m_nPriority = nPriority; }
 181
 182     /** Referer.
 183     */
 184     const String& GetReferer (void) const { return m_aReferer; }
 185     void SetReferer (const String &rReferer) { m_aReferer = rReferer; }
 186
 187     /** SendMimeType (actions PUT and POST).
 188     */
 189     const String& GetSendMimeType (void) const
 190     {
 191         return m_aSendMimeType;
 192     }
 193     void SetSendMimeType (const String &rSendMimeType)
 194     {
 195         m_aSendMimeType = rSendMimeType;
 196     }
 197
 198     /** PostLockBytes (actions PUT and POST).
 199     */
 200     SvLockBytes* GetPostLockBytes (void) const
 201     {
 202         return m_xPostLockBytes;
 203     }
 204     void SetPostLockBytes (SvLockBytesRef &rxPostLockBytes)
 205     {
 206         m_xPostLockBytes = rxPostLockBytes;
 207     }
 208 };
 209
 210 /*========================================================================
 211  *
 212  * SvLockBytesFactory interface.
 213  *
 214  *======================================================================*/
 215 class SO3_DLLPUBLIC SvLockBytesFactory
 216 {
 217     /** Representation.
 218     */
 219     String m_aWildcard;
 220
 221     /** Not implemented.
 222     */
 223     SO3_DLLPRIVATE COPYCTOR_API(SvLockBytesFactory);
 224
 225 public:
 226     virtual ~SvLockBytesFactory (void);
 227
 228     virtual SvLockBytesRef CreateLockBytes (
 229         const String &rUrl, String &rMime) = 0;
 230
 231     static SvLockBytesFactory* GetFactory (const String &rUrl);
 232
 233     const String& GetWildcard (void) const { return m_aWildcard; }
 234 };
 235
 236 /*========================================================================
 237  *
 238  * SfxSimpleLockBytesFactory interface.
 239  *
 240  *======================================================================*/
 241 class SO3_DLLPUBLIC SfxSimpleLockBytesFactory :
 242     public SvLockBytesFactory, public SvRefBase
 243 {
 244     /** Representation.
 245     */
 246     SvLockBytesRef m_xLockBytes;
 247     String         m_aMime;
 248
 249     static USHORT  m_nCounter;
 250
 251     /** Not implemented.
 252     */
 253     SO3_DLLPRIVATE COPYCTOR_API(SfxSimpleLockBytesFactory);
 254
 255 public:
 256     /** Destruction (protected) (SvRefBase).
 257     */
 258     virtual ~SfxSimpleLockBytesFactory (void);
 259
 260 public:
 261     virtual SvLockBytesRef CreateLockBytes (
 262         const String &rUrl, String &rMime);
 263 };
 264
 265 SV_DECL_IMPL_REF(SfxSimpleLockBytesFactory);
 266
 267 /*========================================================================
 268  *
 269  * SvLockBytesTransportFactory interface.
 270  *
 271  *======================================================================*/
 272 class SO3_DLLPUBLIC SvLockBytesTransportFactory : public SvBindingTransportFactory
 273 {
 274     /** Not implemented.
 275     */
 276     SO3_DLLPRIVATE COPYCTOR_API(SvLockBytesTransportFactory);
 277
 278 public:
 279     SvLockBytesTransportFactory (void);
 280     virtual ~SvLockBytesTransportFactory (void);
 281
 282     virtual BOOL HasTransport (
 283         const String &rUrl);
 284
 285     virtual SvBindingTransport* CreateTransport (
 286         const String               &rUrl,
 287         SvBindingTransportContext  &rCtx,
 288         SvBindingTransportCallback *pCB);
 289 };
 290
 291 /*========================================================================
 292  *
 293  * CntTransportFactory interface.
 294  *
 295  *======================================================================*/
 296 class SO3_DLLPUBLIC CntTransportFactory : public SvBindingTransportFactory
 297 {
 298     /** Not implemented.
 299     */
 300     SO3_DLLPRIVATE COPYCTOR_API(CntTransportFactory);
 301
 302 public:
 303     CntTransportFactory (void);
 304     virtual ~CntTransportFactory (void);
 305
 306     virtual BOOL HasTransport (
 307         const String &rUrl);
 308
 309     virtual SvBindingTransport* CreateTransport (
 310         const String               &rUrl,
 311         SvBindingTransportContext  &rCtx,
 312         SvBindingTransportCallback *pCB);
 313 };
 314
 315 /*========================================================================
 316  *
 317  * The End.
 318  *
 319  *======================================================================*/
 320
 321 }
 322
 323 #endif /* _TRANSPRT_HXX */
 324