9 Openreach Web Services Gateway Deliverables

stizzahaddockΛογισμικό & κατασκευή λογ/κού

14 Δεκ 2013 (πριν από 3 χρόνια και 10 μήνες)

155 εμφανίσεις

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
1

of
23







Openreach Web Services Gateway


OT FT

Web Service Interface Design



10
th

November

2009





Openreach Web Services Gateway OT FT Web Service Interface Design




Page
2

of
23











Legal notice


BT maintains that all reasonable care and skill has been used in the compilation of this publication.
However, BT shall not be under any li
ability for loss or damage (including consequential loss)
whatsoever or howsoever arising as a result of the use of this publication by the reader, his
servants, agents or any third party.


The contents of this document shall not be reproduced in whole or
in part without the written
consent of Openreach.


Standard terms and conditions apply to the provision of the services described in this document.



British Telecommunications plc

Registered office: 81
,

Newgate Street, London EC1A 7AJ

Registered in Englan
d no. 1800000


Document history



Revision


Author


Date


Notes


Draft
0
.1

Neeraj Kumar Jadaun

9
th

June 2009


1.1

Neeraj Kumar Jadaun

7
th

July 2009


1.2

Neeraj Kumar Jadaun

29
th

July 2009

Updated the Test documents

1.3

Neeraj Kumar Jadaun

4
th

August 20
09

Updated soap
-
fault and read
time out value

1.4

Neeraj Kumar Jadaun

5
th

August 2009


1.5

Neeraj Kumar Jadaun

17
th

August 2009

Removed few un
-
necessary
references

1.6

Martin Heath

10
th

November 2009

Update of Legal section





Openreach Web Services Gateway OT FT Web Service Interface Design




Page
3

of
23





Contents


Page

1

Introduction

4

1.1

Intended Audience

4

2

Architecture

5

2.1. E2E Diagram for OT FT exposure by Openreach Web Services Gateway

5

3

Web Service Implementation

6

3.1 Fault Tracker Web Service Request

6

3.2 Order Tracker Web Service Request

6

3.3 WSDL

7

3.4 XMLs

7

3.4.1 Fault Tracker

7

3.4.2 Order Tracker

8

4

Web Service Client

10

4.1

Web Service Communication

10

4.2

HTTPS/SSL

11

4.3

Digital Certificates

11

5

Monitoring

12

6

Authorization and Authentication

13

7

Appendix A
-

Exception Handling

14

7.1 Error Types

14

7.2 Messa
ge Types

15

7.2.1 Web Service SOAP Fault

15

7.3

Timeouts

19

8

Client characteristics

20

9

Openreach Web Services Gateway Deliverables

21

9.1 Test Document

21

10

References

22

11

Glossary

23

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
4

of
23





1

Introduction

This doc
ument provides
the
detailed design

of
Order Tracker and Fault Tracker Web
Service
exposed by Openreach
Web Service
s Gateway
.

It describes the interaction between
CP and
Openreach Web Service Gateway and between

Openreach

Web Services Gateway and OR Portal
.


1.1

Intended Audience


The document is intended for
communications provi
der

technical teams responsible for designing
and building clients that will call into the
Openreach Web Services Gateway.


Note: In this document the term “CP” is used to represent “
Communication Provider
”.


Openreach Web Services Gateway OT FT Web Service Interface Design




Page
5

of
23





2

Architecture

2.1.

E2E Diagram for

OT FT expos
ure by Openreach
Web Services Gateway

























Figure 1












CP
s


The

Fault Tracker and Order Tracker would be securely
exposed to CPs by Openreach Web Service Gateway. This
communication

will happen over SSL.
CPs need

to have the
public certificate of Openreach Web Service Gateway in its
keystore while Openreach Web Service Gateway needs to have
the public certificate of CP in its keystore in order to facilitate
mutual authentication

based on PKI infrastructure
.


Openreach Web Service
Gateway


Openreach

Web Service Gateway

