org.omixed.omixedserver.endpoint
Class ServerEndpoint

java.lang.Object
  extended by org.omixed.omixedserver.endpoint.ServerEndpoint

public class ServerEndpoint
extends java.lang.Object


Constructor Summary
ServerEndpoint()
           
 
Method Summary
 java.lang.String addTagToItem(java.lang.String sessionID, java.lang.String itemID, java.lang.String accessGroup, java.lang.String tagName)
          Adds a tag specified by tagName and accessGroup to an existing item specified by itemID.
 java.lang.String connect(java.lang.String resourceName, java.lang.String userName, java.lang.String password)
          Attempts to connect to the specified resource with the given userName and password.
 java.lang.String create(java.lang.String sessionID, java.lang.String itemID, java.lang.String accessGroup, java.lang.String itemXML)
          Creates a new item with the specified itemID, accessGroup and itemXML.
 java.lang.String delete(java.lang.String sessionID, java.lang.String itemID)
          Deletes an existing item with the specified itemID.
 org.apache.axiom.om.OMElement describeSchemaItemType(java.lang.String sessionID, java.lang.String itemType)
           
 java.lang.String disconnect(java.lang.String sessionID)
          Attempts to close the session identified by the sessionID.
 java.lang.String endBatchAndCommit(java.lang.String sessionID)
           
 java.lang.String endBatchAndRollback(java.lang.String sessionID)
           
 org.apache.axiom.om.OMElement findItems(java.lang.String sessionID, java.lang.String searchString, java.lang.String searchOptions)
           
 int forumCreateThread(java.lang.String sessionID, java.lang.String itemID, java.lang.String threadTitle, java.lang.String messageBody)
           
 java.lang.String forumDeleteMessage(java.lang.String sessionID, java.lang.String itemID, int threadIndex, int messageIndex)
           
 org.apache.axiom.om.OMElement forumGetMessages(java.lang.String sessionID, java.lang.String itemID, int threadIndex, int fromIndex, int toIndex, java.lang.String ordering)
           
 org.apache.axiom.om.OMElement forumGetThreads(java.lang.String sessionID, java.lang.String itemID, int fromIndex, int toIndex, java.lang.String ordering)
           
 int forumPostMessage(java.lang.String sessionID, java.lang.String itemID, int threadIndex, java.lang.String messageBody)
           
 java.lang.String getDomainName(java.lang.String sessionID)
           
 org.apache.axiom.om.OMElement getFileDetails(java.lang.String sessionID, java.lang.String fileID)
           
 java.lang.String[] getIncomingLinkedItems(java.lang.String sessionID, java.lang.String itemID)
          Returns the itemID for the items which are linked to the specified itemID.
 org.apache.axiom.om.OMElement getItemGraph(java.lang.String sessionID, java.lang.String itemID, int maxOutboundDepth, int maxInboundDepth, int maxFanOut, int maxFanIn)
          Returns an XML document which describes the full graph of items linked from the specified itemID.
 byte[] getItemGraphWithLayout(java.lang.String sessionID, java.lang.String itemID, java.lang.String layoutMethod, java.lang.String outputFormat, java.lang.String layoutArguments, int maxOutboundDepth, int maxInboundDepth, int maxFanOut, int maxFanIn)
          Returns an XML document which is an SVG representation of the item graph for the item specified by itemID.
 java.lang.String[] getItemIDs(java.lang.String sessionID, java.lang.String partialItemID)
          Returns the itemID for the items which match the specified itemID.
 org.apache.axiom.om.OMElement getItems(java.lang.String sessionID, java.lang.String partialItemID, int linkExpansionDepth)
          Returns an XML document which describes the item(s) which matches the specified partialItemID.
 java.lang.String[] getItemTypeLinks(java.lang.String sessionID, java.lang.String itemType)
           
 java.lang.String[] getItemTypes(java.lang.String sessionID)
           
 java.lang.String[] getLinkedItems(java.lang.String sessionID, java.lang.String itemID, java.lang.String itemTypeName)
          Returns an array of itemIDs for the items of the specified itemTypeName which are linked in any way to the specified itemID.
 java.lang.String[] getLinkedItemsUsingPath(java.lang.String sessionID, java.lang.String itemID, java.lang.String path)
          Finds the items linked via the provided path from the specified itemID.
 java.lang.String[] getRootItemTypes(java.lang.String sessionID)
           
 byte[] getSchemaWithLayout(java.lang.String sessionID, java.lang.String layoutMethod, java.lang.String outputFormat, java.lang.String layoutArguments)
           
 java.lang.String[] getTags(java.lang.String sessionID)
          Returns a list of all of the tags currently defined.
 java.lang.String getUserProperty(java.lang.String sessionID, java.lang.String propertyName)
           
 org.apache.axiom.om.OMElement getVisibleFiles(java.lang.String sessionID)
           
 org.apache.axiom.om.OMElement[] getWithTags(java.lang.String sessionID, java.lang.String partialItemID)
          Returns an array of XML documents, one for each of the items which match the specified itemID.
 java.lang.String notificationAddTrigger(java.lang.String sessionID, java.lang.String eventTypes, java.lang.String resourceNamePattern, java.lang.String itemTypeNamePattern, java.lang.String ownerNamePattern, java.lang.String itemNamePattern)
           
 org.apache.axiom.om.OMElement notificationGetNotifications(java.lang.String sessionID)
           
 org.apache.axiom.om.OMElement notificationGetTriggers(java.lang.String sessionID)
           
 java.lang.String notificationRemoveAllMessages(java.lang.String sessionID)
           
 java.lang.String notificationRemoveTrigger(java.lang.String sessionID, java.lang.String eventTypes, java.lang.String resourceNamePattern, java.lang.String itemTypeNamePattern, java.lang.String ownerNamePattern, java.lang.String itemNamePattern)
           
 java.lang.String removeTagFromItem(java.lang.String sessionID, java.lang.String itemID, java.lang.String tagName)
          Removes the tag specified by tagName from the existing item specified by itemID.
 java.lang.String[] searchItems(java.lang.String sessionID, java.lang.String itemTypeName, java.lang.String searchXML)
           
 java.lang.String setUserProperty(java.lang.String sessionID, java.lang.String propertyName, java.lang.String propertyValue)
           
 java.lang.String startBatch(java.lang.String sessionID)
           
 java.lang.String update(java.lang.String sessionID, java.lang.String itemID, java.lang.String accessGroup, java.lang.String itemXML)
          Updates an existing item with the specified itemID, accessGroup and itemXML.
 java.lang.String validate(java.lang.String sessionID, java.lang.String itemID, java.lang.String accessGroup, java.lang.String itemXML, boolean intendedForUpdate)
          Evaluates the specified itemXML to determine whether it is valid.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerEndpoint

