B2b web Service Guidelines V2 rsvz enterprise Architecture

Java code:
public enum GenderType {

MALE("male"),

FEMALE("female");

}
public class Person {

protected String name;

protected GenderType gender;

public String getName() {

return name;

}
public void SetName(String value) {

this.name = value;

}
public GenderType getGender() {

return gender;

}

public void SetGender(GenderType value) {

}

}

male = 0,

female = 1

}
public partial class Person {

private string NameField;

private GenderType GenderField;

public string Name {

get { return this.NameField; }

set { this.NameField = value; }

}

public GenderType Gender {

set { this.GenderField = value; }

}

1. Code and Description

   1. Guideline

1. 
   A code element SHOULD NOT be accompagnied by a textual description of the code when the value-set is stable or common knowledge.
   
2. 
   For codes that are not accompanied by a textual description, the XSD or the interface documentation SHOULD include a textual description of each item in the value-set or a reference to it.
   

2. Explanation

1. URI References

   1. Guideline

1. 
   The case of a URI MUST exactly match the actual location and filename of a referenced document.
   
2. 
   To refer to other documents in the same tree, you MUST use relative path references.
   
3. 
   The slash "/" character MUST be used to separate hierarchical components.
   

2. Explanation

13. WSDL Style and Use

    1. Guideline

1. 
   Each part definition MUST reference a global element declaration defined, imported, or included in the types section of the WSDL document.
   
2. 
   In the binding definition, the soap:binding MUST specify (this is the default value), and the soap:body definitions MUST specify use="literal".
   
3. 
   Input and output messages (if present) MUST contain exactly one part.
   
4. 
   The element definitions are "wrapper" elements; the input and output parameters are defined as element structures within these wrapper elements.
   
5. 
   A wrapper element MUST be defined as a complex type that is a sequence of elements (with no attributes).
   
6. 
   The name of the input wrapper element MUST be the same as the operation name.
   

The Web Services stack in Windows Communication Foundation (WCF) imposes the following additional requirements:

1. 
   Message part for input or output parameters MUST always be named "parameters".
   
2. 
   For headers, the message part MUST have “header” as name.
   
3. 
   For faults, the message part MUST be named “detail”.
   
4. 
   The name of the response wrapper element MUST be the same as the operation name with suffix “Response”.
   
5. 
   The elements representing input or output parameters which are mapped to “object types” must be nillable.
   

The JAX-WS 2.0 specification (JSR-000224) adds the following criteria:

1. 
   The wrapper elements MUST NOT contain other structures such as wildcards (element or attribute), xsd:choice, substitution groups (element references are not permitted) or attributes; furthermore, they MUST NOT be nillable.
   
2. 
   Wrapper child elements with the same local name MUST also have the same type.
   

The JAX-WS 2.0 specification and WCF specify difference criteria with regards to the nillability of parameters. Therefore, the only valid approach here is to compare the results on both.

More information is available here.

2. Explanation

• 
  Document style
  

Indicates that the SOAP body simply contains an XML document. The sender and receiver must agree on the format of the document ahead of time.

• 
  RPC style
  

Specifies that the SOAP body contains an element with the name of the Web method being invoked. This element in turn contains an entry for each parameter and the return value of this method.

• 
  Encoding
  

Each message part references an abstract type using the type attribute.

• 
  Literal
  

If the use is Literal, each part references a concrete schema definition using either the element or type attribute; in other words, data is serialized according to a given schema. In practice, this schema is usually expressed using W3C XML Schema.

14. Unique Identifiers

    1. Guideline

1. 
   The application that creates the identifier MUST ensure the value is unique within its application.
   
2. 
   A unique identifier MUST be combined with the identity of the originator to obtain an identifier that is unique across all partners.
   

2. Explanation