receives the Web Service
request over HTTPS various CPs.


Openreach Web Service Gateway

does the following
validations:

1.

WSDL Validation


2.

DunsID Validation


If the above validations are succes
sful,
the request is proxied
to
Openreach Portal.

Openreach Portal

sends the
Web Service Response back to
Openreach Web Service Gateway
(which in turn to
CP) In the
same transaction.


Openreach Portal

Openreach Portal actually hosts the Fault Tracker and

Order
Tracker Web service (exposed by Openreach Web Service
Gateway to the CP).

Openreach Portal also provides a DR
solution. It has two sites (one at Derby and another at St.
Just)
.
The Derby site is the primary site while the St. Just
site is passive si
te. In case Derby site goes down then
Openreach Web Services Gateway has to manually point to
the St. Just Openreach Portal address.

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
6

of
23





3

Web Service Implementation

The
Openreach
Web Services Gateway
securely exposes the following Web Services.

3.1

Fault
Tracker Web Service Request

The
Fault Tracker Web Service Request

contains one operation:



getFaults
WithNotes

Operation

This operation is responsible for returning a single fault and its associated notes displayed in fault
tracker application as a web
-
ser
vice response
.




3.2

Order

Tracker Web Service Request

The Order

Tracker Web Service Request

contains
one operation:


getOrders
WithNotes

Operation

This method is responsible for returning a single order and its associated notes displayed in order
tracker

application as a web
-
service response.




A Web Service Request will be sent and corresponding response will be returned all in the same
communication session.



Openreach Web Services Gateway OT FT Web Service Interface Design




Page
7

of
23





3.3 WSDL

A WSDL file defines the Web Service call and operation names.

This is much like a
schema and all Web Service calls must conform to the corresponding WSDL or it
will be rejected by
Openreach
Web Services Gateway.


Please find the
Fault Tracker and Order Tracker WSDL as exposed by
Openreach Portal.






3.4 XMLs


This

section defines the structure of
message body

to be transacted between
Openrea
ch
Web
Services Gateway

and Openreach Portal.


3.4.1 Fault Tracker

3.4.1
.1

Fault Tracker
getFaultsWithNotes

Operation

This operation is responsible for returning a single fault
and its associated notes displayed in fault
tracker application as a web
-
service response.


Request


<SOAP
-
ENV:Envelope xmlns:SOAP
-
ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP
-
ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://
www.w3.org/2001/XMLSchema
-
instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">


<SOAP
-
ENV:Body>



<m:getFaultsWithNotes xmlns:m="services:FaultTrackerServices">




<m:header>





<m:dunsId>String</m:dunsId>





<m:userType>String</m:userType>




</m:hea
der>




<m:faultServiceInputParams>





<m:filterConditions>






<m:item>







<m:key>String</m:key>







<m:value>String</m:value>






</m:item>





</m:filterConditions>





<m:otherParams>






<m:item>







<m:key>String</m:key>







<m:value>Str
ing</m:value>






</m:item>





</m:otherParams>





<m:serviceId>
-
0</m:serviceId>




</m:faultServiceInputParams>



</m:getFaultsWithNotes>


</SOAP
-
ENV:Body>

</SOAP
-
ENV:Envelope>


The
valu
e

of
dunsId

element should be equal to the Duns Id of the CP other
wise the request will
not be author
ise
d by Openreach Web Service Gateways and an error message will be sent to the
CP requesting to send the request with correct Duns Id.


The value of the
userType

should be CP_USER else the request will be rejected by Op
enreach
Web Services Gateway

and an error message will be sent to the CP requesting to send the request
with correct
userType

value.

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
8

of
23







Response






3.4
.2

Order

Tracker

3.4.2
.1

Order

Tracker
getOrdersWithNotes

Operation

This method is r
esponsible for returning associated notes displayed in order tracker application for
given order id as a web
-
service response.


Request


<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="services:OrderTrackerServices">


<soapenv:Header/>


<soapenv:Body>