public ServerEndpoint()
Method Detail

connect

public java.lang.String connect(java.lang.String resourceName,
                                java.lang.String userName,
                                java.lang.String password)
                         throws java.lang.Exception

Attempts to connect to the specified resource with the given userName and password.

Returns a String containing the session ID that has been allocated.

Throws a ConnectionFailedException if there is a problem connecting, for example if the resouceName is not recognised or the userName or password are invalid.

Parameters:
resourceName - a String value
userName - a String value
password - a String value
Returns:
a String value
Throws:
ConnectionFailedException - if an error occurs
java.lang.Exception

disconnect

public java.lang.String disconnect(java.lang.String sessionID)
                            throws java.lang.Exception

Attempts to close the session identified by the sessionID.

Returns the String "OK" if the disconnection occurred properly.

Throws a SessionException if there was a problem, for example the sessionID not being valid.

Parameters:
sessionID - a String value
Throws:
SessionException - if an error occurs
java.lang.Exception

getDomainName

public java.lang.String getDomainName(java.lang.String sessionID)
                               throws java.lang.Exception
Throws:
java.lang.Exception

getItemIDs

public java.lang.String[] getItemIDs(java.lang.String sessionID,
                                     java.lang.String partialItemID)
                              throws java.lang.Exception

Returns the itemID for the items which match the specified itemID.

