Orion/Documentation/Developer Guide/Project services

Overview of project services

Orion allows to extend the project functionality by adding other project types. Project types are not exclusive, one project may be of two different types.

orion.project.handler

The orion.project.handler service is used to provide a custom project handler. Creating a custom project handler enables to:

• Creating project of given type
• Adding dependencies of given type
• Adding additional information to project page

An example implementation can be found in gitPlugin.js.

Service attributes

id

String

type

String the unique identifier of the project type (for instance git or jazz)

addParameters

ParameterDefinition[] Array of objects containing id String, type String describing one of the html5 input types or "textarea" and name being a display String for the parameter. Those parameters will be used to generate an input form when user tries init and new project or dependency.

optionalParameters

Since 5.0 parameterDefinition[] a list of optional parameters that will display in a separate dialog when user clicks "More" in the input form with addParameters

addDependencyName

String Name of the action for adding dependency

addDependencyTooltip

String Tooltip of the action for adding dependency

addProjectName

String Name of the action for adding project

addProjectTooltip

String Tooltip of the action for adding project

actionComment

optional String comment displayed when project or dependency are being initialized

validationProperties

optional ValidationProperties[] that define if given item can be handled by this project handler, see Validation Properties

Service methods

getAdditionalProjectProperties (item, projectMetadata)

optional returns ProjectPageSectionDescription[] Implementing this function allows to add extra information to project page.

Example returned project page section description:

[
 {
   name: "Git",
   children: [
    {
      name: "Git Url",
      value: clone.GitUrl
    },
    {
      name: "Git Status",
      value: "Git Status",
      href: "{+OrionHome}/git/git-status.html#" + item.Git.StatusLocation
    }
  ]
 }
]

will result in rendering the additional section on the project page:

initProject (params, projectMetadata)

optional if implemented users will able to add projects of given type. The function should initialize project in the workspace (including adding project.json to it) and return the project description containing at least ContentLocation

params contains an object of parameters collected from the user based on description in addParamethers attribute. If the list of parameters is not complete rejecting the returned deferred with additional addParamethers attribute will invoke asking user for additional parameters. Afterwords all collected parameters will be resend, so there is no need to remember previously send params.

projectMetadata contains an object with some extra potential project metadata, in particular this object contains WorkspaceLocation.

initDependency (dependency, params, projectMetadata)

optional if implemented users will be able to add associated content of given type. This function should initialize the dependency in user's workspace and return the DependencyDescription

dependency optional DependencyDescription that contains Type, Name and Location. Location should describe the dependency in a way it allows to recreate it in the user's workspace. If invocation of this method contains dependency it means that user had the dependency defined and used Connect action to initialize its content in his workspace.

params parameters inputted by the user while requesting to create a new dependency. User is at first not prompt for parameters if he chooses to connect exiting dependency. Then DependencyDescription is passed as dependency. This function may request for extra parameters in the same way initProject does.

projectMetadata contains an object with project metadata, in particular this object contains WorkspaceLocation.

getDependencyDescription (item)

This function should return DependencyDescription containing Type, Name and Location for given item. This function is used to find dependency in users workspace. This function is only invoked when validationProperties are matched with item

paramsToDependencyDescription (params)

This function should return DependencyDescription containing Type, Name and Location created based on given params. This function is used to check if the dependency that should be created based on parameters inputted by the user already exists in this workspace.

orion.project.deploy

The orion.project.deploy service is used to provide ways to deploy the project contents.

Service attributes

id

String

name

String

tooltip

String

deployTypes

String[] The list of deploy types, for instance ["ftp"]

priorityForDefault

optional Integer If there are more then one deployment of type defined in deployTypes this number will help which plugin should be use to perform the deployment

logLocationTemplate

optional UrlTemplate A template to location to deployment logs that will be resolved using the launchConfiguration, for instance "{+OrionHome}/deployment/logs.html#{Name,Params*}",

validationProperties

optional ValidationProperties[] that define if given item can be deployed by this deploy service, see Validation Properties

Service methods

deploy(project, launchConf)

Preform the deployment. Returns the deploy result (may contain launch configuration to save) in callback or an error in errback

getState(properties)

optional Check the state of the deployed application, example result {State: "STARTED"}

start(properties)

optional Starts the deployed application, can return a state of the application

stop(properties)

optional Stops the deployed application, can return a state of the application

getDeployProgressMessage(project, launchConf)

optional Can return a string that will be displayed as a progress message while the application is being deployed

Response fields, applicable to all methods

ToSave

Object {Name(String), Params(Object), Url(String), ManageUrl(String, optional), Path(String, optional), Type(String)} Launch configuration description. Should be returned if launch configuration should be saved in the project and included in "Deployment Information" section on project page. Params attribute should contain all the information necessary to redeploy the application, Type must be identical with one of the deployTypes. Url contains the link to deployed application. ManageUrl should contain a link to any external configuration of the application provided. Path is default root of project.

Saved

Object {Name(String), Params(Object), Url(String), ManageUrl(String, optional), Path(String, optional), Type(String)} Same as ToSave, but indicates that the launch configuration was saved elsewhere outside of Orion and should be added to the view, but not saved to the file

Message

String Message to display to the user

State

String NOT_DEPLOYED, STARTED, STOPPED If application state was changed by the action

Retry

If some extra information is necessary Retry may contain a description of the parameters that user should be asked about. The results will be mixed in with the parameters when the function is retried. Example:

1. Retry: {
2.     parameters: [
3.         {id: "user", type: "text", name: "User:"},
4.         {id: "password", type: "password", name: "Password:"}
5.     ]
6. }

UriTemplate

Instead of Retry, plugin may return a template for a URL to load and take over the deployment, including the parameters collection. The full response example:

1. {
2.     UriTemplate: "{+OrionHome}/cfui/deployInteractive.html",
3.     Width: "400px",
4.     Height: "350px",
5.     UriTemplateId: "org.eclipse.orion.client.cf.deploy.uritemplate"
6. }