<ser:getNotes>


<ser:header>


<ser:dunsId></ser:dunsId>


<ser:userType></ser:userType>


</ser:header>


<ser:noteServiceInputParams>


<ser:filterCondition
s>


<!
--
Zero or more repetitions:
--
>


<ser:item>


<ser:key>orderId</ser:key>


<ser:value>1
-
94752469992</ser:value>


</ser:item>


<ser:item>


<ser:key
>productType</ser:key>


<ser:value>WLR</ser:value>


</ser:item>


</ser:filterConditions>


<ser:otherParams>


<!
--
Zero or more repetitions:
--
>


<ser:item>


<se
r:key></ser:key>


<ser:value></ser:value>


</ser:item>


</ser:otherParams>


</ser:noteServiceInputParams>


</ser:getNotes>


</soapenv:Body>

</soapenv:Envelope>


The value of
dunsId

element should be
equal to the Duns Id of the CP otherwise the request will
not be author
ise
d by Openreach Web Service Gateways and an error message will be sent to the
CP requesting to send the request with correct Duns Id.


The value of the
userType

should be CP_USER els
e the request will be rejected by Openreach
Web Services Gateway

and an error message will be sent to the CP requesting to send the request
with correct
userType

value.




Openreach Web Services Gateway OT FT Web Service Interface Design




Page
9

of
23






Response









Openreach Web Services Gateway OT FT Web Service Interface Design




Page
10

of
23





4

Web Service Client

The
CP

Web Service client w
ill call Openreach

Web Services Gateway

synchronously.


This means that when the application wishes to call a
Web

Service it calls the Web Service Client
with the correct Message and the client then makes the Web Service call. It then synchronously
receive
s the response and sends it back to the application.




4.1

Web Service Communication


As indicated, the communication is synchronous

and is made vi
a an HTTP
S

Post to a URI exposed
by the
Openreach
Web Service Gateway
. The response to this request will be
returned in the same
communication session
.



























Figure 2
: Components involved in Web Service call to
Openreach

Web Services Gateway
and
then to Openreach Portal.

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
11

of
23






4.2

H
TTPS/SSL


As mentioned above, the protocol

between
CP and Openre
ach

Web Services Gateway

is HTTPS
and this means that the Web Service link

(in the red side world i.e. out side of
Openreach

domain)

is
secured by the use of certificates as seen in the figure above.


The connection will be a two way SSL connection which
is also known as mutual authentication.
With two
-
way SSL the
Openreach

Web Services Gateway

verifies that it is
CP (registered CP)
,
which is communicating with, and likewise
CP verifies that it is a trusted party (Openreach

Web
Services Gateway
)
, which is
serving

the Web Service call.

All encryption/decryption should take place at the protocol level so that the application developer
need not be too concerned about this. When making the HTTPS post the client needs to indicate
the location of the digital cer
tificates so the protocol layer can encrypt the request and make the
SSL Handshake.

Openreach

Web Services Gateway

does this with some SSL/Certificate
/Policy

configuration.

The client needs to open a new SSL session for each Web Service call.
I.e
. one SSL
Session per
Web Service Request. Once the Client receives the response the SSL connection should be
terminated.

Supported Cipher Suites for SSL connection:



TLS_RSA_WITH_AES_256_CBC_SHA



TLS_DHE_RSA_WITH_AES_256_CBC_SHA



TLS_RSA_WITH_AES_128_CBC_SHA



TLS_DH
E_RSA_WITH_AES_128_CBC_SHA



SSL_RSA_WITH_3DES_EDE_CBC_SHA



SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA




4.3

Digital Certificates


As mentioned in the above section two way SSL is being used and therefore both client and server
certificates are required.

Openreach

W
eb Services Gateway

is responsible for holding the
Openreach
keypair and
CPs (registered CP)

public key.





Openreach Web Services Gateway OT FT Web Service Interface Design




Page
12

of
23





5

Monitoring

