Package com.priint.pubserver.comet.bridge

Interface CometBridgeRemote

  • public interface CometBridgeRemote
    Remote interface to access the comet bridge bean from external JVM.

    This is intended for testing purposes only and maybe removed or changed without notice.

    For all normal work please use CometBridgeLocal interface instead.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String JNDINAME
      JNDI name for the remote interface
      static java.lang.String MAPPED_NAME
      The mapped name of the CometBridge Plugin
      static java.lang.String SESSION_PREFIX
      The constant SESSION_PREFIX.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> call​(java.lang.String sessionId, java.lang.String method, java.lang.String arguments)
      Call a method on the server and retrieve a list of string values in return.
      void deletePageTemplate​(java.lang.String sessionId, int pageTemplateId)
      Delete a page template
      java.util.List<Product> findProducts​(java.lang.String sessionId, int statementId, java.lang.String searchValue1, java.lang.String searchValue2, java.lang.String searchValue3, java.lang.String searchValue4)
      Find products using a find statements and 1 ..
      Actions getActions​(java.lang.String sessionId)
      Gets actions.
      byte[] getBinaryData​(java.lang.String sessionId, ConfigurationData.FileID fileId, int id)
      Get binary data byte [ ].
      java.util.List<Product> getChildBuckets​(java.lang.String sessionId, java.lang.String productStringId, java.lang.String searchString)
      Get children of a bucket.
      productStringId is the compound ID used in the Comet3 context, in other words: just the value you get from the parent product by calling product.getStringId();
      Colors getColors​(java.lang.String sessionId)
      Gets colors.
      ConditionMenues getConditionMenues​(java.lang.String sessionId)
      Gets condition menues.
      Conditions getConditions​(java.lang.String sessionId)
      Gets conditions.
      DataFiles getDataFiles​(java.lang.String sessionId)
      Gets data files.
      Domains getDomains​(java.lang.String sessionId)
      Gets domains.
      byte[] getEntityIcon​(java.lang.String sessionId, java.lang.String fileId)
      Get entity icon byte [ ].
      FindStatements getFindStatements​(java.lang.String sessionId)
      Gets find statements.
      FrameRules getFrameRules​(java.lang.String sessionId)
      Gets frame rules.
      Grids getGrids​(java.lang.String sessionId)
      Gets grids.
      GridTypes getGridTypes​(java.lang.String sessionId)
      Gets grid types.
      java.util.List<Row> getList​(java.lang.String sessionId, java.lang.String method, java.lang.String arguments)
      Call a method on the server an retrieve a list of string-lists in return (e.g.
      Messages getMessages​(java.lang.String sessionId, java.lang.String locale)
      Get messages / translations for this comet project.
      Currently there is no support for user defined tranlations, so this method just returns an empty (beside of the root element) XML document.
      byte[] getPageItemData​(java.lang.String sessionId, int pageItemId)
      Get binary (i.e.
      byte[] getPageItemIDML​(java.lang.String sessionId, int pageItemId)
      Get IDML data of a page item (aka "Template").
      Calling this method is equivalent to CometBridgeRemote.getBinaryData(sessionId, ConfigurationData.FileID.PAGEITEM_IDML, pageItemId);
      byte[] getPageItemMarkup​(java.lang.String sessionId, int pageItemId)
      Get markup (i.e.
      byte[] getPageItemPreview​(java.lang.String sessionId, int pageItemId)
      Get preview (i.e.
      PageItems getPageItems​(java.lang.String sessionId)
      Gets page items.
      byte[] getPageItemShapes​(java.lang.String sessionId, int pageItemId)
      Get shapes of a page item (aka "Template").
      Calling this method is equivalent to CometBridgeRemote.getBinaryData(sessionId, ConfigurationData.FileID.PAGEITEM_SHAPES, pageItemId);
      PageItemStates getPageItemStates​(java.lang.String sessionId)
      Gets page item states.
      PageItemTypes getPageItemTypes​(java.lang.String sessionId)
      Gets page item types.
      byte[] getPageTemplateData​(java.lang.String sessionId, int pageTemplateId)
      Get binary (i.e.
      byte[] getPageTemplatePreview​(java.lang.String sessionId, int pageTemplateId)
      Get preview (i.e.
      PageTemplates getPageTemplates​(java.lang.String sessionId)
      Gets page templates.
      PanelStatements getPanelStatements​(java.lang.String sessionId)
      Gets panel statements.
      PlaceholderGroups getPlaceholderGroups​(java.lang.String sessionId)
      Gets placeholder groups.
      Placeholders getPlaceholders​(java.lang.String sessionId)
      Gets placeholders.
      byte[] getPluginLibrary​(java.lang.String sessionId, java.lang.String pluginName)
      Get plugin library byte [ ].
      PreviewStatements getPreviewStatements​(java.lang.String sessionId)
      Gets preview statements.
      CometProductPanelConfig getProductPanelConfig​(java.lang.String sessionId)
      Get the configuration for the product panel
      RelatedTos getRelatedTos​(java.lang.String sessionId)
      Gets related tos.
      java.util.List<Product> getRootBuckets​(java.lang.String sessionId, java.lang.String searchString)
      Get the root buckets from the data source of the current comet project.
      Calling this method requires a valid Comet Bridge session, i.e.: you must login using CometBridgeRemote.login or CometBridgeRemote.loginWithSession before.
      byte[] getScriptLibrary​(java.lang.String sessionId, java.lang.String libraryName)
      Get the cscript library with the given name.
      These are "actions" (speaking in Comet3 terms), which can be included in other scripts using this scheme: #include "[pubserver]/libraryName.h"
      java.lang.Object getSessionAttribute​(java.lang.String sessionId, java.lang.String key)
      Get the session attribute
      CometBridgeRemote.SessionMode getSessionMode​(java.lang.String sessionId)
      Get the mode for this session.
      org.apache.shiro.subject.Subject getShiroSubject​(java.lang.String sessionID)
      Returns shiro subject
      XEntities getXEntities​(java.lang.String sessionId)
      Gets x entities.
      XIndexes getXIndexes​(java.lang.String sessionId)
      Gets x indexes.
      java.lang.String login​(java.lang.String login, java.lang.String passwd, java.lang.String configurationName, java.lang.String language)
      login (i.e.
      void logout​(java.lang.String sessionId)
      logout (i.e.
      void processTocUpdate​(java.lang.String sessionId, CometTocUpdate toc)
      Process a "table of contents" update.
      All data required to process this update is encapsulated in the toc object, such as document name, path, publication ID, the actual toc entries, scope of this command etc.
      See CometTocUpdate for more information.
      Usually this method is only called from rendering clients (such as InDesign / Comet or the pdf renderer) while generating or analyzing documents
      void resetApplication​(java.lang.String sessionId)
      Reset the application
      void savePageItemPreview​(java.lang.String sessionId, int pageTemplateId, byte[] data)
      Save preview (i.e.
      int savePageTemplate​(java.lang.String sessionId, PageTemplate pageTemplate)
      Save a PageTemplate.
      Depending on the pageTemplate data, this method either updates an existing page template, if the ID of this template is defined and denote an existing / valid page template creates a new page template, if the ID is 0 or does not denote a page template In the latter case, the ID of the newly created page template is returned.
      void savePageTemplateData​(java.lang.String sessionId, int pageTemplateId, byte[] data)
      Save binary (i.e.
      void savePageTemplatePreview​(java.lang.String sessionId, int pageTemplateId, byte[] data)
      Save preview (i.e.
      void setActions​(java.lang.String sessionId, Actions actions)
      Sets actions.
      void setBinaryData​(java.lang.String sessionId, ConfigurationData.FileID fileId, int id, byte[] data)
      Sets binary data.
      void setColors​(java.lang.String sessionId, Colors colors)
      Sets colors.
      void setConditionMenues​(java.lang.String sessionId, ConditionMenues menues)
      Sets condition menues.
      void setConditions​(java.lang.String sessionId, Conditions conditions)
      Sets conditions.
      void setDataFiles​(java.lang.String sessionId, DataFiles datafiles)
      Sets data files.
      void setDomains​(java.lang.String sessionId, Domains domains)
      Sets domains.
      void setFindStatements​(java.lang.String sessionId, FindStatements findStatements)
      Sets find statements.
      void setFrameRules​(java.lang.String sessionId, FrameRules frameRules)
      Sets frame rules.
      void setGrids​(java.lang.String sessionId, Grids grids)
      Sets grids.
      void setGridTypes​(java.lang.String sessionId, GridTypes gridTypes)
      Sets grid types.
      void setPageItems​(java.lang.String sessionId, PageItems pageItems)
      Sets page items.
      void setPageItemStates​(java.lang.String sessionId, PageItemStates pageItemStates)
      Sets page item states.
      void setPageItemTypes​(java.lang.String sessionId, PageItemTypes pageItemTypes)
      Sets page item types.
      void setPageTemplates​(java.lang.String sessionId, PageTemplates pageTemplates)
      Sets page templates.
      void setPanelStatements​(java.lang.String sessionId, PanelStatements panelstatements)
      Sets panel statements.
      void setPlaceholderGroups​(java.lang.String sessionId, PlaceholderGroups groups)
      Sets placeholder groups.
      void setPlaceholders​(java.lang.String sessionId, Placeholders placeholders)
      Sets placeholders.
      void setPreviewStatements​(java.lang.String sessionId, PreviewStatements previewStatements)
      Sets preview statements.
      void setRelatedTos​(java.lang.String sessionId, RelatedTos relatedTos)
      Sets related tos.
      void setSessionAttribute​(java.lang.String sessionId, java.lang.String key, java.lang.Object object)
      Set the session attribute
      void setSessionMode​(java.lang.String sessionId, CometBridgeRemote.SessionMode mode)
      Set the mode for this session.
      void setXEntities​(java.lang.String sessionId, XEntities xentities)
      Sets x entities.
      void setXIndexes​(java.lang.String sessionId, XIndexes xindexes)
      Sets x indexes.