System and method for developing, deploying, managing and monitoring a web application in a single environment

[0001] Not Applicable

[0002] Not Applicable

[0003] 1. Field of the Invention

[0004] The present invention relates to cloud computing. More specifically, the present invention relates to a system and method for developing, deploying, managing and monitoring a Web application in a single environment.

[0005] 2. Description of the Related Art

[0006] In general terms, cloud computing provides a developer (individual or company) to have access to resources for a Web application, in particular a web site. Various vendors provide cloud computing to the developer community. Such vendors include JOYENT (see joyent.com), Amazon Web Services (See amazon.com), Google App Engine (see http://code.google.com/appengine/) and others.

[0007] General definitions for terms utilized in the pertinent art are set forth below.

[0008] Applets or Java Applets are mini-executable programs named with the .class suffix and are placed on the web page and provide interactive and multimedia uses.

[0009] Application Programming Interface (API) is a collection of computer software code, usually a set of class definitions, that can perform a set of related complex tasks, but has a limited set of controls that may be manipulated by other software-code entities. The set of controls is deliberately limited for the sake of clarity and ease of use, so that programmers do not have to work with the detail contained within the given API itself.

[0010] Asynchronous Server-Side Processing is a means for avoiding having to reload a new page for every request sent by a client and involves placing a intermediary between a client and server in order to send a request to the intermediary (i.e. XMLHttpRequest object) which sends it to the server for processing and receives the response from the server for passing on to the client.

[0011] Boot or Bootstrap refers to loading the first piece of software that starts a computer since the operating system is essential for running all other programs, it is usually the first piece of software loaded during the boot process.

[0012] A Channel is information about organized content on an intranet or the Internet. Channels enable Web developers to categorize and describe Web site content and make that data available to users on demand.

[0013] Cloud computing is generally defined as using computing resources, primarily servers, owned by a third party provider (such as the AMAZON ELASTIC COMPUTE CLOUD, JOYENT, and GOOGLE APPS) such that the user does not need to make a substantial investment in computer hardware and scale resources depending on the user's needs. Cloud computing primarily involves Web applications but can include storage, raw computing and other specialized services.

[0014] FTP or File Transfer Protocol is a protocol for moving files over the Internet from one computer to another.

[0015] HyperText Markup Language (HTML) is a method of mixing text and other content with layout and appearance commands in a file, so that a browser can generate a display from the file.

[0016] Hypertext Transfer Protocol (HTTP) is a set of conventions for controlling the transfer of information via the Internet from a Web server computer to a client computer, and also from a client computer to a Web server.

[0017] Internet is the worldwide, decentralized totality of server computers and data-transmission paths which can supply information to a connected client computer, and can receive and forward information entered from the client computer.

[0018] JavaScript is an object-based programming language. JavaScript is an interpreted language, not a compiled language. JavaScript is generally designed for writing software routines that operate within a client computer on the Internet. Generally, the software routines are downloaded to the client computer at the beginning of the interactive session, if they are not already cached on the client computer. JavaScript is discussed in greater detail below.

[0019] JSON is JavaScript Object Notation format, which is a way of taking data and turning it into valid a representation of program information that can be read by another program.

[0020] MySQL is a relational database management system which relies on SQL for processing data in a database.

[0021] Parser is a component of a compiler that analyzes a sequence of tokens to determine its grammatical structure with respect to a given formal grammar. Parsing transforms input text into a data structure, usually a tree, which is suitable for later processing and which captures the implied hierarchy of the input. XML Parsers ensure that an XML document follows the rules of XML markup syntax correctly.

[0022] Platform is the combination of a client computer, an operating system, and a browser, which together can support HTTP access and in particular the operation of interactive forms.

[0023] Portlet is a Web based component that will process requests and generate dynamic content. The end-user essentially sees a portlet as being a specialized content area within a Web page that occupies a small window. One could use this content area (the portlet) to receive different types of information. The portlet provides users with the capability to customize the content, appearance and position of the portlet.

[0024] Provisioning is the act of supplying and configuring computing resources, primarily servers, for a web application.

[0025] Pulling or Pull Technology is technology that enables Web browsers to retrieve information from a Web server such as updating information at periodic intervals, essentially Web browser initiated activity.

[0026] Pushing or Push Technology is technology that initiates delivery of material from a server to a properly configured Web browser, such as providing automatic updates to a Web browser.

[0027] Serialization places an object in a binary form for transmission across a network such as the Internet and deserialization involves extracting a data structure from a series of bytes.

[0028] Servlets are objects that receive requests and generate a response based on that request.

[0029] SQL (Structured Query Language) is a computer language designed for data retrieval and data management in a database.

[0030] Structural layer of a web page is the marked up document and foundation on which other layers may be applied.

[0031] URL or Uniform Resource Locator is a address on the World Wide Web.

[0032] User is a client computer, generally operated by a human being, but in some system contexts running an automated process not under full-time human control.

[0033] User Interface or UI is the junction between a user and a computer program. An interface is a set of commands or menus through which a user communicates with a program. A command driven interface is one in which the user enter commands. A menu-driven interface is one in which the user selects command choices from various menus displayed on the screen.

[0034] Web-Browser is a complex software program, resident in a client computer, that is capable of loading and displaying text and images and exhibiting behaviors as encoded in HTML (HyperText Markup Language) from the Internet, and also from the client computer's memory. Major browsers include MICROSOFT INTERNET EXPLORER, NETSCAPE, APPLE SAFARI, MOZILLA FIREFOX, and OPERA.

[0035] Web-Server is a computer able to simultaneously manage many Internet information-exchange processes at the same time. Normally, server computers are more powerful than client computers, and are administratively and/or geographically centralized. An interactive-form information-collection process generally is controlled from a server computer.

[0036] World Wide Web Consortium (W3C) is an unofficial standards body which creates and oversees the development of web technologies and the application of those technologies.

[0037] XHTML (Extensible Hypertext Markup Language) is a language for describing the content of hypertext documents intended to be viewed or read in a browser.

[0038] XML (Extensible Markup Language) is a W3C standard for text document markup, and it is not a language but a set of rules for creating other markup languages.

[0039] As shown in FIG. 1A, a cloud computing system 20′ of the prior art generally involves a single cloud provider 28′ which is accessed from a user 22′ at a user interface 24′ over a network 40′ such as the Internet. The user 22′ can only work with the single cloud provider 28′ and is provided very little information about the performance of the web application on the cloud provider 28′. Further, in order to scale up, the user 22′ must repeat the uploading process.

[0040] However, current technologies fail to provide a system and method for developing, deploying, managing and monitoring a web application in a single environment.

[0041] The Present Invention overcomes the obstacles of the prior art and provides a method and system for developing, deploying, managing and monitoring a web application in a single environment.

[0042] One aspect of the present invention is a system for developing, deploying, managing and monitoring a web application in a single environment. The system includes an integrated development environment for developing a web application, a network, a primary cloud provider having a primary plurality of web resources, at least one secondary cloud provider having a secondary plurality of web resources, a cloud manager having an application programming interface, and a user interface. The cloud manager remotely manages the web application. The cloud manager is capable of monitoring the web application to determine if a current level of web resources is appropriate for the web application to perform within a predetermined performance range. The cloud manager is capable of accessing and providing the primary plurality of web resources from the primary cloud provider for the web application and the cloud manager is capable of accessing and providing the secondary plurality of web resources from the secondary cloud provider for the web application. The user interface is for an operator to access the integrated development environment and the cloud manager over the network.

[0043] Another aspect of the present invention is a method for developing, deploying, managing and monitoring a web application in a single environment. The method includes developing a web application in a single environment. The method also includes provisioning the web application. The method also includes deploying the web application to a primary cloud provider having a primary plurality of web resources. The method also includes managing the web application within the single environment determine if a current level of web resources is appropriate for the web application to perform within a predetermined performance range. The method also includes accessing and providing the primary plurality of web resources from the primary cloud provider for the web application. The method also includes accessing and providing a secondary plurality of web resources from at least one secondary cloud provider for the web application. The method also includes monitoring the performance of the web application from the single environment.

[0044] Managing the web application preferably comprises temporarily adding web resources from the secondary plurality of web resources during a time period of high demand for the web application. Monitoring the performance of the web application preferably comprises monitoring the load on the web application. Developing the web application at the single environment preferably comprises providing a plurality of libraries, a plurality of plugins, and a URL.

[0045] Monitoring and managing the Web site preferably comprises monitoring the load on the web site and temporarily adding web resources from the secondary plurality of web resources during a time period of high demand for the web site. Developing the web site preferably comprises using client-technology languages and server-side languages. The client-technology languages preferably comprise HTML, CSS and JavaScript, and the server-side languages preferably comprise PHP, Ruby, Python, Java and JavaScript.

[0046] The present invention is a new way to think about “back-office” computing needs. Rather than worrying about where to host a Web site, how to configure a Web server, and how to set up additional services, the present invention enables a user to push all of these concerns and worries to someone else, and more importantly, somewhere else. It's all handled for over the Internet, dynamically and completely managed. In short, all of a user's technology needs on the back-end are handled as a service, much like an electric or a telephone bill.

[0047] The present invention provides scalable PHP, MySQL, APACHE and APTANA JAXER app platforms as a service. Production and staging environments are both provided out of the box. In addition multiple software as service solutions are provided supporting the entirety of a user's application lifecycle: from development to deployment to management and monitoring. To make this the ultimate in ease, these solutions are also integrated directly into the workflows of an IDE. These software services include hosted source control (SVN), team member management, database tools, one-click backups, Web stats and site performance statistics, and an active monitoring and alert system that will notify a user of key events in the system when they happen.

[0048] Full SSH, SFTP, and SVN access to a user's site outside of the IDE is provided. PHP, mySQL, Apache and APTANA JAXER app stacks are all open source app stacks that one can either set up individually, or are supported by other hosting service providers as well.

[0049] The present invention is preferably built to compliment computing utilities. The present invention not only preferably provides on-demand scalability from such computing utilities, it also provides pre-configured app stacks ready to run apps, management tools integrated right into the IDE, and access to hosted source control and staging servers that help a user work more efficiently with others.

[0050] With the present invention, the inefficiencies of working with VPS and traditional hosts are a thing of the past. Instead of mere FTP or SSH accounts to a server with fixed capacities, the present invention provides on-demand scalability of Cloud computing, plus services like source control, team management and staging that integrate right into the IDE and workflow.

[0051] The present invention works with JOYENT, which serves over one billion page views a month, including some of the largest Facebook apps. Currently there are over 4000 PHP apps running on JOYENT. Each Cloud site created with the present invention has a static IP address.

[0052] Having briefly described the present invention, the above and further objects, features and advantages thereof will be recognized by those skilled in the pertinent art from the following detailed description of the invention when taken in conjunction with the accompanying drawings.

[0065] The present invention provides a novel system and method for a user to develop a Web application such as a Web site, deploy the Web application for access over the Internet, manage and monitor the Web application to ensure adequate resources are provided during times of heavy traffic such as heavy viewing of a Web site.

[0066] As shown in FIG. 1, a system 20 generally includes an IDE 23, a cloud manager 25 having a cloud manager API 26, a primary cloud provider 28, a secondary cloud provider 30a and a second secondary cloud provider 30b. A web application 32 is located at the primary cloud provider 28. The cloud manager 25 communicates over a network 40 (shown by dashed lines) directly with the Web application 32, the primary cloud provider 28, the secondary cloud provider 30a and the second secondary cloud provider 30b. Those skilled in the pertinent art will recognize that the system may only include one cloud provider, or more than three cloud providers. A developer/user 21 operating from a user interface 22 also communicates over the network 40. Preferably, the network is the Internet, however those skilled in the pertinent art will recognize that the network may be an Intranet or like network. The user interface 22 preferably communicates with the cloud manager 26 through the IDE 23. However, as discussed herein, once a Web application 32 is deployed, the user interface 22 preferably communicates directly with the cloud manager 25.

[0067] A user interface 22 (also referred to as UI) is typically a computer which includes a processing means for interacting with various input and output devices (“I/O devices”), and various networks. The I/O Devices can be drives, a keyboard, a display, a scanner, a mouse and the like. The processing means typically includes a CPU such as an INTEL PENTIUM™ processor or the like. The processing means also preferably includes a memory (random access memory and read only memory) and interfaces for communicating with networks and the I/O Devices.

[0068] The IDE 23 provides a user 21 with the tools necessary to build a Web application such as a Web site. One such IDE is set forth at aptana.com, which is hereby incorporated by reference in its entirety. The APTANA IDE is an open-source, cross-platform, JAVA script-focused development environment for preferably building AJAX applications. However, those skilled in the pertinent art will recognize that other IDEs may be utilized without departing from the scope and spirit of the present invention. An IDE 23 is provided to facilitate the development of software applications or other software programs by one or more software developers. The IDE 23 can include one or more servers, work stations, and other components, as well as languages, compliers, editors, and other tools used by developers in the development environment. The IDE 23 is preferably confined to a single geographic location or alternatively can be distributed across a plurality of geographic locations. A geographically diverse configuration would typically include one or more communication channels (networks or otherwise) among the various development locations to allow for a collaborative work environment. The IDE includes a suite of tools to assist in Web application development projects. Various aspects of a preferred IDE 23 are described below.

[0069] The primary cloud provider 28, first secondary cloud provider 30a and second secondary cloud provider 30b, and any other cloud providers, each provide Web resources that may be used for the Web application 32. The Web resources are primarily servers, owned by a third party provider (such as the AMAZON ELASTIC COMPUTE CLOUD, JOYENT, and GOOGLE APPS) such that the user does not need to make a substantial investment in computer hardware and can scale resources depending on the user's needs.

[0070] The cloud manager 25 automatically manages the Web resource needs of the Web application 32. The cloud manager 25 provisions the Web application 32, syncs the Web application 32, and automatically provides scalability for the Web application 32. A more detailed explanation of the cloud manager is provided below.

[0071] FIG. 2 is a block diagram of the software architecture of the present invention. FIG. 2 illustrates the overall architecture residing in and interacting with the IDE 23. The cloud manager 25 loads once the user logs in using his Aptana ID. This ID is persisted between startup, so that the cloud manager 25 may be loaded immediately when the IDE 23 begins, for example the APTANA Studio. The cloud manager 25 first loads from a local data store model 60, if it exists, and then synchronizes the local data store model 60 with a remote site manager model 65. Any model change events will only be fired for differences found between the local data store model 60 and the site manager model 65. The components of the architecture include the IDE, (STUDIO), the MyCloud Web application 32, the MyCloud server, the site manager provider and the site manager. The MyCloud Web application 32 is located inside an embedded browser of the IDE 23. The MyCloud server comprises a JETTY HTTP server 63, servlets for the IDE requests, (e.g., obtaining projects in the local workspace), servlets that delegate to site manager services (e.g., listing the deployed projects and their status), and a COMET client 62 for messaging bus (pumps events from a messaging queue and a local store). The site manager provider performs client implementation of site manager services, polling the site manager for notifications an events (adds events to a messaging queue and a local store), and maintains and synchronizes a user/project model with the site manager. The site manager contains the Web services for deployed projects and account management. In an example of a preferred embodiment, the portal index page is at

com.aptana.ide.serverjetty/content/index.html.

function setup ( )

{

[0072] dojo.require(“dojox.cometd”)

[0073] dojo.connect (dojox.cometd, “finishInit”,

• • [0074] function (type, data, evt, request) {
    • [0075] dojox.cometd.subscribe (
    • [0076] “/portal/portlets/”+dojox.cometd.clientId,
    • [0077] “echoRpcReturn”
    • [0078] }
  • [0079] }

[0080] );

Dojox.cometd.init(“/cometd”);

}

[0081] The flow preferably involves the initial portal index page requesting a list of portlets from /portlal/portlets. The IDE 23 returns a list of configured portlets and URL to request a bootstrap JavaScript code (e.g., /portlets/cloud). The portal index page executes the bootstrap code to alter the model and the user interface as appropriate per portlet. The portlet can continue to request new files and resources from for example /portlets/portlet id/ sub urls (/portlets/cloud/images/cloud_portlet banner.png).

[0082] The MyCloud Servlets involve comet architecture that specifies channels for publishing and subscription. A common model involves a client subscribing to a client-id specific channel, but publishing on a generic channel. For example, a client subscribes to /portal.portlets.a1234564, the client publishes to /portal/portlets, with published implicitly including the client ID. The return messages are routed to the specific channel subscribed to by the user. Alternatively, the return messages are routed to a global “broadcast” channel, such as /projects.

[0083] The portal is preferably an AJAX Web application that operates on top of the internal Jetty server 63 and communicates with the IDE 23 through comet 61. End users access the portal through IDE buttons, and the basics of starting up and debugging are briefly discussed below. In order to ensure that no XHR requests remain unterminated (or waiting to time out) when the portal is closed and then re-opened, the IDE 23 completely terminates the internal JETTY server 63 every time that a user closes the portal view. As such, the portal needs to use a different port every time, starting with 8500 and incrementing by 1 each subsequent time the portal is loaded. Similarly, the cometd server runs on its own port, starting with 8600. For the portal to load properly, the portal should preferably be requested as follows: http://localhost:[port number]/index.html?port=[comet port number]. For debugging the portal, the log output contains every major action logged preferably using FIREBUG. Therefore, a review of the log output should identify the problem.

[0084] URL parameters are used to have the portal load with specific content rather than the default “Home” page. A specific tab is loaded with a query string pram: tab having possible values of ‘my_aptana’ or ‘my_cloud’, for example, http://localhost:8500/index.html?port=8600&tab=my_cloud. To a load a specific site in “My Cloud” query string param: siteId with possible values of any site Id for the logged in user for example http://localhost:8500/index.html?port=8600&tab=my_cloud&siteId=1234.

[0085] To deploy a project to the Cloud, query string param: project. Possible Values are any undeployed project (url encoded, case-sensitive), for example: http://localhost:8500/index.html?port=8600&project=MyCoolProject.

[0086] To start at a specific product in “My Aptana”, query string param: product. Possible Values are studio, plugins, jaxer and cloud. For example: http://localhost:8500/index.html?port=8600&product=plugins.

[0087] The servlet listing returns JSON data. Preferably, JSON data will be parsed, not evaluated. Model API directly on cloud manager, or have channels like /project/create?.

[0088] Studio-centric requests involve license information, preferences and projects (date/time last updated).

[0089] FIG. 2A provides an in-depth illustration of the cloud manager 25. The cloud manager 25, which is inside the IDE 23, synchronizes with the remote site manager model 65 for a given user and sends updates to the site manager model 65. The cloud manager 25 synchronizes directly against Web applications 32 via model information return in the site manager model 65. This is used for the Web application statistics model 66 which is shown graphically to the user. The cloud manager 25 synchronizes with cloud site model 28a. A core model object 70 is configured for model elements to synchronize against a remote model representation. Core model object 70 and core group object 71 does all of the following: fire events 74 and 75 when the remote model changes; delete themselves from the remote model; and serializes to a local data store 72 and 73 to enable an off-line mode. Each core model object 70 has a unique, well-known remote location 76, against which it is synchronized. The cloud manager 25 is configurable with request and response protocol handlers. Request protocol handlers authenticate a request, while response protocol handlers are responsible for decoding a response into a form, from which the object may be rebuilt. The listener architecture allows subscription to a root element, which will subscribe the listener to all child objects of that model element.

[0090] FIG. 2B illustrates interactions with a comet server 61. Comet clients 62 are pieces of IDE functionality that are called from the My Cloud Web application 32. Comet clients 62 fire events on well-known channels to update content. Comet clients 62 also respond to requests to get or set properties on remote model elements. In addition, they handle requests to synchronize the local and remote cloud application files. Comet clients 62 are configured via XML and dynamically loaded when the JETTY HTTP Server 63 is started. A Comet client loader 77 loads a Comet client configuration file 78. Comet clients 62 are contributed across multiple IDE plugins. The JETTY HTTP Server 63 serves both Comet requests and standard HTTP content requests. The Comet clients 62 integrate with requests for user interface elements outside the browser, including: opening wizards interface 81, views, perspectives, statistics client interface 82, deploy project client interface 79; and starting or stopping the local JAXER™ server interface 80. The Comet clients 62 also respond to requests to start, stop or restart services on the remote cloud application.

[0091] The core model object 70 interfaces with an ILocationObject. Each object has a unique location that is used to obtain and update the remote model for the object. The core model object 70 also interfaces with the ISynchronizableObject. Each object has a core set of methods to synchronize with the remote model. The core set of methods include the following: commit; update; perform action; and delete. The core model object 70 interfaces with the ITransformObject. Each object is able to serialize and de-serialize itself from either the remote format received from the Site Manager or the format obtained from the local data store when the Site Manager is unreachable. The core model object 70 further interfaces with the IModifiableObject. Each object is able to detect changes in the model and notify listeners when model changes occur. The core model object 70 implements the interfaces. The core group object 71 extends the core model objects 70 and allows encapsulation of grouped objects that are obtained from a single web service call. The group as a whole may be synchronized, or, alternatively, individual objects in the group may be synchronized.

[0092] FIG. 3 is a flow chart of a general method 100 of the present invention. At block 102, a web application is developed within an IDE. At block 104, the Web application is deployed from the IDE to a primary cloud provider. At block 106, Web resources are allocated to the Web application from a secondary cloud provider. At block 108, the Web application is monitored and managed from the IDE or a cloud manager associated with the IDE.

[0093] FIG. 4 is a flow chart of a specific method 200 of the present invention. At block 202, a Web application 32 is developed within a single environment 23. The single environment is preferably an IDE. At block 204, the Web application 32 is provisioned. At block 206, the Web application is deployed from the single environment 23 to a primary cloud provider 28. At block 208, the Web application 32 is managed remotely using a cloud manager 25 associated with the single environment 23. At block 210, Web resources 50 from the primary cloud provider 28 are accessed for the web application using the cloud manager 25. At block 212, Web resources 50 from a secondary cloud provider 30 are accessed for the Web application 32 using the cloud manager 28. At block 214, the Web application 32 is managed from the within the single environment 23.

[0094] FIG. 5 illustrates the APTANA start page 300 with the Studio application (IDE) selected. Menus under the Studio application include create projects, recent projects, tasklist, and general Studio information.

[0095] The first step in deploying a project to Cloud is to set up a Web site name. By way of example, the user, who is deploying project “gullwing,” is asked to enter a preferred Web site name for project “gullwing,” such as “cars90210.” APTANA Cloud then determines whether the preferred Web site name (“cars90210”) is available. At step two, the user selects among various service plans available for the Cloud project. During the third step in deploying a project to Cloud, the user sets up enters his user information or sets up a new user account. Additional steps in deploying a project to Cloud include setting up billing information, accepting the Cloud services agreement, and confirming and placing the order. Upon placement of the order, the Web page is displayed, notifying the user that the site is being provisioned. Provisioning the site preferably includes the following steps: (1) contacting APTANA Cloud; (2) setting up the necessary servers; and (3) configuring the Web site.

[0096] Once a site has been provisioned on APTANA Cloud, a user may monitor the status of that Web site. FIG. 6 illustrates the particular My Cloud information for a selected site that is displayed to the user. For example, in the Web page 302 in FIG. 6, the details of the “cars90210” site are displayed under the “Overview” tab. Details include: the particular service plan selected for the site; a graph illustrating the number of hits for the site over a selected period of time; the local project name for the site; the local, main and staged site URLs; the server IP address; and the SVN location. In addition, an Events window may display any alerts regarding the site, such as a warning that the site is nearing its servers' capacity.

[0097] A user may add or invite additional users to the particular Cloud project. Users may be designated as either “admin” or “developer.” Developers may sync projects, folders and files to the site. Admins have the ability to add or remove users for the site as well as sync projects, folders and files.

[0098] One of the benefits of APTANA Cloud is that it provides to the user valuable information regarding popularity of the project site such as “Hits Last 35 Days” for the project site “cars90210.”

[0099] With APTANA Cloud a user may incorporate GOOGLE Analytics to further monitor the project site. For example, the user may set up GOOGLE Analytics for the project site “cars 90210.” Once the site has been set up with GOOGLE Analytics, future displays under the “Analytics” may be similar to that shown in the Web page 304 in FIG. 7, including graphical and numerical data regarding site usage.

[0100] When the user modifies a project, the local site must then be synced with the stage site. FIG. 8 illustrates the synching of local site “gullwing” to project site “cars90210” with view of a Web site overview 306 and a project view 308. The Web page 310 shown in FIG. 9 provides further details regarding the syncing of the “gullwing” local site to the “cars90210” project site.

[0101] A detailed example of a preferred embodiment of the operation of the present invention is set forth below.

[0102] Global IDE requests are made in the following manner:

Projects

[0103] Client ID: ‘projects’

[0104] To Channel ID: ‘/portal/projects’

[0105] Return Channel ID: ‘/portal/projects/’+publisherId

[0106] Return Data: JSON array of project names

Show a project in the projects view:

[0107] To Channel ID: ‘/portal/projects/show’

[0108] To Data: project:‘project name’

[0109] Return: Does not reply

Open a perspective

[0110] To Channel ID: ‘/portal/perspectives/show’

[0111] To Data: id:‘perspective id’

[0112] Return: Does not reply

Open a view

[0113] To Channel ID: ‘/portal/views/show’

[0114] To Data: id:‘view id’

[0115] Return: Does not reply

Open a browser

[0116] To Channel ID: ‘/portal/browser’

[0117] To Data: url:‘url to open in the browser’

[0118] Return: Does not reply

Clients

[0119] Client ID: ‘client listing’

[0120] To Channel ID: ‘/portal/client/listings’

[0121] Return Channel ID: ‘/portal/client/listings’+publishedId

[0122] Return Data: JSON array of client IDs

Open a new project wizard

[0123] Client ID: ‘new project’

[0124] To Channel ID: ‘/portal/projects/new’

[0125] To Data: String id of wizard to open, defaults to web project wizard if empty string

[0126] Return Channel: Does not reply

[0127] Return Data: Does not reply

Get or set a preference

[0128] To Channel ID: ‘/portal/preferences’

[0129] To Data: request:‘get’j‘set’ name:‘name of pref’ value:‘value of pref if setting

[0130] Return Data: action:‘get’ name:‘name of pref’ value:‘value of pref if getting’ (No return if setting)

Get the license status

[0131] To Channel ID: ‘/portal/license’

[0132] To Data: action:‘licenseStatus’

type:‘pro’j‘trial’j‘none’expires:‘MM/DD/YYYY’ (if license is pro or trial)

Open a wizard

[0133] To Channel ID: ‘/portal/wizard’

[0134] To Data: id:‘wizard id’ request:‘new’l‘import’l‘export’

[0135] No reply

[0136] Aptana ID requests are generated as follows:

Get signed in user

[0137] Client ID: ‘aptana,--user’

[0138] To Channel ID: ‘/portal/user’

[0139] Return Channel ID: ‘/porta I/ user/’+pu bl isherId

[0140] Return Data User name or empty string if no user signed in

Sign In a User

[0141] Client ID: ‘aptana_user_login’

[0142] To Channel ID: ‘/portal/user/login’

[0143] To Data:

• • [0144] request: ‘loginUser’
  • [0145] username: ‘username’
  • [0146] password: ‘password’

[0147] Return Channel: ‘/portal/user/’+publisherId

[0148] Return Data:

• • [0149] action: ‘loginUser’
  • [0150] userValid: true/false
  • [0151] usernameValid: true false
  • [0152] passwordValid: true false
    Log Out a User

[0153] Client ID: TBD

[0154] To Channel ID: ‘/portal/user/logout’

[0155] To Channel Data:

• • [0156] arequest: ‘logoutUser’

[0157] Return Channel: ‘/portal/user/’+publisherId

[0158] Return Data:

• • [0159] action: ‘logoutUser’
  • [0160] success: true/false
    Create New User

[0161] Client ID: TBD

[0162] To Channel ID: ‘/portal/user/create’

[0163] To Channel Data:

• • [0164] request: ‘createUser’
  • [0165] username: ‘username’
  • [0166] password: ‘password’
  • [0167] email: ‘email’

[0168] Return Channel: ‘/portal/user/’+publisherId

Return Data:

[0169] action: ‘createUser’

[0170] success: true/false

[0171] usernameValid: true/false (false if username used)

[0172] (any other reasons for failure can be added . . . )

[0173] To Make Message center requests, the following are preferably used:

Display the message center

[0174] To Channel ID: ‘/portal/messages/show’

[0175] To Data: none

[0176] Return: Does not reply

Unread message count

[0177] Client ID: ‘unread messages’

[0178] To Channel ID: ‘/portal/messages’

[0179] Return Channel ID: Vporta I/messages/’+pu bl isherId

[0180] Return Data Integer value of the number of unread messages

Urgent unread message count

[0181] To Channel ID: ‘/portal/messages/urgent’

[0182] Return Channel ID: ‘/portal/messages/urgent/’+publisherId

[0183] Return Data: Integer value of the number of urgent unread messages

[0184] Plugins/Features requests are generated as follows:

Plugins List

[0185] Client ID: TBD

[0186] To Channel ID: ‘/portal/plugins/list’

[0187] To Data:

• • [0188] request: ‘listPlugins’

[0189] Return Channel ID: ‘/portal/plugins/list/’+publisherId

[0190] Return Data:

• • [0191] action: ‘listPlugins’
  • [0192] popular: [(array of hash maps . . . )
    • [0193] id: ‘pluginId’
    • [0194] name: ‘pluginName’
    • [0195] description: ‘plugin Description’
    • [0196] link: ‘pluginSiteLink’
    • [0197] installed: true/false (whether or not the plugin is installed)
    • [0198] update: true/false (whether or not an update is available)

[0199] other: same spec as above, this is the list of third-party plugins

Plugins to Install (Deprecated in favor of above . . . )

[0200] Client ID: ‘install plugins’

[0201] To Channel ID: ‘/portal/plugins/list’

[0202] Return Channel ID: ‘/portal/plugins/list’+publisherId

[0203] Return Data: JSON structure of plugins that are installable

Get changes features

[0204] Client ID: ‘feature changes’

[0205] To Channel ID: ‘/portal/features/changes

[0206] Return Channel ID: ‘/portal/features/changes/’+publisherId

[0207] Return Data: action:‘featureChanges’ changesExist: true I false

[0208] changes: [{icl:‘feature id’, label:‘label’,newVersion:‘new version’, oldVersion:‘old version’, provider:‘provider’} . . . ]

Install a plugin

[0209] To Channel ID: ‘/portal/plugins/install’

[0210] To Message String plugin id to install

[0211] Return Channel ID: ‘/portal/plugins/install’+publisherId

[0212] Return Data: true if the plugin install was successfully launched

Check for plugin updates

[0213] Client ID: ‘check-for-updates’

[0214] To Channel ID: ‘/portal/plugins/updates’

[0215] Return Channel ID: ‘/portal/plugins/updates/’+publisherId

[0216] Return Data: ‘true’ I ‘false’ if a update search was scheduled

[0217] JAXER server requests are made as follows:

Show Jaxer Shell view

[0218] Client ID: ‘/Portal/jaxer/JaxerClient’

[0219] To Channel ID: ‘/portal/jaxer/laxerShellView’

Show Jaxer Activity Monitor view

[0220] Client ID: ‘/Portal/jaxer/JaxerClient’

[0221] To Channel ID: ‘/portal/jaxer/jaxerActivityMonitor’

Show Jaxer preference page

[0222] Client ID: ‘/portal/jaxer/JaxerClient’

[0223] To Channel ID: ‘/portal/jaxer/jaxerPreferences’

Show Servers view

[0224] Client ID: ‘/portal/jaxer/JaxerClient’

[0225] To Channel ID: ‘/portal/jaxer/jaxerServersView’

Show Jaxer Package Server dialog

[0226] Client ID: ‘/Portal/jaxer/laxerClient’

[0227] To Channel ID: ‘/portal/jaxer/jaxerPackageServer’

Get internal Jaxer server state

[0228] Client ID: ‘/Portal/jaxer/JaxerController’

[0229] To Channel ID: ‘/portal/jaxer/jaxerController’

[0230] To Data: request:‘serverStatus’

[0231] Return Channel ID: ‘/portal/jaxer/jaxerController/’+publisherId

[0232] Return Data action:‘serverStatus’ status:‘running’j‘stopped’

Set internal Jaxer server state

[0233] Client ID: ‘/Portal/jaxer/laxerClient’

[0234] To Channel ID: ‘/portal/jaxer/jaxerController’

[0235] To Data: req uest:‘control Server’ setState:‘start’j‘stop’

[0236] Return Channel ID: ‘/portal/jaxer/jaxerController’

[0237] Return Data: action:‘controlServer’ setState:‘done’

[0238] Cloud-specific requests are preferably generated as follows:

List the available products

[0239] To Channel ID: ‘/portal/cloud/products’

[0240] Return Channel ID: ‘/portal/cloud/products’+publisherId

[0241] Return Data: action:‘IistProducts’ products: [{name:‘product name’, active:‘active state’, id:‘product id’} . . . ]

Browse to a cloud sftp node

[0242] To Channel ID: ‘/portal/cloud/site/browse’

[0243] To Channel Data: id:‘site id’ request:‘showFile’

[0244] Return: does not reply

Browse to a remote cloud file

[0245] To Channel ID: ‘/portal/cloud/site/browse’

[0246] To Channel Data: id:‘site id’ request:‘showFile’ path:‘absolute

[0247] path to file to display in the file view’

[0248] Return: does not reply

Open a remote cloud file

[0249] To Channel ID: ‘/portal/cloud/site/browse’

[0250] To Channel Data: id:‘siteid’ request:‘open File’ path:‘absolute path to file to display in the editor’

[0251] Return: does not reply

Open the sync explorer to a project and cloud sftp site

[0252] To Channel ID: ‘/portal/cloud/site/browse’

[0253] To Channel Data: id:‘site id’ request:‘showExplorer’

[0254] Return: does not reply

Get the name, type, and deployed status of all workspace projects

[0255] To Channel ID: ‘/portal/projects/list’

[0256] Return Channel ID: ‘/portal/projects/undeployed’+publisherId

[0257] Return Data: projectsExist: true I false projects:[{name:‘project name’,

[0258] type: ‘a i r‘J’web‘J’rai Is‘J’ph p‘l’un known’, deployed: true I fa Ise,

[0259] siteId:‘id of site if deployed’}]

Log to cloud console and ide log

[0260] To Channel ID: ‘/portal/cloud/log’

[0261] To Data: string that should be logged

[0262] Response: none

Get site statistics

[0263] To Channel ID: ‘/portal/cloud/statistics’

[0264] To Data: request:‘getStats’ type:‘web‘J’resources’ id:‘site id’

[0265] Response Channel ID: ‘/portal/cloud/statistics/’+publisherId

[0266] Response Data:

• • [0267] action: ‘getStats’
  • [0268] id: ‘site id’
  • [0269] type: ‘web’J‘resources’
  • [0270] groups: [{
    • [0271] startHour:‘two digit hour’
    • [0272] startMinute:‘two digit minute’
    • [0273] date:‘month/day date string’
    • [0274] groupName: ‘groupName’ (i.e. Memory, Swap, Hits, etc.),
    • [0275] dataItems: [{
      • [0276] data: [array of data . . . [1,1][2,2], . . . ]
      • [0277] label: seriesLabel (what will show in the legend)
      • [0278] {more data as determined by group name (usually avg., max, min, etc.)}]
  • [0279] other groups as determined by type 1]
    Change project association for a site is preferably generated as follows:
  • [0280] To Channel ID: ‘/portal/cloud/site/project’
  • [0281] To Data: req uest:‘ch a nge Project’ project:‘project name’ site:‘site id’
  • [0282] Return Channel ID: ‘/portal/cloud/site/project/’+publisherId
  • [0283] Return Data: actio n:‘cha n ge Project’ project:‘project name’

[0284] site:‘site id’

Perform a backup (data dump) on a site is preferably generated as follows:

• • [0285] To Channel ID: ‘/portal/cloud/site/dump’
  • [0286] To Data: request:‘dumpData’ id:‘site id’
  • [0287] Return Channel ID: ‘/portal/cloud/site/dump/’+publisherId
  • [0288] Return Data: action:‘dumpData’ success: true I false id: ‘site id’
    Sync a site is preferably generated as follows:
  • [0289] To Channel ID: ‘/portal/cloud/sync’
  • [0290] To Data: request:‘syncSite’ siteId:‘id of site to sync’
  • [0291] Return Data None, start syncs dialog.
    Site manager availability is preferably generated as follows:
  • [0292] Client ID:‘/portal/cloud/available’
  • [0293] To Channel ID:‘/portal/cloud/available’
  • [0294] Return Channel ID:‘/portal/cloud/available/’+publisherId
  • [0295] Return Data: action:‘cloudStatus’ availableftrue I false
    Domain name availability is preferably generated as follows:
  • [0296] Client ID: ‘/portal/cloud/deploy/checkSiteName’
  • [0297] To Channel ID: ‘portal/cloud/deploy’
  • [0298] Message Data: request:‘checkSiteName’ siteName:‘site name to check’
  • [0299] Return Channel ID: ‘/portal/cloud/deploy’+publisherId
  • [0300] Return Data: request:‘checkSiteName’ siteUsed: true I false
    User name availability is preferably generated as follows:
  • [0301] Client ID: ‘/Portal/cloud/deploy/checkUserName’
  • [0302] To Channel ID: ‘/portal/cloud/deploy’
  • [0303] Message Data: request:‘checkUserName’ userName:‘user name to check’
  • [0304] Return Channel ID: ‘/portal/cloud/deploy’+publisherId
  • [0305] Return Data: action:‘checkUserName’ na meUsed: true I false
    Validate user is preferably generated as follows:
  • [0306] Client ID: ‘/portal/cloud/deploy/validateUser’
  • [0307] To Channel ID: ‘/porta I/cl o u d/de ploy’
  • [0308] Message Data: request:‘validateUser’

[0309] username:‘user name’ password:‘password’

• • [0310] Return Channel ID: ‘/portal/cloud/deploy’+publisherId
  • [0311] Return Data: action:‘validateUser’ userVal id:true I false

[0312] userId:“userId”

• • [0313] userna me0k: true I false password0k: true I false

[0314] describeUser

[0315] createUser

[0316] updateUser

[0317] deleteUser

Deploy a project

[0318] Client ID: ‘/portal/cloud/deploy/createSite’

[0319] To Channel ID: ‘/portal/cloud/deploy’

[0320] To Data:

• • [0321] req uest:‘de ploy Project’
  • [0322] userId:‘user name’
  • [0323] password:‘password’
  • [0324] siteName:‘domain to create’
  • [0325] project:‘name of workspace project’
  • [0326] servicePlanId:‘type of site to create, ‘jaxer’ for now’
    billingInfo:

[0327] firstName:‘first name’

[0328] lastName:‘last name’

[0329] address1:‘address 1’

[0330] address2:‘address 2′

[0331] city:‘city’

[0332] state:‘two-digit state’

[0333] country:‘country code’

[0334] zip:‘zip code’

[0335] phone:‘phone number’

[0336] billingName:‘name on the credit card’

[0337] creditCardNumber:‘credit card number’

[0338] expiration:‘credit card expiration’

[0339] cvv2:‘code from card’

Return Channel ID: ‘/portal/cloud/deploy/’+publisherId

[0340] Return Data: action:‘deployProject’ siteCreated:true I falseid: <id

[0341] of site created>

[0342] error: <error message if one exists, only uses this value if

[0343] siteCreated:false>

List sites

[0344] Client ID: ‘list sites’

[0345] To Channel ID: ‘/portal/cloud/sites’

[0346] Return Channel ID: ‘/portal/cloud/sites/’+publisherId

[0347] Return Data: action: ‘listSites’ sites: [{id: ‘siteld’, status:

[0348] ‘running/error/

[0349] pending’, name: ‘site name’ empty array if no sites or user

[0350] not logged in

Describe a site

[0351] To Channel ID: ‘/portal/cloud/sites’

[0352] Return Channel ID: ‘/portal/cloud/sites/’+publisherId

[0353] To Data:

• • [0354] request: ‘siteInfo’
  • [0355] id: ‘siteld’
  • [0356] refresh: true I false (optional, if true return action will be siteInfo Refresh)
    Return Data:
  • [0357] action: ‘siteInfo’
  • [0358] type: ‘servicePlanType’ (jaxer for now)
  • [0359] project: ‘projectName’
  • [0360] domain: ‘siteDomain’
  • [0361] ip: ‘siteIp’
  • [0362] svn:‘svn url’
  • [0363] backups:‘backups url’
  • [0364] db:‘url to php my admin’
  • [0365] analytics:‘google analytics url’
  • [0366] resources:‘resource stats url’
  • [0367] webstats:‘web stats url’
  • [0368] jaxerLog:‘path to jaxer log’
  • [0369] jaxerLogJS:‘path to jaxerLogjs’
  • [0370] jaxerAppsJS:‘path to jaxerAppsjs’
  • [0371] jaxerConfigJS:‘path to configjs’
  • [0372] privateLog:‘path to access log for private area’
  • [0373] privateErrorLog:‘path to error log for private area’
  • [0374] publicLog:‘path to access log for public area’
  • [0375] publicErrorLog:‘path to error log for public area’
  • [0376] disk:‘latest stats of the percentage of disk being used’
  • [0377] diskMax:‘double number of gigs on box’
  • [0378] status:‘Running/Pending/Error’
  • [0379] monitoring:true I false
  • [0380] lastSync:‘Iast sync event content’
  • [0381] lastSyncTime:‘Iast sync event timestamp’
  • [0382] lastDump:‘Iast dump event content’
  • [0383] lastDumpTime:‘Iast dump event timestamp’
  • [0384] id:‘siteld’
  • [0385] events: [ ] (eventually an array of hash objects for messages
    List the events for a site

[0386] To Channel ID: ‘/portal/cloud/site/events’

[0387] To Data: request:‘listEvents’

[0388] Return Channel: ‘/portal/cloud/site/events’

[0389] Return Data: action:‘IistEvents’ id:‘site id’

[0390] events[{time:‘timestamp’,severity:‘severity id’,

[0391] value:‘event content’}]

List the services on a site

[0392] Client ID: ‘/portal/cloud/services’

[0393] To Channel ID: ‘/portal/cloud/services’

[0394] To Data: request:‘listServices’ id:‘site id’

[0395] Return Channel ID: ‘/portal/cloud/services/’+publisherId

[0396] Return Data: action:‘IistServices’ services: [{name:‘service name’, status:‘service status’,

version:‘0.9.7.2824’,commands:[‘command name’, . . . ]} . . . . ]

Stop/Start a service on a site

[0397] To Channel ID: ‘/portal/cloud/services’

[0398] To Data: request:‘changeService’ id:‘site id’

[0399] serviceAction:‘start’j‘stop’l‘restart’

Upgrade a service on a site

[0400] Client ID: ‘/portal/cloud/services’

[0401] To Channel ID: ‘/portal/cloud/services’

[0402] To Data: request:‘changeService’ id:‘site id’

[0403] serviceAction:‘upgrade’ version:‘new version to upgrade to’

Service events

[0404] Return Channel ID: ‘/portal/cloud/site/events/’+siteId+‘/services’

[0405] Return Data: {action:‘serviceEvent’, id:‘site id’, name:‘service name’, version:‘service version’, status:‘service status’}

List available site versions

[0406] To Channel ID: ‘/portal/cloud/services/versions’

[0407] Return Channel ID: ‘/portal/cloud/services/versions/’+publisherId

[0408] Return Data: action:‘IistVersions’ services: [{name:‘service name’, versions: [‘version V, . . . ]}]

[0409] configureSite; rebootSite; deleteSite; getStats; listRoles; addAccount;

[0410] deleteAccount; create Delegation; delete Delegation; listDelegations;

Get the Channel types.

[0411] To Channel ID: ‘/portal/cloud/channelTypes’

[0412] Response Channel ID: ‘/portal/cloud/channelTypes/’+publisherId

[0413] Response Data: action:‘IistChanneiTypes’ types:

[0414] [{icl:‘channel type id’, name:‘channel type name’}, . . . ]

Get the Event types

[0415] To Channel ID: ‘/portal/cloud/eventTypes’

[0416] Response Channel ID: ‘/portal/cloud/eventTypes/’+publisherId

[0417] Response Data: action:‘IistEventTypes’ types[{id:‘event type

[0418] id’, name:‘event type name’}, . . . ]

Get the subscriptions a user has:

[0419] To Channel ID: ‘/portal/cloud/subscriptions’

[0420] To Data: request:‘IjstSubscriptions’

[0421] Return Channel ID: ‘/portal/cloud/subscriptions/’+publisherId

[0422] ResponseData:action:‘ListSubscriptions’subscriptions:

[0423] [{id:‘subscriptionid’,event:{id:‘eventtypeid’,name:‘eventtyp

[0424] ename’},channel:{id:‘channelid’,name:‘channeltypename’,value:‘

[0425] channel value’}]

Add a subscription

[0426] To Channel ID: ‘/portal/cloud/subscriptions’

[0427] To Data: request:‘addSubscription’, value:‘subscription value’,

[0428] channel:‘channel type id’, event:‘event type id’

[0429] Return Channel ID: ‘/portal/cloud/subscriptions/’+publisherId

[0430] Response Data: action:‘addSubscription’ success: true J false

Delete a subscription

[0431] To Channel ID: ‘/portal/cloud/subscriptions’

[0432] To Data: request:‘deleteSubscription’, id:‘subscription id’

[0433] Return Channel ID: ‘/portal/cloud/subscriptions/’+publisherId

[0434] Response Data: action:‘deleteSubscription’ success: true I fa Ise

List the billing accounts

[0435] To Channel ID: ‘/portal/cloud/billing’

[0436] To Data: request:‘IistBilling’

[0437] Response Data: action:‘IistBilling’ accounts: [{id:‘billing

[0438] account id’, name:‘billing name’, number:‘billing number’,

[0439] expiration:‘billing expiration

Delete a billing account

[0440] To Channel ID: ‘/portal/cloud/billing’

[0441] To Data: request:‘deleteBilling’ id:‘billing account id’

[0442] Response Data: action:‘deleteBilling’ success:true I false

Add a billing account

[0443] To Channel ID: ‘/portal/cloud/billing’

[0444] To Data: request:‘addBilling’ name:‘billing name’

[0445] number:‘billing number’ expiration:‘billing expiration’

[0446] Response Data: action: ‘addBilling’ success: true I fa Ise

List the site memberships

[0447] To Channel ID: ‘/portal/cloud/memberships’

[0448] To Data: request:‘IistBilling’

[0449] Response Data: action:‘IistMemberships’ memberships:

[0450] [{role:‘role id’, user:‘user id’}]

Delete a billing account

[0451] To Channel ID: ‘/portal/cloud/memberships’

[0452] To Data: request:‘deleteMembership’ id:‘membership id’ site:‘site id’

[0453] Response Data: action:‘deleteMembership’ success: true I false

Add a membership

[0454] To Channel ID: ‘/portal/cloud/memberships’

[0455] To Data: request:‘addMembership’ role:‘role id’ user:‘user name’ id:‘site id’

[0456] Response Data: action:‘addMembership’ success: true false

deleteSite

[0457] Client ID: TBD

[0458] To Channel ID: ‘/portal/cloud/sites’

To Data:

[0459] request: ‘deleteSite’

[0460] id: ‘siteId

Return Data

[0461] action: ‘deleteSite’ success: true false

[0462] backupSite

[0463] suspend Site

[0464] restoreSite

[0465] unsuspendSite

[0466] listBackups

[0467] describeBackup

[0468] remove Backup

[0469] From the foregoing it is believed that those skilled in the pertinent art will recognize the meritorious advancement of this invention and will readily understand that while the present invention has been described in association with a preferred embodiment thereof, and other embodiments illustrated in the accompanying drawings, numerous changes modification and substitutions of equivalents may be made therein without departing from the spirit and scope of this invention which is intended to be unlimited by the foregoing except as may appear in the following appended claim. Therefore, the embodiments of the invention in which an exclusive property or privilege is claimed are defined in the following appended claims.