/*

* All rights reserved.

* This component and the accompanying materials are made available

* which accompanies this distribution, and is available

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

*                service consumers to access invocable services, 

*                as a part of the Web Services Framework (WSF).

*

*/

#ifndef SEN_SERVICE_CONNECTION_H

#define SEN_SERVICE_CONNECTION_H

//  INCLUDES

#include <e32base.h> // for CActive

#include <MSenServiceConsumer.h>

#include <MSenServiceDescription.h>

#include <MSenAuthenticationProvider.h>

#include <SenSoapMessage.h>

#include <SenSoapMessage2.h>

//#include <SenAtomEntry.h>

#include <MSenMessage.h>

// CONSTANTS

const TInt KErrSenNotInitialized                    =   -30291;

const TInt KErrSenServiceConnectionBusy             =   -30292;

const TInt KErrConnectionInitializing               =   -30293;

const TInt KErrConnectionExpired                    =   -30294;

const TInt KErrSubmitting                           =   -30295;

const TInt KErrSenSoapFault                         =   -30296; 

const TInt KErrSenInternal                          =   -30297;

const TInt KErrSenNoEndpoint                        =   -30298;

const TInt KErrSenNoContract                        =   -30299;

const TInt KErrSenProviderIdInUseByAnotherEndpoint  =   -30305;

const TInt KErrSenNoContractNoEndPoint              =   -30306;

const TInt KErrSenBrokenSoapEnvelope                =   -30307;

const TInt KErrSenBrokenSoapFault                   =   -30308;

const TInt KErrSenCancelled                         =   -30309;

// HTTP transport error codes:

const TInt KErrSenNoHttpResponseBody                =   -30310;

const TInt KErrSenNoHttpContentType                 =   -30311;

const TInt KErrSenHttpRedirectRequiresConfirmation  =   -30312;

// SOAP message verification error codes:

const TInt KErrSenNoSoapBody                        =   -30313;

const TInt KErrSenNoSoapHeader                      =   -30314;

const TInt KErrSenNoPermission                      =   -30315; 

const TInt KErrSenHostNotAvailable                  =   -30318;

const TInt KErrSenAuthenticationFault               =   -30319;

const TInt KErrSenNoEndUserPermission               =   -30321;

const TInt KSenConnectionStatusCreateFailed         =  -1; // post-state

const TInt KSenConnectionStatusNew                  =   0; // post-state

const TInt KSenConnectionStatusReady                =   1; // post-state

const TInt KSenConnectionStatusExpired              =   2; // post-state

const TInt KSenConnectionStatusAuthentication       =   3; // pre-state

const TInt KSenConnectionStatusDiscovery            =   4; // pre-state

const TInt KSenConnectionStatusMetadataExchange     =   5; // pre-state

_LIT8(KDefaultBasicWebServicesFrameworkID,          "WS-I");

_LIT8(KDefaultIdWsfFrameworkID,                     "ID-WSF"); 

_LIT8(KDefaultRestServicesFrameworkID,              "REST");

_LIT8(KDefaultWSStarFrameworkID,                    "WS-STAR");

_LIT8(KDefaultAtomPubFrameworkID,                   "ATOM-PUB");

_LIT8(KDefaultOviFrameworkID,                       "OVI");

const TInt KSenTransportStatusCodeOffsetBaseHttp = 1000;

const TInt KSenTransportStatusCodeOffsetBaseVtcp = 2000;

const TInt KSenTransportStatusCodeVtcpInit =        2001; // KSenTransportStatusCodeOffsetBaseVtcp +1 

const TInt KSenTransportStatusCodeVtcpActive =      2002; // KSenTransportStatusCodeOffsetBaseVtcp +2 

const TInt KSenTransportStatusCodeVtcpSuspended =   2003; // KSenTransportStatusCodeOffsetBaseVtcp +3 

const TInt KSenTransportStatusCodeVtcpInactive =    2004; // KSenTransportStatusCodeOffsetBaseVtcp +4

const TInt KSenTransportStatusCodeVtcpUnavailable = 2005; // KSenTransportStatusCodeOffsetBaseVtcp +5

// FORWARD DECLARATIONS

class CSenServicePattern;

class CSenIdentityProvider;

// CLASS DECLARATION

