From be86fdeee619a32d138212813ec8d77b8fee3611 Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Tue, 28 Sep 2010 23:12:11 -0400 Subject: [PATCH] INT-1477 added readme files and description in each category as well as the root folder --- advanced/readme.txt | 13 +++++++++++ applications/readme.txt | 9 ++++++++ basic/readme.txt | 10 +++++++++ intermediate/readme.txt | 11 +++++++++ readme.txt | 49 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 92 insertions(+) create mode 100644 readme.txt diff --git a/advanced/readme.txt b/advanced/readme.txt index e69de29b..b8a98c94 100644 --- a/advanced/readme.txt +++ b/advanced/readme.txt @@ -0,0 +1,13 @@ + + $$ ADVANCED Samples $$ + +This category targets advanced develoopers who are well familiar with Spring Integration framework but looking to +extend it to address a specific custom need by extending from Spring Integration public API. +For example; if you are looking for samples showing you how to implement a custom Channel or +Consumer (event-based or polling-based), or you trying to figure out what is the most appropriate way to implement +custom BeanParser on top of Spring IntegrationÊBeanParserÊhierarchy when implementing custom name space, +this would be the right place to look. +Here you can also find samples that will help you with adapter development. Spring Integration comes with an extensive +library of adapters that allow you to connect remote systems with Spring Integration messaging framework. +However you might have a need to integrate with system for which the core framework does not provide an adapter. +So you have to implement your own. This category would include samples showing you how to implement various adapters. diff --git a/applications/readme.txt b/applications/readme.txt index e69de29b..b38e22fd 100644 --- a/applications/readme.txt +++ b/applications/readme.txt @@ -0,0 +1,9 @@ + + $$ APPLICATIONS Samples $$ + +This category targets developers and architects who have a good understanding of the Messaging architecture, +EIP and above average understanding of Spring and Spring integration and are looking for samples that +address a particular business problem. In other word the emphasis of samples in this category is 'business use cases' +and how it could be solved via Messaging architecture and Spring Integration in particular. +For example; If you are interested to see how a Loan Broker process or Travel Agent process could be implemented and +automated via Spring Integration this would be the right place to find these types of samples. diff --git a/basic/readme.txt b/basic/readme.txt index e69de29b..11fcadff 100644 --- a/basic/readme.txt +++ b/basic/readme.txt @@ -0,0 +1,10 @@ + + $$ BASIC Samples $$ + +This is a good place to get started. The samples here are technically motivated and demonstrate +the bare minimum with regard to configuration and code to help you to get introduced to the basic +concepts, API and configuration of Spring Integration and how they relate to Enterprise Integration Patterns (EIP). + +For example; if your are looking for an answer on how to wire service-activator to a channel or how to +apply Gateway to your message exchange or how to get started with using MAIL or XML module etc., +this would be the right place to find a good sample. This category of samples is this is a good place to start. \ No newline at end of file diff --git a/intermediate/readme.txt b/intermediate/readme.txt index e69de29b..ae886d27 100644 --- a/intermediate/readme.txt +++ b/intermediate/readme.txt @@ -0,0 +1,11 @@ + + $$ INTERMEDIATE Samples $$ + +This category targets developers who are already familiar with Spring Integration framework (past getting started), +but need some more guidance while resolving Êmore advanced technical problems that you have to deal with +once switch to a Messaging architecture. +For example; If you are looking for an answer on how to handle errors in various +scenarios or how to properly configure Aggregator for the situations where some messages might not ever arrive +for aggregation etc,. and any other issue that goes beyond a basic understanding and configuration of a +particular component and addresses "what else you can do with it" type of problem this would be the right place +to find these type of samples. diff --git a/readme.txt b/readme.txt new file mode 100644 index 00000000..af8a19a4 --- /dev/null +++ b/readme.txt @@ -0,0 +1,49 @@ + =============================================================== + $$$ Welcome to Spring Integration Samples $$$ + =============================================================== + +To simplify your experience, Spring Integration Samples were split in 4 distinct categories. +Inside of each category you'll find 'readme.txt' which will contain a more detailed description +of that category specifics. Each sample also comes with its own 'readme.txt' file explaining details. + +Below is a short description of each category. + +BASIC + This is a good place to get started. The samples here are technically motivated and demonstrate the bare + minimum with regard to configuration and code to help you to get introduced to the basic concepts, API and + configuration of Spring Integration. For example if your are looking for an answer on how to wire service-activator + to a channel or how to apply Gateway to your message exchange or how to get started with using MAIL or XML module etc., + this would be the right place to find a good sample. The bottom line is this is a good place to get started. + +INTERMEDIATE + This category targets developers who are already familiar with Spring Integration framework (past getting started), + but need some more guidance while resolving Êmore advanced technical problems that you have to deal with + once switch to a Messaging architecture. + For example; If you are looking for an answer on how to handle errors in various + scenarios or how to properly configure Aggregator for the situations where some messages might not ever arrive + for aggregation etc,. and any other issue that goes beyond a basic understanding and configuration of a + particular component and addresses "what else you can do with it" type of problem this would be the right place + to find these type of samples. + +ADVANCED + This category targets advanced develoopers who are well familiar with Spring Integration framework but looking to + extend it to address a specific custom need by extending from Spring Integration public API. + For example; if you are looking for samples showing you how to implement a custom Channel or + Consumer (event-based or polling-based), or you trying to figure out what is the most appropriate way to implement + custom BeanParser on top of Spring IntegrationÊBeanParserÊhierarchy when implementing custom name space, + this would be the right place to look. + Here you can also find samples that will help you with adapter development. Spring Integration comes with an extensive + library of adapters that allow you to connect remote systems with Spring Integration messaging framework. + However you might have a need to integrate with system for which the core framework does not provide an adapter. + So you have to implement your own. This category would include samples showing you how to implement various adapters. + +APPLICATIONS + This category targets developers and architects who have a good understanding of the Messaging architecture, + EIP and above average understanding of Spring and Spring integration and are looking for samples that + address a particular business problem. In other word the emphasis of samples in this category is 'business use cases' + and how it could be solved via Messaging architecture and Spring Integration in particular. + For example; If you are interested to see how a Loan Broker process or Travel Agent process could be implemented and + automated via Spring Integration this would be the right place to find these types of samples. + + $$ Happy Integration! $$ +