The result of a fully qualified getItemIDs() (i.e. one in which all parts of the itemID are provided) will reveal whether that the item exists and that this session has permission to read it.

If the item exists and is visible to the session, then the result will be the single itemID that exactly matches the input itemID. Otherwise if the item does not exist, or is not visible, then null will be returned.

If the input itemID is incomplete (i.e. it does not specify an item name or an owner name) then all items which match it (and which are visible to the session) will be returned.

For example:

The result of this method is always either null or a String[] containing at least one valid itemID.

Parameters:
sessionID - a String value
itemID - a String value
Returns:
a String[] value
Throws:
java.lang.Exception - if an error occurs

getWithTags

public org.apache.axiom.om.OMElement[] getWithTags(java.lang.String sessionID,
                                                   java.lang.String partialItemID)
                                            throws java.lang.Exception

Returns an array of XML documents, one for each of the items which match the specified itemID. The document identifies the item and list any tags associated with that item.

Only those items which are visible to the session making the request will be included in the results. Similarly, only the tags which are visible to the session will be revealed.

The resulting document is of the form:

    <Item itemID="www.omixed.org/test/Person/admin/Tom" accessGroup="SomeAccessGroup">
      <Tag name="something" owner="fred"/>
      <Tag name="other thing" owner="fred"/>
    </Item>

    <Item itemID="www.omixed.org/test/Person/admin/Dick" accessGroup="OtherAccessGroup"/>

    <Item itemID="www.omixed.org/test/Person/admin/Harry" accessGroup="AnotherAccessGroup">
      <Tag name="different" owner="john"/>
      <Tag name="similar" owner="john"/>
    </Item>
 

Items which have visible tags associated with them will be represented as an <Item> element with nested <Tag> elements. The <Tag> elements specify both the name of the tag and name of the user who added it. Items without tags will appear as a simple <Item/> element with no child elements.

The result of a fully qualified getWithTags() (i.e. one in which all parts of the itemID are provided) will reveal whether the item exists and that this session has permission to read it.

If the item exists and is visible to the session, then the result will be the single itemID that exactly matches the input itemID. Otherwise if the item does not exist, or is not visible, then null will be returned.

If the input itemID is incomplete (i.e. it does not specify an item name or an owner name) then all items which match it (and which are visible to the session) will be returned.

For example:

The result of this method is always either null or a org.apache.axiom.om.OMElement[] containing the XML documents as described above.

Parameters:
sessionID - a String value
itemID - a String value
Returns:
a org.apache.axiom.om.OMElement[] value
Throws:
java.lang.Exception - if an error occurs

getItems

public org.apache.axiom.om.OMElement getItems(java.lang.String sessionID,
                                              java.lang.String partialItemID,
                                              int linkExpansionDepth)
                                       throws java.lang.Exception

Returns an XML document which describes the item(s) which matches the specified partialItemID.

The details of an item include information about any tags associated with the item, however only tags which are visible to the user making the request will be included.

The details will include information about the discussion forum for the item if one exists.

If the user making the request has write permission for the item, them an empty element will be included in the details for that item.

An incomplete or erroneous itemID will result in a ValidationException being thrown.

If one or more of the items linked to by the specified itemID is not visible to the session, then a PartialVisibilityException exception will be thrown.