/**

  * The class for connecting to service providers

  * through Web Services Framework (WSF). 

  *

  * The class offers asynchronous construction of a

  * service connection. Further, there are asynchronous

  * and synchronous interaction methods for e.g. sending 

  * and receiving data from (possibly remote) service.

  * 

  * WSF offers two default frameworks:

  *

  *   1. Identity Based Web Services Framework

  *      (ID-WSF). The framework ID for this is 

  *      KDefaultIdWsfFrameworkID ("ID-WSF").

  * 

  *   2. Basic Web Services Framework. Framework

  *      ID is KDefaultBasicWebServicesFrameworkID

  *      ("WS-I").

  * 

  * The most typical use of CSenServiceConnection

  * is to interact with a service of certain type

  * through some invocable framework and submitting

  * and receiving messages.

  *

  * In case of WebServices, the actual service is remote

  * and submitted messages are SOAP envelopes. However,

  * CSenServiceConnection supports accessing any

  * ServiceInvocationFramework which ECOM plug-in

  * implementation is present. These plug-ins may

  * further communicate with some service, including

  * local services. 

  * 

  * The link between CSenServiceConnection and any plug-in

  * implementation interacting with some service is the

  * framework ID, which is a property of ServiceDescription (SD)

  * and accessible via MSenServiceDescription interface, which

  * each SD class must implement. 

  * 

  * When creating a connection, one offers predefined SD as

  * an argument for asynchronous constructor. Or, optionally 

  * only a Liberty Alliance ID-WSF specific contract string 

  * - typically some URN. If only contract is offered, then

  * the created connection defaults to ID-WSF service and 

  * ID-WSF framework (ID) will be used.

  * 

  * The WSF further uses the offered framework ID while looking

  * up any matching framework plug-in implementation. As a

  * result the SD might be offered to several plug-ins.

* 

* @lib SenServConn.lib

*  @since Series60 3.0

*/