This section describes the monitoring that takes place on the
Openreach
Web Services Gateway

platform.


Note
-

Appendix A describes th
e exception messages that can be returned to
the Web Service

client. It is the responsibility of the client to monitor and evaluate
the outcome of each Web Service

call.



The

Openreach

Web Service
s

Gateway does not actively monitor business rule failures
. In these
cases the transaction is deemed to have been correctly processed by
Openreach
Web Services
Gateway

hence it is the
C
P’s responsibility to verify the Web Service Request.






Openreach Web Services Gateway OT FT Web Service Interface Design




Page
13

of
23





6

Authorization and Authentication

Openreach
Web Services Gateway

does t
he authentication and authorization of the incoming
request from various CPs. The certificate of the CP used in successful SSL handshake is also used
in validating the DunsId of the CP.

If the Duns Id validation fails then Openreach
Web Services
Gateway

se
nds
the Soap
-
Fault with

HTTP 401 response

code

(Unauthor
ise
d request) back to the
CP else it proxies the author
ise
d request to the Openreach portal.


Openreach Web Services Gateway OT FT Web Service Interface Design




Page
14

of
23





7

Appendix A
-

Exception Handling

This section is intended to summar
ise

all the exceptions types that can o
ccur whilst interacting with
the
Openreach Web Services Gateway


7.1
Error Types

The following types of error can occur.

Error

Type

Description


Resolving
Party

Resolving

Action

Message
Type


From

To


Business

Error


A “business error” is an

event thrown as a result of a
business validation fai
lure but
where the system is still
operating within the functional
specification e.g. the CP does
not own the circuit
.


CP

CP will
investigate
and then
resubmit
message.


Web Service
SOAP
Response


Openreach
Web
Services
Gateway

(actually
coming from
Openr
each
Portal)

CP

Invalid Duns
ID

A message confirming that
the “Request” has NOT
passed

Duns ID validation

and will NOT be forwarded to
the
Openreach Portal

CP

CP to send
request
with correct
Duns ID

Web
Service
SOAP
-
Fault
with HTTP
Error Code
401

Openreac
h
Web
Services
Gateway

CP

Request

Validation

Error

A message confirming that
the “Request” has NOT
passed initial validation
against the WSDL and will
NOT be forwarded to the BT
backend system.

CP

CP will
investigate
and then
resubmit
message.

Web Service

SOAP Fault

With HTTP
Error Code
400

Openreach
Web
Services
Gateway

CP

Openreach
Portal
technical
exception

A message from
Openreach
Portal

indicating there is a

technical problem with the

Openreach Portal

systems
and the message cannot be
processed at th
is time.


e.g. “Internal system
unavailable
-

please retry
later. If still unsuccessful
please contact the helpdesk”.

Openreach
Portal

Openreach
portal

will
investigate.

CP to
resubmit
message at
a later time.


Web Service
SOAP Fault


Openreach
Web
Service
s
Gateway
(Coming from
Openreach
Portal
)

CP

Timeout
within
Openreach

A timeout has occurred
whilst
Openreach Portal
is
processing a Web Service
Request. This will typically
happen after
30

seconds
(configurable).


Openreach
and CP

Openreach

will
investig
ate.

CP

to
resubmit
message at
a later time.

Web Service
SOAP Fault

with HTTP
500 Error
Code

Openreach
Web
Services
Gateway

CP

CP

Web
Service Client
Timeout

A timeout has occurred on
the Client whilst calling the
Openreach
Web Service
Gateway. The timeou
t
seconds c
an be set locally
by the client (It should be
more than 30 seconds).

CP,
Openreach

CP,
Openreach
to

identify
point of
failure
causing
timeout

None

-

-

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
15

of
23





7.2
Message Types

This section describes the Message

Types that can be received by a Web Service Client in an error
condition.


7
.2.1

Web Service SOAP Fault


As described in the section above the
CP

