Web Services Standards - Florida's Department of Financial Services

yazooalbumΑσφάλεια

3 Νοε 2013 (πριν από 3 χρόνια και 9 μήνες)

61 εμφανίσεις



Standard: Web Services


Page
1

of
5






STANDARD


Web Services



Contents


1.

Introduction

2

1.1

Purpose

................................
................................
................................
................................
.....................

2

1.2

Scope

................................
................................
................................
................................
.........................

2

1.3

Definitions, Acronyms, and Abbreviations

................................
................................
................................

2

1.4

References

................................
................................
................................
................................
.................

3

2.

What is a Web Service

3

2.1

Windows Communication Foundation (WCF) is the Standard for .net 4.0 Web Services

........................

3

3.

When To
Develop a Web Service

4

3.1


Guidelines for Requesting approval to Develop a Web Service

................................
................................

4

3.2

Guidelines for Web

Service Development

................................
................................
................................

4

4.

When To Consume a Web Service

5

4.1

Guideli
nes for Requesting approval to Consume a Web Service

................................
..............................

5






Standard: Web Services


Page
2

of
5


Introduction

Web Services have been a part of the Microsoft development strategy since the early days of .net. The
web service technologies and frameworks that Microsoft has promoted have continued to change and
evolve since the .net 1.0 framework. With the Microsoft .
net 4.0 framework now in place (and used at
DFS via Visual Studio 2010), there is a need to define guidelines and standards for the development (and
consumption) of web services within the DFS application
-

service environment.

Purpose

This document provi
des standards and best practices for the Department of Financial Services
development (and consumption) of Web Services.

Scope

Applies to all DFS Web Services projects including those assigned to contracted vendors, the Offices of
Insurance Regulation and

Financial Regulation in cases where the Web Services require support from DFS
infrastructure, (i.e., software, hardware, network, applications or similar).

The development of ALL DFS Web Services are subject to the same ISDM procedures, processes,
guidel
ines, and deliverables as those of business application and system development projects.

Definitions,
Acronyms
, and Abbreviations

Term

Definition

Web Service

An independent, self
-
versioned, interoperable, machine
-
to
-
machine service
exposed via HTTP/HTTPS;

typically consumed by more than one business
application. For the purpose of this document, a web service can also be defined
as a business application that provides one or more services that are available for
use by all DFS business areas.

WCF

Windows
Communication Foundation (WCF) is Microsoft’s unified programming
model for building service
-
oriented applications. It enables developers to build
secure, reliable, transacted solutions that integrate across platforms and
interoperate with existing investm
ents.

Service

A program or process that exposes one or more endpoints, with each endpoint
exposing one or more operations.

Endpoint

Consists of an address, a binding, and a contract used for communicating with a
WCF service.

Service Operation

A service
operation is a procedure defined in a service's code that implements
the functionality for an operation. This operation is exposed to clients as
methods on a WCF client.

MSDN

Microsoft Developer Network


Resource Library.



Standard: Web Services


Page
3

of
5


ISDM


Information System
Development Methodology

-

A
methodology that utilizes
repeatable
Information System Development processes to

build cost efficient and
reliable applications.

References

Reference

Description

MSDN WCF Introduction

http://msdn.microsoft.com/library/ee958158.aspx

MSDN WCF Glossary

http://msdn.microsoft.com/en
-
us/library/dd456781.aspx

Wh
at

is a Web Service

In the most general terms, a web service is defined as a software system that is designed to support
machine
-
to
-
machine interaction over a network. More specifically, web services are software systems
that provide data and services to o
ther applications. Web services use standard Internet transport
protocols such as Hypertext Transfer Protocol (HTTP) and standard XML
-
based document formats such
as Simple Object Access Protocol (SOAP) to exchange information.

Windows Communication
Foundation (WCF) is the Standard for .net
4.0 Web Services

Windows Communication Foundation (WCF) is a unified framework for creating secure, reliable,
transacted, and interoperable distributed applications. In earlier versions of Visual Studio, there wer
e
several technologies that could be used for communicating between applications.

If you wanted to share information in a way that enabled it to be accessed from any platform, you would
use a Web service (also known as an ASMX Web service). If you wanted
to just move data between a
client and server that was running on the Windows operating system, you would use .NET Remoting. If
you wanted transacted communications, you would use Enterprise Services (DCOM), or if you wanted a
queued model you
would use Me
ssage Queuing (
known as MSMQ).

WCF brings together the functionality of all those technologies under a unified programming model. The
WCF Programming model is based on communication between two entities: a WCF service and a WCF
client. The programming mod
el is encapsulated in the
System.ServiceModel

namespace in the .NET
Framework.

A WCF service is based on an interface that defines a contract between the service and the clien
t. It is
marked with a
ServiceContractAttribute

attribute, as shown in the following code:


C#



Standard: Web Services


Page
4

of
5


[ServiceContract]

public

interface

IService1


C#

[
OperationContract]

string

GetData(
string

value);

WCF

is a framework for building service
-
oriented applications. Using WCF, you can send data as
asynchronous messages from one service endpoint to another. A service endpoint can be part of a
continuously ava
ilable service hosted by IIS, or it can be a service hosted in an application.

WCF Visual Studio templates provide a basic class structure for service development. Several WCF
templates are available in the
Add New Project

dialog box. These include WCF Se
rvice Library projects,
WCF Service Web Sites, and WCF Service Item templates.

When to Develop a Web Service

Guidelines

for Requesting Approval to Develop a Web Service

Development of DFS Web Services must adhere to the same ISDM processes, procedures, and

guidelines
as all application development efforts.

Guidelines for Developing Web Services



Web Services should not be developed when a native API is available.



Web Services should not be developed for presenting large amounts of data.



Web Services should
not be developed to perform database searches.



Web Services should not be developed when there is only one receiving source (system) and
other methods are available to retrieve the data.



Web Services could be developed when delivery of a common information

resource (or service)
is needed by multiple systems.



Web Services could be developed when delivery of a common information resource (or service)
is needed across multiple platforms.



Web Services could be developed when delivery of a common information res
ource (or service)
is needed across multiple organizations.



DFS Web Services should be delivered using Secure Socket Layer (SSL).



DFS Web Services should be restricted by IP address when appropriate.



DFS Web Services used internally should authenticate aga
inst Active Directory.



Standard: Web Services


Page
5

of
5




DFS Web Services used externally should authenticate against a standard security token.

When To Consume a Web Service

Guidelines for Requesting approval to Consume a Web Service



Research available DFS Web Services, including the web
service description, availability, and
owner
. <Placeholder for link to available Web Service information in the Configuration
Management Tracking (CMTR) system>



Ensure that the functionality, usability, reliability, performance, and security requirements o
f the
consuming application can be met by the requested web service.



Contact the owner of the web service and submit appropriate Remedy requests if further
guidance and consultation is needed about the requested web service.