= Http Shell: Keywords =

The HttpShell is driven by HTTP POST parameters following certain naming conventions. It is a JEE Filter in the execution path of all MeshObject URLs, and thus it can be triggered as a side effect when accessing any MeshObject.

All HttpShell keywords are prefixed by `shell.`

The HttpShell makes use of variables, in order to be able to refer to the same MeshObject several times. For example, in a single operation, a MeshObject called `AAA` may be accessed, blessed and related to another MeshObject. Any number of variables may be defined and used in a single operation.


|| ''Keyword''                                        || ''Example value''                            || ''Meaning''                                                                                                                    ||
|| `shell.`'''`AAA`'''                                || `http://example.com/myobject`                || identifies variable '''`AAA`''' with the MeshObject with identifier `http://example.com/myobject`                              ||
|| `shell.`'''`AAA`'''`.access`                       || `create`                                     || create the MeshObject associated with variable '''`AAA`'''; throw Exception if it exists already                               ||
|| `shell.`'''`AAA`'''`.access`                       || `find`                                       || find the MeshObject associated with variable '''`AAA`'''; throw Exception if it does not exist                                 ||
|| `shell.`'''`AAA`'''`.access`                       || `findifexists`                               || find the MeshObject associated with variable '''`AAA`'''; do not throw Exception if it does not exist                          ||
|| `shell.`'''`AAA`'''`.access`                       || `createorfind`                               || find the MeshObject associated with variable '''`AAA`'''; create it instead if it does not exist                               ||
|| `shell.`'''`AAA`'''`.access`                       || `delete`                                     || delete the MeshObject associated with variable '''`AAA`'''; throw Exception if it does not exist                               ||
|| `shell.`'''`AAA`'''`.meshbase`                     || MeshBase identifier                          || identifies the MeshBase in which the access shall be performed; if not given, use default MeshBase                             ||
|| `shell.`'''`AAA`'''`.redirect`                     || `true` or `false`                            || if `true`, perform a redirect to this MeshObject                                                                               ||
|| `shell.`'''`AAA`'''`.bless`                        || `org.infogrid.model.Blob/BlobObject`         || blesses the MeshObject held by variable '''`AAA`''' with the EntityType with identifier `org.infogrid.model.Blob/BlobObject`   ||
|| `shell.`'''`AAA`'''`.unbless`                      || `org.infogrid.model.Blob/BlobObject`         || unblesses the MeshObject held by variable '''`AAA`''' from the EntityType with identifier `org.infogrid.model.Blob/BlobObject` ||
|| `shell.`'''`AAA`'''`.propertytype.`'''`BBB`'''     || `org.infogrid.model.Wiki/WikiObject_Content` || identifies variable '''`BBB`''' with the [wiki:Property] `org.infogrid.model.Wiki/WikiObject_Content` in the MeshObject associated with variable '''`AAA`''' ||
|| `shell.`'''`AAA`'''`.propertyvalue.`'''`BBB`'''    || `<p>New blurb.</p>`                          || assigns a new value `<p>New blurb.</p>` to the [wiki:Property] associated with variable '''`BBB`'''                            ||
|| `shell.`'''`AAA`'''`.to.`'''`BBB`'''`.perform`     || `relate`                                     || relate [wiki:MeshObject MeshObjects] associated with variables '''`AAA`''' and '''`BBB`'''; throw Exception if they are related already ||
|| `shell.`'''`AAA`'''`.to.`'''`BBB`'''`.perform`     || `relateifneeded`                             || relate [wiki:MeshObject MeshObjects] associated with variables '''`AAA`''' and '''`BBB`''' if they are not related already     ||
|| `shell.`'''`AAA`'''`.to.`'''`BBB`'''`.perform`     || `unrelate`                                   || unrelate [wiki:MeshObject MeshObjects] associated with variables '''`AAA`''' and '''`BBB`'''; thrown Exception if they are not related ||
|| `shell.`'''`AAA`'''`.to.`'''`BBB`'''`.perform`     || `unrelateifneeded`                           || unrelate [wiki:MeshObject MeshObjects] associated with variables '''`AAA`''' and '''`BBB`''' if they are related               ||
|| `shell.`'''`AAA`'''`.to.`'''`BBB`'''`.blessRole`   || `org.infogrid.model.Bookmark/BookmarkCollection_Collects_Bookmark-S` || bless the [wiki:Relationship] between [wiki:MeshObject MeshObjects] associated with variables '''`AAA`''' (source) and '''`BBB`''' (destination) with RelationshipType `org.infogrid.model.Bookmark/BookmarkCollection_Collects_Bookmark` ||
|| `shell.`'''`AAA`'''`.to.`'''`BBB`'''`.unblessRole` || `org.infogrid.model.Bookmark/BookmarkCollection_Collects_Bookmark-S` || unbless the [wiki:Relationship] between [wiki:MeshObject MeshObjects] associated with variables '''`AAA`''' (source) and '''`BBB`''' (destination) from RelationshipType `org.infogrid.model.Bookmark/BookmarkCollection_Collects_Bookmark` ||

See also:
 * HttpShell
 * [wiki:Docs/HttpShellOverview HttpShellOverview]
 * [wiki:Docs/HttpShellExamples HttpShellExamples].