may get back certain types of exceptions in the format of
a Web Service SOAP Fault. Below are examples of
possible SOAP faults for the different error
types defined in the table above:
-



Error Template


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<soap:Fault>

<faultcode>soap:Client</faultcode>

<faultstring xml:lang="e
n
-
US">

</faultstring>

<detail>

<fs:Detail xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
fault
-
detail">

<fs:SystemName></fs:SystemName>

<fs:User></fs:User>

<fs:Policy></fs:Policy>

<fs:TaskList/>

<fs:Task/>

</fs:Detail>

</detail>


</soap:Fault>

</soap:B
ody>

</soap:Envelope>



Optional && Specific to

Openreach Web Services Gateway


Fault code :: Specific to
Openreach Web Services Gateway

fs:SystemName ::
Openreach Web Services Gateway

System Name

fs:User :: User invoking the Service

fs:Policy :: Specifi
c to
Openreach Web Services Gateway

fs:TaskList :: Specific to
Openreach Web Services Gateway

fs:Task :: Specific to
Openreach Web Services Gateway


Mandatory



Faultstring

:: Contains the Error Message

fs:Detail :: Value is specific to
Openreach Web

Services Gateway




















Openreach Web Services Gateway OT FT Web Service Interface Design




Page
16

of
23





Errors to CP

----------------------
-----------------------------------


Invalid
DUNS ID (Duns Id in the

message does not matching Cli
ent Certificate)


<soap:Envelope>


<soap:Body>


<soap:Fault>


<faultcode>soap:
Server</faultcode>


<faultstring>Openreach Web Services Gateway (NBK
-
BNG
-
925534) has experienced a problem with your
request. Please see below for technical reason:
-

IDP Rule &apos;Process Error&apos; aborted processing.

Invalid Duns ID or Invalid use
rType</faultstring>


<detail>


<fs:Detail


xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
fault
-
detail">


<fs:SystemName>NBK
-
BNG
-
925534</fs:SystemName>


<fs:User></fs:User>


<fs:Policy>OpenreachPortalInva
lidDunsIDXMLPolicy</fs:Policy>


<fs:TaskList>OpenreachPortalInvalidDunsIDTaskList</fs:TaskList>


<fs:Task>Abort Processing</fs:Task>


</fs:Detail>


</detail>


</soap:Fault>


</soap:Body>

</soap:Envelope>


Invalid userType
(userType not equal to CP_USER )


<soap:Envelope>


<soap:Body>


<soap:Fault>


<faultcode>soap:Server</faultcode>


<faultstring>Openreach Web Services Gateway (NBK
-
BNG
-
925534) has experienced a problem with your
request. Please see below for te
chnical reason:
-

IDP Rule &apos;Process Error&apos; aborted processing.

Invalid Duns ID or Invalid userType</faultstring>


<detail>


<fs:Detail


xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
fault
-
detail">


<fs:SystemName
>NBK
-
BNG
-
925534</fs:SystemName>


<fs:User></fs:User>


<fs:Policy>OpenreachPortalInvalidDunsIDXMLPolicy</fs:Policy>


<fs:TaskList>OpenreachPortalInvalidDunsIDTaskList</fs:TaskList>


<fs:Task>Abort Processing</fs:Task>



</fs:Detail>


</detail>


</soap:Fault>


</soap:Body>

</soap:Envelope>




Bad URL

(
CP
calling bad URL on

Openreach
Web Services Gateway
)


<soap:Envelope>

<soap:Body>


<soap:Fault>


<faultcode>soap:Server</faultcode>


<faultstring>
Openreach Web Services Gateway (NBK
-
BNG
-
925534) has experienced a problem with your
request. Please see below for technical reason :
-

The requested virtual directory was not found</faultstring>


<detail>


<fs:Detail


xmlns:fs="http://w
ww.forumsystems.com/2004/04/soap
-
fault
-
detail">


<fs:SystemName>NBK
-
BNG
-
925534</fs:SystemName>


<fs:User></fs:User>


