Author: jonathan Date: Fri Aug 8 07:56:25 2008 New Revision: 20620 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=20620
Log: Formatting Modified: branches/mashup/java/1.5/java/readme.txt branches/mashup/java/1.5/java/release_note.txt Modified: branches/mashup/java/1.5/java/readme.txt URL: http://wso2.org/svn/browse/wso2/branches/mashup/java/1.5/java/readme.txt?rev=20620&r1=20619&r2=20620&view=diff ============================================================================== --- branches/mashup/java/1.5/java/readme.txt (original) +++ branches/mashup/java/1.5/java/readme.txt Fri Aug 8 07:56:25 2008 @@ -3,14 +3,22 @@ Starting the Mashup Server ========================= -If you installed WSO2 Mashup Server using the Windows installer, you can check the server status using the System Tray monitor icon. The right click menu of the System Tray monitor will allow you to start/stop the server, while informing you of various events and errors, which require your attention. +If you installed WSO2 Mashup Server using the Windows installer, you can +check the server status using the System Tray monitor icon. The right +click menu of the System Tray monitor will allow you to start/stop the +server, while informing you of various events and errors, which require +your attention. If you downloaded the zip distribution; -Extract the [EMAIL PROTECTED]@.zip to a directory of your choice. You need to have jdk version 1.5 or above installed and make sure that the JAVA_HOME environmental variable point to that. +Extract the [EMAIL PROTECTED]@.zip to a directory of your +choice. You need to have jdk version 1.5 or above installed and make +sure that the JAVA_HOME environmental variable point to that. + +In Linux run the bin/wso2mashup.sh with a --start option. You can use +the --run option instead for console mode or --debug [port] for debug mode. -In Linux run the bin/wso2mashup.sh with a --start option. You can use the --run option instead for console mode or --debug [port] for debug mode. In Windows, run the bin/startup.bat. Logs can be found in the logs folder. @@ -20,38 +28,62 @@ ========================= 1. Copy your javascript service file (extension .js) to the MASHUP_SERVER/scripts/<user> folder. - eg: If you are logging in as the admin MASHUP_SERVER/scripts/admin/myservice.js + eg: If you are logging in as the admin MASHUP_SERVER/scripts/admin/myservice.js 2. You can use the property annotations to perform the basic configurations of the service. 3. You can add a custom UI to your service by creating a "www" folder inside the -{service_filename}.resources folder. {service_filename}.resources/www/index.html will be the UI for the service. - eg: MASHUP_SERVER/scripts/<user>/myservice.resources/www/index.html - MASHUP_SERVER/scripts/<user>/myservice.resources/www/images/logo.gif - -The primary user for the mashup server should be created on first run. This can be done by accessing the web console locally using your browser and entering a user id and password in the displayed page. + {service_filename}.resources folder. {service_filename}.resources/www/index.html + will be the UI for the service. + eg: MASHUP_SERVER/scripts/<user>/myservice.resources/www/index.html + MASHUP_SERVER/scripts/<user>/myservice.resources/www/images/logo.gif + +The primary user for the mashup server should be created on first run. This +can be done by accessing the web console locally using your browser and +entering a user id and password in the displayed page. + +If a browser is not available on the local system, set the 'CreatePrimary' +config parameter to 'true' in the 'PrimaryUserConfig' section of the +server.xml file, specifying your preferred Primary User ID and password. -If a browser is not available on the local system, set the 'CreatePrimary' config parameter to 'true' in the 'PrimaryUserConfig' section of the server.xml file, specifying your preferred Primary User ID and password. Building the Distribution from source ===================================== + mvn clean install The distribution will get created at the modules/distribution/target directory. -If you build with the -Dbuild-setup property it would also create a setup.exe in the target directory. -You need Nullsoft Scriptable Install System (NSIS) installed on your system to do this. It can be downloaded from http://nsis.sourceforge.net. +If you build with the -Dbuild-setup property it would also create a setup.exe +in the target directory. You need Nullsoft Scriptable Install System (NSIS) +installed on your system to do this. It can be downloaded from +http://nsis.sourceforge.net. + Enabling self registration ========================== -1. In the lib\tomcat\webapps\ROOT\WEB-INF\web.xml file, add a valid relay host and change the web application URL provided to match your deployment. - eg: Set email_relay_host as relay.wso2.com and webapp_url as https://www.wso2.com:8080/ -2. Login as the administrator and click the 'Allow Internet Guests' link in the tasks list of the profile page. + +1. In the lib\tomcat\webapps\ROOT\WEB-INF\web.xml file, add a valid relay host + and change the web application URL provided to match your deployment. + eg: Set email_relay_host as relay.wso2.com and webapp_url as + https://www.wso2.com:8080/ +2. Login as the administrator and click the 'Allow Internet Guests' link in + the tasks list of the profile page. + Windows Installer ================= -1. The windows installer will register the mashup server as a windows service and also add a system tray icon to monitor and control server status. -2. The System Tray Icon does not auto-start on Windows Vista. Start the 'System Tray Monitor' manually, using the 'Run as Administrator' option, from the Windows 'Start' menu. + +1. The windows installer will register the mashup server as a windows service + and also add a system tray icon to monitor and control server status. + +2. The System Tray Icon does not auto-start on Windows Vista. Start the + 'System Tray Monitor' manually, using the 'Run as Administrator' option, + from the Windows 'Start' menu. + Documentation ============= -Please refer to the Mashup Server's project page at http://wso2.org/projects/mashup for updated documentation. + +Please refer to the Mashup Server's project page at http://wso2.org/projects/mashup +for updated documentation. + Modified: branches/mashup/java/1.5/java/release_note.txt URL: http://wso2.org/svn/browse/wso2/branches/mashup/java/1.5/java/release_note.txt?rev=20620&r1=20619&r2=20620&view=diff ============================================================================== --- branches/mashup/java/1.5/java/release_note.txt (original) +++ branches/mashup/java/1.5/java/release_note.txt Fri Aug 8 07:56:25 2008 @@ -1,16 +1,19 @@ WSO2 Mashup Server 1.5.1 - Release Note - 8th August 2008 ====================================================================== -"Create, deploy, and consume Web services Mashups in the simplest fashion" + +"Create, deploy, and consume Web services Mashups in the simplest fashion." The WSO2 Mashup Server is a powerful yet simple and quick way to tailor Web-based information to the personal needs of individuals and organizations. It is a platform for acquiring data from a variety of sources including Web -Services, HTML pages, feeds and data sources, and process and combine it with -other data using JavaScript with E4X XML extensions. The result is then exposed -as a new Web service with rich metadata and artifacts to simplify the creation +Services, HTML pages, feeds and data sources, and process and combine it +with +other data using JavaScript with E4X XML extensions. The result is then +exposed as a new Web service with rich metadata and artifacts to simplify +the creation of rich user interfaces. -The WSO2 Mashup Server will form the backbone of a become an ecosystem of +The WSO2 Mashup Server forms the backbone of an ecosystem of community-developed services that will broaden the palette of capabilities for mashups and distributed applications. @@ -22,11 +25,13 @@ -------------------------- Features List ========================== + * Hosting of mashup services written using JavaScript with E4X XML extension - Simple file based deployment model * JavaScript annotations to configure the deployed services * Auto generation of metadata and runtime resources for the deployed mashups - JavaScript stubs that simplify client access to the mashup service + - Code templates for developing rich HTML or Google Gadget interfaces - TryIt functionality to invoke the mashup service through a web browser - WSDL 1.1/WSDL 2.0/XSD documents to describe the mashup service - API documentation @@ -39,94 +44,124 @@ - Scraper: Extract data from HTML pages and present in XML format - APPClient: Atom Publishing Protocol client to retrieve/publish Atom feeds with APP servers - - Feed: A generic set of host objects to transparently read and create Atom - and RSS feeds + - Feed: A generic set of host objects to transparently read and create + Atom and RSS feeds - Request: Ability get information regarding a request received * Support for recurring and longer-running tasks * Support for service lifecycles -* Ability to secure hosted mashups using a set of commonly used security scenarios +* Ability to secure hosted mashups using a set of commonly used security + scenarios * Management console to easily manage the mashups * Simple sharing of deployed mashups with other WSO2 Mashup Servers * Mashup sharing community portal (http://mooshup.com) to share and host your mashups ---------------------- -New In 1.5 -===================== + +-------------------------- +New in the 1.5 Release +========================== + * Request object -* Ability to secure hosted mashups using a set of commonly used security scenarios +* Ability to secure hosted mashups using a set of commonly used security + scenarios * Ability to call secured services using the WSRequest host object -* Integrated Data Services Support (expose data locked up in DataBases, Excel spreadsheets and -CSV files with ease) +* Integrated Data Services Support (expose data locked up in DataBases, Excel + spreadsheets and CSV files with ease) * OpenID login support -* Apache Shindig powered, Google compatible, per-user Dashboard and browser based editor support -for developing gadgets for hosted mashups (http://wso2.org/library/3813). - ------------------------------------- -Defect Fixes In This Release -==================================== -* E-mail host object fix -* Autogenerated stubs of data services fixed -* Minor usability enhancements -For the full list of defect fixes for this release refer to https://wso2.org/jira/browse/MASHUP/fixforversion/10211 +* Apache Shindig powered, Google compatible, per-user Dashboard and browser + based editor support for developing gadgets for hosted mashups + (http://wso2.org/library/3813). + + +------------------------------------ +Defect Fixes In This Release +==================================== + +* E-mail host object fix +* Autogenerated stubs of data services fixed +* Minor usability enhancements + +For the full list of defect fixes for this release refer to +https://wso2.org/jira/browse/MASHUP/fixforversion/10211 + ------------------------- Known Issues ========================= + * Management Console was tested only on IE 6/7 & Firefox 1.5/2.0/3.0. * Inter-service dependencies using the dynamically generated stubs may give -deployment time errors. Workaround would be to save a local copy of the stub -in to the dependent service. + deployment time errors depending on the order of deployment. Instead save + a copy of the stub locally for the dependent service. * JSON support lacks try-it support -* Mashup editor will convert < and > characters to < and > while saving the code in the -server. This might result in malformed xml. Using these special characters with caution is adviced. -Refer http://wso2.org/jira/browse/MASHUP-607. -* Built-in samples cannot be secured - the built-in "sample" user does not have a keystore associated with it -(system services use the keystore of the primary account.) -* The System Tray Icon does not auto-start when a user logs into Windows Vista. Refer http://wso2.org/jira/browse/MASHUP-1063. -The workaround is starting the 'System Tray Monitor' manually, using the 'Run as Administrator' option from the Windows 'Start' Menu. +* Mashup editor will convert < and > characters to < and > while saving + the code in the server. This might result in malformed xml. Using these + special characters with caution is adviced. Refer to + http://wso2.org/jira/browse/MASHUP-607. +* Built-in samples cannot be secured - the built-in "sample" user does not + have a keystore associated with it (system services use the keystore of the + primary account.) +* The System Tray Icon does not auto-start when a user logs into Windows + Vista. Refer http://wso2.org/jira/browse/MASHUP-1063. + The workaround is + starting the 'System Tray Monitor' manually, using the 'Run as Administrator' + option from the Windows 'Start' Menu. + --------------------------------- Future Directions ================================= + * Improved tooling support. -* An expanded toolkit of generic building-block services. -* Deep registry integration including governance, rollback, dependency analysis, etc. +* An expanded toolkit of generic building-block services. + +* Deep registry integration including governance, rollback, dependency + analysis, etc. * Lots more cool stuff. + ------------------------ Reporting Problems ======================== + Issues can be reported using the public JIRA available at https://wso2.org/jira/browse/MASHUP + ------------------------ Contact us ======================== + WSO2 Mashup Server developers can be contacted via mailing lists: For Users: [EMAIL PROTECTED] For Developers: [email protected] For details on subscriptions: http://www.wso2.org/projects/mashup#mail -Questions can also be raised in this forum: http://www.wso2.org/forum/226 +Questions can also be raised in this forum: http://www.wso2.org/forum/226. + ------------------------ Training ======================== + WSO2 Inc. offers a variety of professional Training Programs, including training on general Web services as well as WSO2 Mashup Server, WSO2 WSAS, WSO2 ESB, Apache Axis2, Data Services and a number of other products. -For additional support information please refer to http://wso2.com/training/course-catalog/ +For additional support information please refer to +http://wso2.com/training/course-catalog/. ------------------------ Support ======================== + WSO2 Inc. offers a variety of development and production support programs, ranging from Web-based support up through normal business hours, to premium 24x7 phone support. For additional support information -please refer to http://wso2.com/support/ +please refer to http://wso2.com/support/. Enjoy the Mashup Server! - WSO2 Mashup Server Team + + _______________________________________________ Mashup-dev mailing list [email protected] http://mailman.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
