May 27, 2012
Working with clients who are consuming your services? Here is a mini-checklist of questions to ask:
- While executing request/reply on the service interface is there a timeout value set on the call?
- Is there code/logic to handle SOAP Faults /system exceptions when invoking the service?
- Is building service header separated from the payload? This will facilitate reuse across services that share common header parameters
- If there are certain error codes that the calling code can handle, is there logic for each of them?
- Is the physical end point information (URL string for HTTP, Queue connection and name for MQ/EMS) stored in an external configuration file?
- Is UTF-8 encoding used while sending XML requests to the service i.e. by making use of platform-specific UTF encoding objects?
- If using form-encoding are unsafe characters such as ‘&’, ‘+’, ‘@’ escaped using appropriate %xx (hexadecimal) values?
- While processing the service response is the logic for parsing/processing SOAP and service-specific headers decoupled from processing the business data elements?
- Is the entire request/reply operation – invocation and response handling logic – encapsulated into its own class or method call?
- While performing testing, is the appropriate testing environment URL/queue manager being used?
- Is a valid correlation id being used in the service request? This is very essential for aynchronous request/reply over JMS (JMS Header) or HTTP (callback handler)
Like this:
Like Loading...
Leave a Comment » |
General, SOA | Tagged: checklist, messaging, service orientation architecture, services, SOA, systematic reuse, web services |
Permalink
Posted by vijaynarayanan
April 17, 2010

Download Checklist
Here is a checklist for ensuring that your service capabilities are unit tested effectively. These questions can come in handy when validating test coverage or when doing code reviews with fellow team members. I have used this checklist extensively in all my SOA development efforts and has helped with improving the quality of the services. The check list covers:
- functional testing
- error handling
- data validation/formatting
- performance testing
- data binding/transport interfaces
Feel free to add/customize this checklist based on your team’s unique needs. I hope you find this resource useful!
Like this:
Like Loading...
Leave a Comment » |
Reuse | Tagged: agile, checklist, refactoring, Reuse, service capability, services, SOA, testing |
Permalink
Posted by vijaynarayanan
November 9, 2009

Download Checklist
Here is a checklist for performing design reviews when building service capabilities that are part of Service Oriented Architecture (SOA) initiatives. I have found this checklist to be very useful and can serve as a key document as part of the service development lifecyle. This checklist contains close to 50 questions and covers the following areas:
- Functionality
- Design decomposition
- Documentation
- Coupling
- Reuse
- Consistency
- Integration
- Performance
- Reliability
- Deployment
Feel free to customize this checklist based on your needs.
Like this post? Subscribe to RSS feed or get blog updates via email.

Like this:
Like Loading...
2 Comments |
Design, Reuse, SOA | Tagged: checklist, coupling, defect prevention, Design, design review, document, service capabilities, SOA |
Permalink
Posted by vijaynarayanan