<fs:Policy>OpenreachFaultTrackerWSDL
-
TestHTTPSListener</fs:Policy>


<fs:TaskList></fs:TaskList>



<fs:Task></fs:Task>


</fs:Detail>


</detail>

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
17

of
23






</soap:Fault>


</soap:Body>

</soap:Envelope>


</soap:Body>

</soap:Envelope>



Invalid incoming request failed to pass WSDL validation at
Openreach

Web Services Gateway

(one
such example)


<s
oap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">


<soap:Body>


<soap:Fault>


<faultcode>soap:Client</faultcode>


<faultstring xml:lang="en
-
US">IDP Rule &apos;Process Error&apos; aborted processing.

cvc
-
complex
-
type.2.4.a:
Invalid content was found starting with element &apos;ser:keyy&apos;. One of
&apos;{&quot;services:FaultTrackerServices&quot;:key}&apos; is expected.</faultstring>


<detail>


<fs:Detail


xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
f
ault
-
detail">


<fs:SystemName>xmlevaluation1</fs:SystemName>


<fs:User>999999999</fs:User>


<fs:Policy>OR
-
Portal
-
FaultTracker
-
v1.0</fs:Policy>


<fs:TaskList></fs:TaskList>


<fs:Task></fs:Task>


</fs:Detai
l>


</detail>


</soap:Fault>


</soap:Body>

</soap:Envelope>





Large payload error


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<soap:Fault>

<faultcode>soap:Client</faultcode>

<faultstring xml:lang="en
-
US">I
DP Rule 'Large Payload' aborted processing.

The size of the document including the payload, 93359 bytes, exceeds the maximum payload allowed,
51,200 bytes.</faultstring>

<detail>





<fs:Detail xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
fault
-
det
ail">






---------------------------------------


---------------------------------------





</fs:Detail>




</detail>
</soap:Fault>

</soap:Body>

</soap:Envelope>



The size specified in the error message depends on the v
alue set in
Web Services Gateway

and the
XML size sent.
Openreach Web Services Gateway OT FT Web Service Interface Design




Page
18

of
23





Read t
imeout within

Openreach

Web Services Gateway

Platform:
-


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">


<soap:Body>


<soap:Fault>


<faultcode>soap:Server</fault
code>


<faultstring xml:lang="en
-
US">Read timed out</faultstring>

<detail>





<fs:Detail xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
fault
-
detail">






---------------------------------------


----------------
-----------------------





</fs:Detail>




</detail>


</soap:Fault>


</soap:Body>

</soap:Envelope>





Connect
Timeout within

Openreach Web Services Gateway


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">


<soap:Body>


<soa
p:Fault>


<faultcode>soap:Server</faultcode>


<faultstring xml:lang="en
-
US">Connect time out</faultstring>

<detail>





<fs:Detail xmlns:fs="http://www.forumsystems.com/2004/04/soap
-
fault
-
detail">






---------------------------------------



---------------------------------------





</fs:Detail>




</detail>


</soap:Fault>


</soap:Body>

</soap:Envelope>



Connectivity issue

between
Openreach Web Services Gateway

and Openreach Portal



<soap:Envelope xmlns:so
ap="http://schemas.xmlsoap.org/soap/envelope/">


<soap:Body>


<soap:Fault>


<faultcode>soap:Server</faultcode>


<faultstring xml:lang="en
-
US">
None of the configured servers can be reached
</faultstring>

<detail>





<fs:Detail xmlns:fs="http:/
/www.forumsystems.com/2004/04/soap
-
fault
-
detail">






---------------------------------------


---------------------------------------





</fs:Detail>




</detail>


</soap:Fault>


</soap:Body>

</soap:Envelope>







N
OTE:
-

All SOAP Faults generated by
Openreach

will have the <faultstring> populated with a description of
the error.








Openreach Web Services Gateway OT FT Web Service Interface Design




Page
19

of
23





7.3

Timeouts


As described in the above sections there are
different kinds of timeouts