class CSenServiceConnection : public CActive, public MSenFragment

    {

    public: // Constructors and destructor

        /**

        * Two-phased constructor intended for Identity based service 

        * consumers (like ID-WSF). The pointer is left on the cleanup stack.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is performed

        * with a status value KSenConnectionStatusReady (1).

        * Contract of the service (typically some URN) is provided.

        * Authentication for the Web Service Provider (WSP) connection 

        * is resolved using one of the identity providers which have 

        * been associated with this contract (typically an URN).

        *

        * This constructor is ASYNCHRONOUS and the actual state of newly

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, a SetStatus call-back with value

        * KSenConnectionStatusReady (1) is executed.

        * If some error occurs, HandleErrorL() will be called to inform the

        * creator of this connection (service consumer application)

        *

        *    For example, if service is not found, a system wide error

        *    code of -1 is deliver via HandleErrorL() to WSC.

        *

        *    Second example: server response HTTP 501 means, that this error

        *    code. 501 will be delivered via HandleErrorL() to WSC.

        *    This can happen in ID-WSF connection being initialized, if

        *    either Authentication Service (AS) or Discovery Service (DS)

        *    cannot be reached.

        *

        * @param aConsumer      (web) service consumer (for call-backs)

        * @param aContract      contract of the service, typically an URI.

        * @return a pointer to a CSenServiceConnection instance.

        *

        */

        IMPORT_C static CSenServiceConnection* NewL(MSenServiceConsumer& aConsumer,

                                                    const TDesC8& aContract);

        /**

        * Two-phased constructor intended for Identity based service 

        * consumers (like ID-WSF). 

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() and

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is performed

        * with a status value KSenConnectionStatusReady (1).

        * Contract of the service (typically some URN) is provided.

        * Authentication for the Web Service Provider (WSP) connection 

        * is resolved using one of the identity providers which have 

        * been associated with this contract (typically an URN).

        * This constructor is ASYNCHRONOUS and the actual state of newly

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, a SetStatus call-back with value

        * KSenConnectionStatusReady (1) is executed.

        * If some error occurs, HandleErrorL() will be called to inform the

        * creator of this connection (service consumer application)

        *

        *    For example, if service is not found, a system wide error

        *    code of -1 is deliver via HandleErrorL() to WSC.

        *

        *    Second example: server response HTTP 501 means, that this error

        *    code. 501 will be delivered via HandleErrorL() to WSC.

        *    This can happen in ID-WSF connection being initialized, if

        *    either Authentication Service (AS) or Discovery Service (DS)

        *    cannot be reached.

        *

        * @param aConsumer      (web) service consumer (for call-backs)

        * @param aContract      contract of the service, typically an URI.

        * @return a pointer to a CSenServiceConnection instance.

        *                       The pointer is left on the cleanup stack.

        */

        IMPORT_C static CSenServiceConnection* NewLC(MSenServiceConsumer& aObserver,

                                                     const TDesC8& aContract);

        /**

        * Two-phased constructor using a service description.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() and

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is executed

        * with a status value KSenConnectionStatusReady (1)

        * For ID-WSF connections, the authentication for the Web Service

        * Provider (WSP) connection is resolved using one of the identity 

        * providers which have been associated with the contract found in 

        * the SD. At minimum, the contract of the service (typically some URN)

        * has to provided in the SD.

        * Basic Web Service consumers instantiate a SD where an endpoint

        * and framework ID KDefaultBasicWebServicesFrameworkID are defined.

        * @param    aObserver connection observer.

        * @param    aServiceDescription is the description used to

        *               obtain a service connection.

        * @return   a pointer to a CSenServiceConnection instance.

        */

        IMPORT_C static CSenServiceConnection* NewL(MSenServiceConsumer& aObserver,

                                                    MSenServiceDescription& aServiceDescription);

        /**

        * Two-phased constructor using a service description. The pointer

        * is left on the cleanup stack.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is executed

        * with a status value KSenConnectionStatusReady (1)

        * For ID-WSF connections, the authentication for the Web Service

        * Provider (WSP) connection is resolved using one of the identity 

        * providers which have been associated with the contract found in 

        * the SD. At minimum, the contract of the service (typically some URN)

        * has to provided in the SD.

        * Basic Web Service consumers instantiate a SD where an endpoint

        * and framework ID KDefaultBasicWebServicesFrameworkID are defined.

        * @param    aObserver connection observer.

        * @param    aServiceDescription is the description used to

        *               obtain a service connection.

        * @return   a pointer to a CSenServiceConnection instance.

        *               The pointer is left on the cleanup stack.

        */

        IMPORT_C static CSenServiceConnection* NewLC(MSenServiceConsumer& aObserver,

                                                     MSenServiceDescription& aServiceDescription);

        /*

        * The ServicePattern version of two phased constructor. 

        * Note, that this method is intended to be used by service consumers

        * wishing to initialize connection in specific context called

        * consumer policy. In consumer policy, certain properties 

        * can be set to further define what kind of connection is acceptable

        * and how the connection interacts with transport (for example, which

        * Internet Access Point (IAP) will be used).

        * However, any ConsumerPolicy feature is applicable in 

        * one-policy-per-client scope and not used as a common policy.

        * To set permanent information about known WSP, please use the

        * CSenXmlServiceDescription, which implements MSenProviderPolicy

        * interface.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() and

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is executed

        * with a status value KSenConnectionStatusReady (1)

        * For ID-WSF connections, the authentication for the Web Service

        * Provider (WSP) connection is resolved using one of the identity 

        * providers which have been associated with the contract found in 

        * the SD. At minimum, the contract of the service (typically some URN)

        * has to provided in the SD.

        * Basic Web Service consumers instantiate a SD where an endpoint

        * and framework ID KDefaultBasicWebServicesFrameworkID are defined.

        * @param    aObserver connection observer.

        * @param    aServiceDescription is the description used to

        *               obtain a service connection. 

        * @return   a pointer to a CSenServiceConnection instance.

        */

        IMPORT_C static CSenServiceConnection* NewL(MSenServiceConsumer& aObserver,

                                                    CSenServicePattern& aServicePattern);

        /*

        * The ServicePattern version of two phased constructor. 

        * Note, that this method is intended to be used by service consumers

        * wishing to initialize connection in specific context called

        * consumer policy. In consumer policy, certain properties 

        * can be set to further define what kind of connection is acceptable

        * and how the connection interacts with transport (for example, which

        * Internet Access Point (IAP) will be used).

        * However, any ConsumerPolicy feature is applicable in 

        * one-policy-per-client scope and not used as a common policy.

        * To set permanent information about known WSP, please use the

        * CSenXmlServiceDescription, which implements MSenProviderPolicy

        * interface.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() and

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is executed

        * with a status value KSenConnectionStatusReady (1)

        * For ID-WSF connections, the authentication for the Web Service

        * Provider (WSP) connection is resolved using one of the identity 

        * providers which have been associated with the contract found in 

        * the SD. At minimum, the contract of the service (typically some URN)

        * has to provided in the SD.

        * Basic Web Service consumers instantiate a SD where an endpoint

        * and framework ID KDefaultBasicWebServicesFrameworkID are defined.

        * @param    aObserver connection observer.

        * @param    aServiceDescription is the description used to

        *               obtain a service connection. 

        * @return   a pointer to a CSenServiceConnection instance.

        *               The pointer is left on the cleanup stack.

        */

        IMPORT_C static CSenServiceConnection* NewLC(MSenServiceConsumer& aObserver,

                                                     CSenServicePattern& aServicePattern);

        /**

        * Two-phased constructor intended for Identity based service 

        * consumers (like ID-WSF). The pointer is left on the cleanup stack.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is performed

        * with a status value KSenConnectionStatusReady (1).

        * Contract of the service (typically some URN) is provided.

        * Authentication for the Web Service Provider (WSP) connection 

        * is resolved using one of the identity providers which have 

        * been associated with this contract (typically an URN).

        *

        * This constructor is ASYNCHRONOUS and the actual state of newly

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, a SetStatus call-back with value

        * KSenConnectionStatusReady (1) is executed.

        * If some error occurs, HandleErrorL() will be called to inform the

        * creator of this connection (service consumer application)

        *

        *    For example, if service is not found, a system wide error

        *    code of -1 is deliver via HandleErrorL() to WSC.

        *

        *    Second example: server response HTTP 501 means, that this error

        *    code. 501 will be delivered via HandleErrorL() to WSC.

        *    This can happen in ID-WSF connection being initialized, if

        *    either Authentication Service (AS) or Discovery Service (DS)

        *    cannot be reached.

        *

        * @param aConsumer      (web) service consumer (for call-backs)

        * @param aContract      contract of the service, typically an URI.

        * @return a pointer to a CSenServiceConnection instance.

        * @param aAuthProvider      Authentication Provider

        */        

        IMPORT_C static CSenServiceConnection* NewL(MSenServiceConsumer& aConsumer,

                                                    const TDesC8& aContract,

                                                    MSenExtendedConsumerInterface& aExtendedConsumer);

        /**

        * Two-phased constructor intended for Identity based service 

        * consumers (like ID-WSF). 

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() and

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is performed

        * with a status value KSenConnectionStatusReady (1).

        * Contract of the service (typically some URN) is provided.

        * Authentication for the Web Service Provider (WSP) connection 

        * is resolved using one of the identity providers which have 

        * been associated with this contract (typically an URN).

        * This constructor is ASYNCHRONOUS and the actual state of newly

        * created connection has to be observed from SetStatus() AND

        * HandleErrorL() functions.

        * If service is found, a SetStatus call-back with value

        * KSenConnectionStatusReady (1) is executed.

        * If some error occurs, HandleErrorL() will be called to inform the

        * creator of this connection (service consumer application)

        *

        *    For example, if service is not found, a system wide error

        *    code of -1 is deliver via HandleErrorL() to WSC.

        *

        *    Second example: server response HTTP 501 means, that this error

        *    code. 501 will be delivered via HandleErrorL() to WSC.

        *    This can happen in ID-WSF connection being initialized, if

        *    either Authentication Service (AS) or Discovery Service (DS)

        *    cannot be reached.

        *

        * @param aConsumer      (web) service consumer (for call-backs)

        * @param aContract      contract of the service, typically an URI.

        * @param aAuthProvider      Authentication Provider        

        * @return a pointer to a CSenServiceConnection instance.

        *                       The pointer is left on the cleanup stack.

        */    

        IMPORT_C static CSenServiceConnection* NewLC(MSenServiceConsumer& aConsumer,

                                                     const TDesC8& aContract,

                                                     MSenExtendedConsumerInterface& aExtendedConsumer);

        /**

        * Two-phased constructor using a service description.

        * This constructor is ASYNCHRONOUS and the actual state of

        * created connection has to be observed from SetStatus() and

        * HandleErrorL() functions.

        * If service is found, the SetStatus() call-back is executed

        * with a status value KSenConnectionStatusReady (1)

        * For ID-WSF connections, the authentication for the Web Service

        * Provider (WSP) connection is resolved using one of the identity