The resulting document is of the form:

    <ItemList>
      <Item itemID="SomeDomain/SomeResrouce/SomeType/SomeUser/SomeName" accessGroup="SomeAccessGroup">
        <Writable/>
        <Forum id="2" threadCount="1" messageCount="3" mostRecentPostTime="..." mostRecentPoster="SomePerson"/>
        <Tag name="different" owner="john"/>
        <Tag name="similar" owner="john"/>
        <Link name="SomeLinkName" itemID="www.omixed.org/test/Foo/Bar/Baz"/>
        <Link name="SomeLinkName" itemID="www.omixed.org/test/Bish/Bash/Bosh"/>
        <Attribute name="Attr1" type="Type1">some value</Attribute>
        <Attribute name="Attr2" type="Type2">some other value</Attribute>
        <AccessGroup name="AccessGroup1">
          <Link name="SomeOtherLinkName" itemID="www.omixed.org/test/ding/dang/dong"/>
          <Attribute name="Attr3" type="Type3">yet another value</Attribute>
        </AccessGroup>
      </Item>
    </ItemList>
 

There will be one <Item> element in the document for each of the items that match the partialItemID.

Within each :

  • Forums ... ::TODO::

  • Files ... ::TODO::

  • Datablocks ... ::TODO::

    The ordering of the child elements of the <Item> element is indeterminate, but <AccessGroup> hierarchies are guaranteed to match the layout of the item type in the schema definition.

    The linkExpansionDepth parmeter controls whether linked items are simply represented as elements or whether the full details of the linked item are included. If it is set to 0, then no expansion of links will occur. Setting it to a positive integer will expand links that number of times. For example, a depth of 2 means that the child links will be expanded, and any links from within those children will also be expanded. Finally, if it set to any negative integer then links will be expanded indefinately.

    It is possible for items to be linked in a cyclic chain, e.g. A links to B, B links to C and C links to A. In this case, each item will only appear at most once in its expanded form in the results of this method. If the item details for A are requested and the linkExpansionDepth is set to unlimited, then the second appearance of A (when it is linked to from C) will not be expanded.

    The result of this method is always either null or a org.apache.axiom.om.OMElement containing an XML document as described above.

    Parameters:
    sessionID - a String value
    itemID - a String value
    Returns:
    a org.apache.axiom.om.OMElement value
    Throws:
    java.lang.Exception - if an error occurs

  • getLinkedItems

    public java.lang.String[] getLinkedItems(java.lang.String sessionID,
                                             java.lang.String itemID,
                                             java.lang.String itemTypeName)
                                      throws java.lang.Exception

    Returns an array of itemIDs for the items of the specified itemTypeName which are linked in any way to the specified itemID.

    All possible paths through the schema are considered in order to discover linked items.

    If no linked items are found then null is returned.

    An incomplete or erroneous itemID will result in a ValidationException being thrown.

    Only those items which are visible to the session making the request will be included in the results.

    The result of this method is always either null or a String[] containing at least one valid itemID.

    Parameters:
    sessionID - a String value
    itemID - a String value identifiying the item at which searchs should start
    itemTypeName - a String value identifiying the item type required in the search results
    Returns:
    a String[] value containing at least one itemID, or null if no results found
    Throws:
    java.lang.Exception - if an error occurs

    getIncomingLinkedItems

    public java.lang.String[] getIncomingLinkedItems(java.lang.String sessionID,
                                                     java.lang.String itemID)
                                              throws java.lang.Exception

    Returns the itemID for the items which are linked to the specified itemID.

    An incomplete or erroneous itemID will result in a ValidationException being thrown1.

    Only those items which are visible to the session making the request will be included in the results.

    The result of this method is always either null or a String[] containing at least one valid itemID.

    Parameters:
    sessionID - a String value
    itemID - a String value
    Returns:
    a String[] value
    Throws:
    java.lang.Exception - if an error occurs

    getLinkedItemsUsingPath

    public java.lang.String[] getLinkedItemsUsingPath(java.lang.String sessionID,
                                                      java.lang.String itemID,
                                                      java.lang.String path)
                                               throws java.lang.Exception

    Finds the items linked via the provided path from the specified itemID.

    The itemIDs of the found items will be returned, or null if no items are linked via the specified path.

    The path is specified in terms of the names of the links to or from the starting point, as a sequence of link names delimited by ".", e.g. "Vehicle.Owner.Employer".

    The path should not contain any item type names, only link names.

    Links can be followed in either direction.

    The final step in the path identifies the item type of the items that may be returned.

    If the path specification is invalid (e.g. it contains an unrecognised or ambiguous link name) then a PathFindingException will be thrown.

    Parameters:
    sessionID - a String value
    itemID - a String value
    path - a String value
    Returns:
    a String[] value
    Throws:
    java.lang.Exception - if an error occurs

    getItemGraph

    public org.apache.axiom.om.OMElement getItemGraph(java.lang.String sessionID,
                                                      java.lang.String itemID,
                                                      int maxOutboundDepth,
                                                      int maxInboundDepth,
                                                      int maxFanOut,
                                                      int maxFanIn)
                                               throws java.lang.Exception

    Returns an XML document which describes the full graph of items linked from the specified itemID.

    The graph will be rooted at the item specified by itemID. The children of the root node will include all of the items that that item is linked to, and each of those items will contain the items that they are linked to and so on.

    The maximum depth of the graph in both the outbound and inbound direction can be limited by setting maxOutboundDepth and/or maxInboundDepth to either zero or to some positive integer. To specifiy an unlimted depth, use the constant ItemGraphNode.UNLIMTED (or any negative integer).

    In a future implementation, the maximum allowable fan-in or fan-out for any given node will be controllable using the maxFanOut and maxFanInparameters. At present, these parameters are ignored.

    If one or more of the items in the graph are not visible to the session, then a PartialVisibilityException exception will be thrown.

    The resulting document is of the form:

        <Item itemID="domainName/resourceName/Type1/User1/Name1" accessGroup="AccessGroup1">
          <Link name="Link1"/>
            <Item itemID="domainName/resourceName/Type2/User2/Name2" accessGroup="AccessGroup2"/>
          </Link>
          <Link name="Link2"/>
            <Item itemID="domainName/resourceName/Type3/User3/Name3" accessGroup="AccessGroup3">
              <Link name="Link4"/>
                <Item itemID="domainName/resourceName/Type4/User4/Name4" accessGroup="AccessGroup4"/>
              </Link>
              <Link name="Link4"/>
                <Item itemID="domainName/resourceName/Type4/User4/Name5" accessGroup="AccessGroup5"/>
              </Link>
            </Item>
          </Link>
        </Item>
     

    Parameters:
    sessionID - a String value
    itemID - a String value
    maxOutboundDepth - an int value
    maxInboundDepth - an int value
    maxFanOut - an int value
    maxFanIn - an int value
    Returns:
    a org.apache.axiom.om.OMElement value
    Throws:
    java.lang.Exception - if an error occurs

    getItemGraphWithLayout

    public byte[] getItemGraphWithLayout(java.lang.String sessionID,
                                         java.lang.String itemID,
                                         java.lang.String layoutMethod,
                                         java.lang.String outputFormat,
                                         java.lang.String layoutArguments,
                                         int maxOutboundDepth,
                                         int maxInboundDepth,
                                         int maxFanOut,
                                         int maxFanIn)
                                  throws java.lang.Exception

    Returns an XML document which is an SVG representation of the item graph for the item specified by itemID.

    The maximum depth of the graph in both the outbound and inbound direction can be limited by setting maxOutboundDepth and/or maxInboundDepth to either zero or to some positive integer. To specifiy an unlimted depth, use the constant ItemGraphNode.UNLIMTED (or any negative integer).

    In a future implementation, the maximum allowable fan-in or fan-out for any given node will be controllable using the maxFanOut and maxFanInparameters. At present, these parameters are ignored.

    The graph will be rooted at the item specified by itemID. The children of the root node will include all of the items that that item is linked to, and each of those items will contain the items that they are linked to and so on.

    If one or more of the items in the graph are not visible to the session, then a PartialVisibilityException exception will be thrown.

    The document is generated by the dot program which is part of the GraphViz package. See the documentation of dot for details of this format.

    Parameters:
    sessionID - a String value
    itemID - a String value
    layoutMethod - a String value
    outputFormat - a String value
    layoutArguments - a String value
    maxOutboundDepth - an int value
    maxInboundDepth - an int value
    maxFanOut - an int value
    maxFanIn - an int value
    Returns:
    a String value
    Throws:
    SessionException - if the session is invalid or has timed out
    SecurityException - if a security error occurs
    LayoutFailureException - if an error occurs during the SVG generation
    ValidationException - if the itemID cannot be parsed
    PartialVisibilityException - if one or more of the linked items are not visible
    java.lang.Exception

    validate

    public java.lang.String validate(java.lang.String sessionID,
                                     java.lang.String itemID,
                                     java.lang.String accessGroup,
                                     java.lang.String itemXML,
                                     boolean intendedForUpdate)
                              throws java.lang.Exception

    Evaluates the specified itemXML to determine whether it is valid.

    This method is used to validate a prospective item defintion prior to a client attempting a create or update operation. It validates the provided itemXML and if the input is good, returns the String "OK" or throws a ValidationException with a message giving the details of one or more problems with the input.

    The intendedForUpdate parameter selects whether the validation should assume the item is being updated (if set to true) or it is being created (if set to false).

    Parameters:
    sessionID - a String value
    itemXML - a String value
    Throws:
    java.lang.Exception - if a validation error occurs, for example an unrecognised itemType or a missing link

    create

    public java.lang.String create(java.lang.String sessionID,
                                   java.lang.String itemID,
                                   java.lang.String accessGroup,
                                   java.lang.String itemXML)
                            throws java.lang.Exception

    Creates a new item with the specified itemID, accessGroup and itemXML.

    Parameters:
    sessionID - a String value
    itemID - a String value
    accessGroup - a String valueb
    itemXML - a String value
    Throws:
    ValidationException - if a validation error occurs, for example an invalid or unrecognised itemID
    SessionException - if a session error occurs, for example not being logged in
    SecurityException - if a security error occurs, for example not having permission to link to some other item
    LocalItemParseException - if there is a problem parsing the itemXML
    java.lang.Exception

    update

    public java.lang.String update(java.lang.String sessionID,
                                   java.lang.String itemID,
                                   java.lang.String accessGroup,
                                   java.lang.String itemXML)
                            throws java.lang.Exception

    Updates an existing item with the specified itemID, accessGroup and itemXML.

    If the itemID does not exist in the database, then a ValidationException will be thrown.

    The itemID must correspond with an existing item otherwise a ValidationException will be thrown.

    The values for accessGroup and/or itemXML can be different to those provided when the item was created.

    Parameters:
    sessionID - a String value
    itemID - a String value
    accessGroup - a String valueb
    itemXML - a String value
    Throws:
    ValidationException - if a validation error occurs, for example an unrecognised itemType or a missing link
    SessionException - if a session error occurs, for example not being logged in
    SecurityException - if a security error occurs, for example not having permission to link to some other item
    LocalItemParseException - if there is a problem parsing the itemXML
    java.lang.Exception

    delete

    public java.lang.String delete(java.lang.String sessionID,
                                   java.lang.String itemID)
                            throws java.lang.Exception

    Deletes an existing item with the specified itemID.

    Items cannot be deleted if they are being linked to by any other item.

    DO NOT USE THIS METHOD.

    Throws:
    java.lang.Exception

    addTagToItem

    public java.lang.String addTagToItem(java.lang.String sessionID,
                                         java.lang.String itemID,
                                         java.lang.String accessGroup,
                                         java.lang.String tagName)
                                  throws java.lang.Exception

    Adds a tag specified by tagName and accessGroup to an existing item specified by itemID.

    If the accessGroup is not recognised then a ValidationException will be thrown.

    If the specified itemID does not exist or is not visible to the session then nothing will happen and no exception will be thrown. This behaviour is designed to prevent this method from being to determine whether particular items exist.

    The tagName does not have to correspond to an existing tag. If the tagName is not recognised then a new tag will be created and associated with the user making this request.

    Parameters:
    sessionID - a String value
    itemID - a String value
    accessGroup - a String value
    tagName - a String value
    Throws:
    TaggingException - if an error occurs
    ValidationException - if an error occurs
    SessionException - if an error occurs
    SecurityException - if an error occurs
    java.lang.Exception

    removeTagFromItem

    public java.lang.String removeTagFromItem(java.lang.String sessionID,
                                              java.lang.String itemID,
                                              java.lang.String tagName)
                                       throws java.lang.Exception

    Removes the tag specified by tagName from the existing item specified by itemID.

    If the specified itemID does not exist or is not visible to the session then nothing will happen and no exception will be thrown. This behaviour is designed to prevent this method from being to determine whether particular items exist.

    If the specified item does exist and is visible to the session, but does not have a tag corresponding to tagName then a TaggingException will be thrown.

    Parameters:
    sessionID - a String value
    itemID - a String value
    tagName - a String value
    Throws:
    TaggingException - if an error occurs
    ValidationException - if an error occurs
    SessionException - if an error occurs
    SecurityException - if an error occurs
    java.lang.Exception

    getTags

    public java.lang.String[] getTags(java.lang.String sessionID)
                               throws java.lang.Exception

    Returns a list of all of the tags currently defined.

    Tags are ordered by their popularity (i.e. how many times theys are being used).

    If there are no tags currently defined, then null is returned.

    Parameters:
    sessionID - a String value
    Throws:
    SessionException - if an error occurs
    SecurityException - if an error occurs
    java.lang.Exception

    forumCreateThread

    public int forumCreateThread(java.lang.String sessionID,
                                 java.lang.String itemID,
                                 java.lang.String threadTitle,
                                 java.lang.String messageBody)
                          throws java.lang.Exception
    Throws:
    java.lang.Exception

    forumPostMessage

    public int forumPostMessage(java.lang.String sessionID,
                                java.lang.String itemID,
                                int threadIndex,
                                java.lang.String messageBody)
                         throws java.lang.Exception
    Throws:
    java.lang.Exception

    forumDeleteMessage

    public java.lang.String forumDeleteMessage(java.lang.String sessionID,
                                               java.lang.String itemID,
                                               int threadIndex,
                                               int messageIndex)
                                        throws java.lang.Exception
    Throws:
    java.lang.Exception

    forumGetThreads

    public org.apache.axiom.om.OMElement forumGetThreads(java.lang.String sessionID,
                                                         java.lang.String itemID,
                                                         int fromIndex,
                                                         int toIndex,
                                                         java.lang.String ordering)
                                                  throws java.lang.Exception
    Throws:
    java.lang.Exception

    forumGetMessages

    public org.apache.axiom.om.OMElement forumGetMessages(java.lang.String sessionID,
                                                          java.lang.String itemID,
                                                          int threadIndex,
                                                          int fromIndex,
                                                          int toIndex,
                                                          java.lang.String ordering)
                                                   throws java.lang.Exception
    Throws:
    java.lang.Exception

    notificationGetTriggers

    public org.apache.axiom.om.OMElement notificationGetTriggers(java.lang.String sessionID)
                                                          throws java.lang.Exception
    Throws:
    java.lang.Exception

    notificationAddTrigger

    public java.lang.String notificationAddTrigger(java.lang.String sessionID,
                                                   java.lang.String eventTypes,
                                                   java.lang.String resourceNamePattern,
                                                   java.lang.String itemTypeNamePattern,
                                                   java.lang.String ownerNamePattern,
                                                   java.lang.String itemNamePattern)
                                            throws java.lang.Exception
    Throws:
    java.lang.Exception

    notificationRemoveTrigger

    public java.lang.String notificationRemoveTrigger(java.lang.String sessionID,
                                                      java.lang.String eventTypes,
                                                      java.lang.String resourceNamePattern,
                                                      java.lang.String itemTypeNamePattern,
                                                      java.lang.String ownerNamePattern,
                                                      java.lang.String itemNamePattern)
                                               throws java.lang.Exception
    Throws:
    java.lang.Exception

    notificationGetNotifications

    public org.apache.axiom.om.OMElement notificationGetNotifications(java.lang.String sessionID)
                                                               throws java.lang.Exception
    Throws:
    java.lang.Exception

    notificationRemoveAllMessages

    public java.lang.String notificationRemoveAllMessages(java.lang.String sessionID)
                                                   throws java.lang.Exception
    Throws:
    java.lang.Exception

    getVisibleFiles

    public org.apache.axiom.om.OMElement getVisibleFiles(java.lang.String sessionID)
                                                  throws java.lang.Exception
    Throws:
    java.lang.Exception

    getFileDetails

    public org.apache.axiom.om.OMElement getFileDetails(java.lang.String sessionID,
                                                        java.lang.String fileID)
                                                 throws java.lang.Exception
    Throws:
    java.lang.Exception

    startBatch

    public java.lang.String startBatch(java.lang.String sessionID)
                                throws java.lang.Exception
    Throws:
    java.lang.Exception

    endBatchAndCommit

    public java.lang.String endBatchAndCommit(java.lang.String sessionID)
                                       throws java.lang.Exception
    Throws:
    java.lang.Exception

    endBatchAndRollback

    public java.lang.String endBatchAndRollback(java.lang.String sessionID)
                                         throws java.lang.Exception
    Throws:
    java.lang.Exception

    findItems

    public org.apache.axiom.om.OMElement findItems(java.lang.String sessionID,
                                                   java.lang.String searchString,
                                                   java.lang.String searchOptions)
                                            throws java.lang.Exception
    Throws:
    java.lang.Exception

    searchItems

    public java.lang.String[] searchItems(java.lang.String sessionID,
                                          java.lang.String itemTypeName,
                                          java.lang.String searchXML)
                                   throws java.lang.Exception
    Throws:
    java.lang.Exception

    describeSchemaItemType

    public org.apache.axiom.om.OMElement describeSchemaItemType(java.lang.String sessionID,
                                                                java.lang.String itemType)
                                                         throws java.lang.Exception
    Throws:
    java.lang.Exception

    getItemTypes

    public java.lang.String[] getItemTypes(java.lang.String sessionID)
                                    throws java.lang.Exception
    Throws:
    java.lang.Exception

    getRootItemTypes

    public java.lang.String[] getRootItemTypes(java.lang.String sessionID)
                                        throws java.lang.Exception
    Throws:
    java.lang.Exception

    getItemTypeLinks

    public java.lang.String[] getItemTypeLinks(java.lang.String sessionID,
                                               java.lang.String itemType)
                                        throws java.lang.Exception
    Throws:
    java.lang.Exception

    getSchemaWithLayout

    public byte[] getSchemaWithLayout(java.lang.String sessionID,
                                      java.lang.String layoutMethod,
                                      java.lang.String outputFormat,
                                      java.lang.String layoutArguments)
                               throws java.lang.Exception
    Throws:
    java.lang.Exception

    getUserProperty

    public java.lang.String getUserProperty(java.lang.String sessionID,
                                            java.lang.String propertyName)
                                     throws java.lang.Exception
    Throws:
    java.lang.Exception

    setUserProperty

    public java.lang.String setUserProperty(java.lang.String sessionID,
                                            java.lang.String propertyName,
                                            java.lang.String propertyValue)
                                     throws java.lang.Exception
    Throws:
    java.lang.Exception