1)
TCP connection set
-
up timeout between
C
P and
Openreach Web Services Gateway
.


This should be

configured at the
CP systems
for incoming request to
Openreach Web Services
Gateway
.


2) TCP connection set
-
up timeout between
Openreach Web Services Gateway
and Openreach
Portal

This is configured at
O
penreach Web Services Gateway

with the value 10 seconds. If the TCP
handshake fails to complete within 10 seconds then a time
out error will occur

and
Openreach Web
Services Gateway

will send SOAP Fault with fault
string

“Connect time out” to
CP systems.


3
)
Read time out

between
Openreach Web Services Gateway

and Openreach Portal

If the initial TCP connection has succeeded but no response message is return within 3
0

seconds

(configurable) then a timeout error will occur at
Openreach Web Services Gateway
.
Op
enreach Web
Services Gateway

will send SOAP
-
FAULT with fault string as “Read timeout” to
CP

systems.





However the
CP

Client can terminate the session before this time if they do not wish to tie up their
application connections and threads for up to
30 s
econds.

This will then just throw a timeout
exception locally in the

Client code and close the HTTP

session to
Openreach Web Services Gateway
.

It is important to note that in doing this the transaction may continue to run on the
Openreach stack
.

Openreach Web Services Gateway OT FT Web Service Interface Design




Page
20

of
23





8

Client cha
racteristics

For maximum flexibility clients should be built to be configurable for the following settings:


1.

Time
-
outs

a.

Connection time
-
out (low level TCP timeout for connection)

b.

Response read time
-
out


2.

Number of maximum concurrent connections


Clients shou
ld also be able to control the throughput of traffic they will send to
Openreach Web
Services Gateway
.


It is the client’s responsibility to design their Web Service Client to prevent scenarios leading to
thread starvation. This occurs when a client opens
threads at a rate faster than they are closed
down until all available threads are used up.



It is therefore advisable to implement some form of connection manager on the client side to control
the number of connections with the
Openreach

Web Services

Gat
eway.


Currently there is an upper limit being imposed on the number of requests that can be made by the
CPs. This value is configured at 2 requests per second. So if CPs send request more than this rate
they will get a SOAP
-
FAULT.










Openreach Web Services Gateway OT FT Web Service Interface Design




Page
21

of
23





9

Openreach Web S
ervices Gateway

Deliverables

9.1 Test Document














Openreach Web Services Gateway OT FT Web Service Interface Design




Page
22

of
23





10

References



Ref
No

Title

Version

Author

Date

01

Interface document for exposing
Tracker Functionality

0.
6

Openreach Portal
Team, Virtuasa
corp

30
-
June
-
2009







Openreach Web Services Gateway OT FT Web Service Interface Design




Page
23

of
23





11

Glossary


B2B

Business to business
-

B2B is a term usually reserved for businesses
trading with each other using electronic means

CP

Communications Provider

(
Openreach

Communication Providers)

HTTP

HyperText Transfer Protocol
-

The protocol for moving hypertext
files across
the internet and designed for the World Wide Web (WWW). Provides
packaging of information that can contain instruction headers and other data
about the content. Requires a HTTP client program on one end, and an
HTTP server program on the other

end. HTTP is the most important
protocol used in the WWW
http://www.w3.org/Protocols/rfc2616/rfc2616.html


HTTPS

Secure HTTP
-

The secure version of HTTP (HyperText Transfer Protocol)
usi
ng certificates that can uniquely identify the server and client, and
encrypt all communication between them.

DS

Dialogue Service

21 C

21 Century

OSS

Operational Support System
-

These are the components that a company


湯rm慬ly⁡⁔敬c漬os漠o慲⁡a⁴ 攠
s瑡湤慲搠摥fini瑩潮 杯es


畳敳⁴ ⁲u渠n瑳
湥tw潲o⁡ 搠扵sin敳s⸠⡁.t桯畧栠h琧t w潲攠畳畡l⁴漠oalk⁩渠n敲esf
䍯Cm畮ic慴a潮s⁓敲eic攠er潶i摥rs⁛䍓ms崠]漠o湳畲攠e桡琠睥⁣潮si摥r⁉pmsⰠ
䵖乏s⁡湤⁴桥 lik攬e慳 well 慳⁴牡摩瑩潮al⁔敬c潳F⸠.ypic慬⁴yp敳

慣瑩viti敳
that would count as part of OSS are taking a customer’s order, configuring
湥tw潲o⁣om灯湥湴nⰠIr敡瑩湧⁡ 扩ll 慮d慮慧in朠g慵lts.

plAm

pim灬攠佢e散琠tcc敳s⁐rot潣潬
h瑴t㨯L睷w.眳⹯rg⽔刯o潡瀯


ppi

p散畲攠p潣k整e䱡y敲e
-

A 灲潴oc潬⁤ si杮e搠dy⁎整eca灥⁃潭m畮ic慴ao湳⁴
敮慢l攠敮cryp瑥tⰠIu瑨t湴nc慴a搠d潭m畮ic慴a潮s 慣r潳s⁴ 攠en瑥牮整⸠.p䰠
畳敤潳瑬y
扵t t⁥ cl畳iv敬yF⁩n⁣潭m畮ic慴a潮s⁢整w敥渠we戠brows敲e
慮搠睥戠s敲v敲e⸠啒䰧.⁴桡琠t敧i渠睩th

❨瑴灳✠'n摩c慴攠e桡琠t渠npi
c潮湥c瑩潮 睩ll⁢攠ese搮dpp䰠irovid敳⁴ re攠em灯r瑡t琠t桩n杳㬠;riv慣yⰠ
慵瑨敮tic慴a潮Ⱐ慮搠d敳s慧攠en瑥trity.⁉ 慮 pp䰠䍯湮散瑩潮⁥ c栠hi摥 潦
瑨t⁣潮湥c瑩潮畳琠t慶攠e⁳散畲楴y⁣敲eific慴aⰠ睨wch⁥慣栠hi摥❳⁳潦tw慲攠
s敮摳
瑯tt桥 潴o敲⸠b慣h⁳i摥⁴ 敮 敮cryp瑳 w桡t⁩琠te湤s⁵ in朠g湦潲m慴a潮
from⁢ 瑨ti瑳睮⁡n搠dh攠e瑨tr⁳id攧e⁣敲瑩fic慴aⰠ敮s畲i湧 瑨tt ly 瑨t
i湴n湤e搠牥di灩e湴nc慮⁤
-
cry灴pi琬⁡湤⁴桡琠瑨t 潴o敲⁳i摥⁣慮 扥⁳畲u⁴ e
摡瑡tc慭攠erom⁴ 攠el慣e⁴桡琠i琠tl
aims⁴ ⁨ v攠e潭攠er潭ⰠI湤⁴ 慴at桥
mess慧攠e慳潴ob敥渠瑡t灥r敤 睩t栮



te戠b敲eice

tp䑌

te戠b敲eic敳⁄敦i湩tio渠na湧畡来
桴h瀺⼯睷w.眳⹯r术q刯os摬


u䵌

bu瑥tsi扬e

䵡rk異⁌ 湧ua来
-

A⁵ iv敲e慬⁦潲o慴a瑨tt
畳敳整e⁴ 杳
c潮瑥tt⁦潲⁰o敳敮瑡tio渠nn 瑨t t敢⸠啮.ik攠䡔䵌ⰠIM䰠inly 畳敳⁴ 攠ea杳
瑯⁤t
-
limi琠ti散敳 ⁤ 瑡t⁳漠o桡琠瑨攠e湴nr灲整慴a潮 is敦琠瑯⁴ 攠慰灬ic慴a潮
瑨t琠牥慤s⁩t
-

桴h瀺pL睷眮眳⹯r术g䵌L



KBD Message