Package com.priint.pubserver.comet.bridge

Interface CometBridgeLocal

public interface CometBridgeLocal

The interface Comet bridge local.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	getInclude	The constant getInclude.
static final String	getJavaPluginHeaders	The constant getJavaPluginHeaders.
static final String	getJavaPluginIncludes	The constant getJavaPluginIncludes.
static final String	getLibraryIncludes	The constant getLibraryIncludes.
static final String	includeExists	The constant includeExists.
static final String	JNDINAME	JNDI name of the local interface
static final String	MAPPED_NAME	The mapped name of the CometBridge Plugin
static final String	setSessionClient	The constant setSessionClient.
static final String	setSessionProject	The constant setSessionProject.

Method Summary

Modifier and Type	Method	Description
List<String>	call(String method, String arguments)	Call a method on the server and retrieve a list of string values in return.
String	createAnonymousSession(String name, long maxIdleTimeInMillis)	Create a new and anonymous session
void	deletePageTemplate(int pageTemplateId)	Delete a page template
List<Product>	findProducts(int statementId, String searchValue1, String searchValue2, String searchValue3, String searchValue4)	Deprecated. Replaced by findProducts(int, String, String, String, String, String)
List<Product>	findProducts(int statementId, String searchValue1, String searchValue2, String searchValue3, String searchValue4, String documentID)	Find products using a find statements and 1 ..
Actions	getActions()	Gets actions.
byte[]	getAllCScriptHeaders()	Get all c script headers byte [ ].
byte[]	getAllCScriptIncludes()	Get all c script includes byte [ ].
List<CometSearchMethod>	getAvailableSearchMethods(String client, String projectIdentifier)	Gets available search methods.
byte[]	getBinaryData(ConfigurationData.FileID fileId, int id)	Get binary data byte [ ].
List<Product>	getChildBuckets(String productStringId, 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()	Gets colors.
ConditionMenues	getConditionMenues()	Gets condition menues.
Conditions	getConditions()	Gets conditions.
DataFiles	getDataFiles()	Gets data files.
Domains	getDomains()	Gets domains.
byte[]	getEntityIcon(String fileId)	Get entity icon byte [ ].
EntityResultFilter	getEntityResultFilter()	Gets entity result filter.
FindStatements	getFindStatements()	Gets find statements.
FontDataBase	getFontDataBase()	Gets font data base.
FrameRules	getFrameRules()	Gets frame rules.
Grids	getGrids()	Gets grids.
GridTypes	getGridTypes()	Gets grid types.
byte[]	getInclude(String includePath)	Get include byte [ ].
List<String>	getJavaPluginHeaders()	Gets java plugin headers.
List<String>	getJavaPluginIncludes()	Gets java plugin includes.
List<String>	getLibraryIncludes()	Gets library includes.
int	getLinkScriptId(String scriptName)	Gets the ID of a CometPreviewLinkScript by it's name.
List<Row>	getList(String method, String arguments)	Call a method on the server an retrieve a list of string-lists in return (e.g.
Manifest	getManifest()	Gets general information for this comet project.
Messages	getMessages(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.
List<ContentMetaData>	getMetadataOfPageTemplate(int pageTemplateId)	Get metadata for page template that are stored in /pagetemplate/metadata in repository.
List<ContentMetaData>	getMetadataOfPageTemplateElement(int uid, int pageTemplateId)	Get metadata for page template element that are stored in /pagetemplate/metadata in repository.
byte[]	getPageItemData(int pageItemId)	Get binary (i.e.
byte[]	getPageItemDocumentMetadata(int pageItemId)	Get document metadata (i.e.
byte[]	getPageItemIDML(int pageItemId)	Get IDML data of a page item (aka "Template"). Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_IDML, pageItemId);
byte[]	getPageItemMarkup(int pageItemId)	Get markup (i.e.
byte[]	getPageItemPreview(int pageItemId)	Get preview (i.e.
PageItems	getPageItems()	Gets page items.
byte[]	getPageItemShapes(int pageItemId)	Get shapes of a page item (aka "Template"). Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_SHAPES, pageItemId);
PageItemStates	getPageItemStates()	Gets page item states.
PageItemTypes	getPageItemTypes()	Gets page item types.
byte[]	getPageTemplateData(int pageTemplateId)	Get binary (i.e.
byte[]	getPageTemplateDocumentMetadata(int pageTemplateId)	Get document metadata (i.e.
byte[]	getPageTemplatePreview(int pageTemplateId)	Get preview (i.e.
PageTemplates	getPageTemplates()	Gets page templates.
PanelStatements	getPanelStatements()	Gets panel statements.
PlaceholderGroups	getPlaceholderGroups()	Gets placeholder groups.
Placeholders	getPlaceholders()	Gets placeholders.
PlaceholderVariants	getPlaceholderVariants()	Gets the placeholder variants configuration
byte[]	getPluginCScriptHeader(String pluginName)	Get plugin c script header byte [ ].
byte[]	getPluginCScriptLibrary(String pluginName)	Get plugin cscript client stub.
byte[]	getPluginCScriptLibrary(String pluginName, ConfigurationData.FileID fileID)	Get plugin cscript or python client stub.
PreviewStatements	getPreviewStatements()	Gets preview statements.
ProductDataMapping	getProductDataMapping()	Gets product data mapping.
CometProductPanelConfig	getProductPanelConfig()	Get the configuration for the product panel
String	getProjectClientName(String sessionID, String projectIdentifier)	Gets project client name.
String	getProjectModelIdentifier(String sessionID, String projectIdentifier)	Gets project model identifier.
RelatedTos	getRelatedTos()	Gets related tos.
List<Product>	getRootBuckets(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.
int	getScriptIdByName(String scriptName, Class<? extends CometScript> scriptClass)	Gets the ID of a script by it's class and name (label).
byte[]	getScriptLibrary(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"
Object	getSessionAttribute(String key)	Get the session attribute
CometBridgeRemote.SessionMode	getSessionMode()	Get the mode for this session.
org.apache.shiro.subject.Subject	getShiroSubject(String sessionId)	Returns shiro subject
TranslationsUnit	getTranslations()	Gets translations for the current session
String	getUiFallbackLanguage()	Gets ui fallback language.
XEntities	getXEntities()	Gets x entities.
XIndexes	getXIndexes()	Gets x indexes.
boolean	includeExists(String includePath)	Include exists boolean.
String	login(String login, String passwd, String configurationName, String language)	login (i.e.
String	loginFromPriintSuite(String login, String passwd, String configurationName, String language)	login (i.e.
String	loginFromRemote(String login, String passwd, String projectIdentifier, String language)	Login from remote string.
String	loginLocalFromPriintSuite(String login, String token, String projectIdentifier, String language)	Login local from priint suite string.
Map<String,String>	loginWithSession(String sessionId)	Login using a session ID
void	logout()	logout (i.e.
void	processTocUpdate(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
byte[]	readSnippetData(String fileId)	Read snippet data byte [ ].
byte[]	readSnippetPreview(String fileId)	Read snippet preview byte [ ].
byte[]	readSnippetPreviewById(int snippetId)	Read snippet preview by id byte [ ].
void	resetApplication()	Reset the application
void	savePageItemPreview(int pageTemplateId, byte[] data)	Save preview (i.e.
int	savePageTemplate(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(int pageTemplateId, byte[] data)	Save binary (i.e.
void	savePageTemplatePreview(int pageTemplateId, byte[] data)	Save preview (i.e.
void	setActions(Actions actions)	Sets actions.
void	setBinaryData(ConfigurationData.FileID fileId, int id, byte[] data)	Sets binary data.
void	setColors(Colors colors)	Sets colors.
void	setConditionMenues(ConditionMenues menues)	Sets condition menues.
void	setConditions(Conditions conditions)	Sets conditions.
void	setDataFiles(DataFiles datafiles)	Sets data files.
void	setDomains(Domains domains)	Sets domains.
void	setFindStatements(FindStatements findStatements)	Sets find statements.
void	setFrameRules(FrameRules frameRules)	Sets frame rules.
void	setGrids(Grids grids)	Sets grids.
void	setGridTypes(GridTypes gridTypes)	Sets grid types.
void	setPageItems(PageItems pageItems)	Sets page items.
void	setPageItemStates(PageItemStates pageItemStates)	Sets page item states.
void	setPageItemTypes(PageItemTypes pageItemTypes)	Sets page item types.
void	setPageTemplates(PageTemplates pageTemplates)	Sets page templates.
void	setPanelStatements(PanelStatements panelstatements)	Sets panel statements.
void	setPlaceholderGroups(PlaceholderGroups groups)	Sets placeholder groups.
void	setPlaceholders(Placeholders placeholders)	Sets placeholders.
void	setPlaceholderVariants(PlaceholderVariants variants)	Sets (persists) the placeholder variants configuration
void	setPreviewStatements(PreviewStatements previewStatements)	Sets preview statements.
void	setRelatedTos(RelatedTos relatedTos)	Sets related tos.
void	setSessionAttribute(String key, Object object)	Set the session attribute
void	setSessionClient(String client)	Sets session client.
void	setSessionMode(CometBridgeRemote.SessionMode mode)	Set the mode for this session.
void	setSessionMode(String sessionId, CometBridgeRemote.SessionMode mode)	Sets session mode.
void	setSessionProject(String projectIdentifier)	Sets session project.
void	setSessionProperties(String sessionId, String login, String passwd, String projectIdentifier, String language, boolean initSessionInfo)	Sets session properties.
void	setXEntities(XEntities xentities)	Sets x entities.
void	setXIndexes(XIndexes xindexes)	Sets x indexes.
void	validateUser(String sessionId, String login, String projectIdentifier)	Checks whether the user is assigned to the project.

Field Details

JNDINAME

static final String JNDINAME

JNDI name of the local interface

Usually you acquire an instance of the local bean via the Plugin manager.
If for any reason you want to access the CometBridge via JNDI lookup, use this name for the InitialContext.lookup call.

See Also:

• Constant Field Values

MAPPED_NAME

static final String MAPPED_NAME

The mapped name of the CometBridge Plugin

Use this name when requesting a Plugin instance from the PluginManager

See Also:

• Constant Field Values

getInclude

static final String getInclude

The constant getInclude.

See Also:

• Constant Field Values

getJavaPluginIncludes

static final String getJavaPluginIncludes

The constant getJavaPluginIncludes.

See Also:

• Constant Field Values

getLibraryIncludes

static final String getLibraryIncludes

The constant getLibraryIncludes.

See Also:

• Constant Field Values

getJavaPluginHeaders

static final String getJavaPluginHeaders

The constant getJavaPluginHeaders.

See Also:

• Constant Field Values

setSessionProject

static final String setSessionProject

The constant setSessionProject.

See Also:

• Constant Field Values

setSessionClient

static final String setSessionClient

The constant setSessionClient.

See Also:

• Constant Field Values

includeExists

static final String includeExists

The constant includeExists.

See Also:

• Constant Field Values

Method Details

createAnonymousSession

String createAnonymousSession(String name,
 long maxIdleTimeInMillis)
                       throws CometException

Create a new and anonymous session

Parameters:

name - - login name

maxIdleTimeInMillis - new session will expire after this time

Returns:

session id of anonymous session

Throws:

CometException - the comet exception

loginFromPriintSuite

String loginFromPriintSuite(String login,
 String passwd,
 String configurationName,
 String language)
                     throws CometException

login (i.e. start a session).

Parameters:

login - the login

passwd - the passwd

configurationName - name of the configuration, such as "demo"

language - language, TODO: specify language codes

Returns:

new session id

Throws:

CometException - the comet exception

loginWithSession

Map<String,String> loginWithSession(String sessionId)
                             throws CometException

Login using a session ID

The method returns a Map containing all relevant properties defined for this sessions, i.e.

• login name
• which comet project is this session connected to
• ... etc.

Parameters:

sessionId - the session id

Returns:

Map containing all relevant session properties

Throws:

CometException - the comet exception

call

List<String> call(String method,
 String arguments)
           throws CometException,
InvalidSessionException

Call a method on the server and retrieve a list of string values in return. Typically this method is called for simple placeholder operations (such as load, sync, store...)

Parameters:

method - the method

arguments - the arguments

Returns:

list of strings processed by this command

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

deletePageTemplate

void deletePageTemplate(int pageTemplateId)
                 throws CometException,
InvalidSessionException

Delete a page template

Parameters:

pageTemplateId - the page template id

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

findProducts

@Deprecated
List<Product> findProducts(int statementId,
 String searchValue1,
 String searchValue2,
 String searchValue3,
 String searchValue4)
                    throws CometException,
InvalidSessionException

Deprecated.

Replaced by findProducts(int, String, String, String, String, String)

Find products using a find statements and 1 .. 4 search values.

Find statements must have been fetched from CometBridge using the getFindStatements() method before.
Clients are not supposed to cache or store find statements across several sessions, because they are generated dynamically on Runtime and the statementId may change after reconnecting.

Parameters:

statementId - the statement id

searchValue1 - the search value 1

searchValue2 - the search value 2

searchValue3 - the search value 3

searchValue4 - the search value 4

Returns:

list of products matching the given search criteria

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

findProducts

List<Product> findProducts(int statementId,
 String searchValue1,
 String searchValue2,
 String searchValue3,
 String searchValue4,
 String documentID)
                    throws CometException,
InvalidSessionException

Find products using a find statements and 1 .. 4 search values.

Find statements must have been fetched from CometBridge using the getFindStatements() method before.
Clients are not supposed to cache or store find statements across several sessions, because they are generated dynamically on Runtime and the statementId may change after reconnecting.

Parameters:

statementId - the statement id

searchValue1 - the search value 1

searchValue2 - the search value 2

searchValue3 - the search value 3

searchValue4 - the search value 4

documentID - the document id

Returns:

list of products matching the given search criteria

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getActions

Actions getActions()
            throws CometException,
InvalidSessionException

Gets actions.

Returns:

list of actions configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getBinaryData

byte[] getBinaryData(ConfigurationData.FileID fileId,
 int id)
              throws CometException,
InvalidSessionException

Get binary data byte [ ].

Parameters:

fileId - the file id

id - the id

Returns:

binary data with the given fileId (i.e. file type) and item id

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getChildBuckets

List<Product> getChildBuckets(String productStringId,
 String searchString)
                       throws CometException,
InvalidSessionException

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();

Parameters:

productStringId - the product string id

searchString - the search string

Returns:

child buckets of a bucket referred by productStringId

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getColors

Colors getColors()
          throws CometException,
InvalidSessionException

Gets colors.

Returns:

colors configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getConditionMenues

ConditionMenues getConditionMenues()
                            throws CometException,
InvalidSessionException

Gets condition menues.

Returns:

list of condition menues conofigured on this server

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getConditions

Conditions getConditions()
                  throws CometException,
InvalidSessionException

Gets conditions.

Returns:

list of conditions configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getDataFiles

DataFiles getDataFiles()
                throws CometException,
InvalidSessionException

Gets data files.

Returns:

list of data files (i.e. file aliases)

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getDomains

Domains getDomains()
            throws CometException,
InvalidSessionException

Gets domains.

Returns:

domains configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getEntityIcon

byte[] getEntityIcon(String fileId)
              throws InvalidSessionException,
CometException

Get entity icon byte [ ].

Parameters:

fileId - the file id

Returns:

icon data

Throws:

InvalidSessionException - the invalid session exception

CometException - the comet exception

getFindStatements

FindStatements getFindStatements()
                          throws CometException,
InvalidSessionException

Gets find statements.

Returns:

list of find statements configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getFontDataBase

FontDataBase getFontDataBase()
                      throws CometException,
InvalidSessionException

Gets font data base.

Returns:

the font database configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getFrameRules

FrameRules getFrameRules()
                  throws CometException,
InvalidSessionException

Gets frame rules.

Returns:

list of frame rules configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getGrids

Grids getGrids()
        throws CometException,
InvalidSessionException

Gets grids.

Returns:

list of grids configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getGridTypes

GridTypes getGridTypes()
                throws CometException,
InvalidSessionException

Gets grid types.

Returns:

list of grid types configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getList

List<Row> getList(String method,
 String arguments)
           throws CometException,
InvalidSessionException

Call a method on the server an retrieve a list of string-lists in return (e.g. tabular data). This method is used for complex operations (product or publication hierarchy) or to get structured data of any kind in one go.

Parameters:

method - qualified Java class and method name, e.g. com.priint.

arguments - the arguments

Returns:

list of rows processed by this command

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getManifest

Manifest getManifest()
              throws CometException,
InvalidSessionException

Gets general information for this comet project.

The manifest document contains general information for the current session's comet project, such as name, identifier and last configuration change.

Returns:

project Manifest document

Throws:

CometException

InvalidSessionException

getMessages

Messages getMessages(String locale)
              throws CometException,
InvalidSessionException

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.

Parameters:

locale - the locale

Returns:

list of messages / translations available on this server

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemData

byte[] getPageItemData(int pageItemId)
                throws CometException,
InvalidSessionException

Get binary (i.e. INDD) data of a page item (aka "Template").
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_DATA, pageItemId);

Parameters:

pageItemId - the page item id

Returns:

INDD document of this pageitem (i.e. template) or null, if no document exists for this template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemIDML

byte[] getPageItemIDML(int pageItemId)
                throws CometException,
InvalidSessionException

Get IDML data of a page item (aka "Template").
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_IDML, pageItemId);

Parameters:

pageItemId - the page item id

Returns:

IDML document of this pageitem (i.e. template) or null, if no IDML exists for this template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemMarkup

byte[] getPageItemMarkup(int pageItemId)
                  throws CometException,
InvalidSessionException

Get markup (i.e. Werk II XML) of a page item (aka "Template").
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_MARKUP, pageItemId);

Parameters:

pageItemId - the page item id

Returns:

w2ml document of this page item (i.e. template) or null, if no w2ml document exists for this template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemPreview

byte[] getPageItemPreview(int pageItemId)
                   throws CometException,
InvalidSessionException

Get preview (i.e. JPEG image) of a page item (aka "Template").
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_PREVIEW, pageItemId);

Parameters:

pageItemId - the page item id

Returns:

preview of this pageitem (i.e. template) or null, if no preview exists for this template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemDocumentMetadata

byte[] getPageItemDocumentMetadata(int pageItemId)
                            throws CometException,
InvalidSessionException

Get document metadata (i.e. zipped folder) of a page item (aka "Template").
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_METADATA, pageItemId);

Parameters:

pageItemId - the page item id

Returns:

document metadata of this pageitem (i.e. template) as zipped folder or null, if no document metadata exists for this template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItems

PageItems getPageItems()
                throws CometException,
InvalidSessionException

Gets page items.

Returns:

list of page items (i.e. templates) configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemShapes

byte[] getPageItemShapes(int pageItemId)
                  throws CometException,
InvalidSessionException

Get shapes of a page item (aka "Template").
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGEITEM_SHAPES, pageItemId);

Parameters:

pageItemId - the page item id

Returns:

shapes of this pageitem (i.e. template) or null, if no shapes exist for this template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemStates

PageItemStates getPageItemStates()
                          throws CometException,
InvalidSessionException

Gets page item states.

Returns:

list of page item states configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageItemTypes

PageItemTypes getPageItemTypes()
                        throws CometException,
InvalidSessionException

Gets page item types.

Returns:

list of page item types configured on this server in the current project context

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageTemplateData

byte[] getPageTemplateData(int pageTemplateId)
                    throws CometException,
InvalidSessionException

Get binary (i.e. INDD) data of a page template.
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGETEMPLATE_DATA, pageTemplateId);

Parameters:

pageTemplateId - the page template id

Returns:

pagetemplate document data or null, if no document data exists for this pagetemplate

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageTemplatePreview

byte[] getPageTemplatePreview(int pageTemplateId)
                       throws CometException,
InvalidSessionException

Get preview (i.e. JPEG image) of a page template.
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGETEMPLATE_PREVIEW, pageTemplateId);

Parameters:

pageTemplateId - the page template id

Returns:

pagetemplate preview or null, if no preview exists for this pagetemplate

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageTemplateDocumentMetadata

byte[] getPageTemplateDocumentMetadata(int pageTemplateId)
                                throws CometException,
InvalidSessionException

Get document metadata (i.e. zipped folder) of a page template.
Calling this method is equivalent to CometBridgeRemote.getBinaryData(ConfigurationData.FileID.PAGETEMPLATE_METADATA, pageTemplateId);

Parameters:

pageTemplateId - the page template id

Returns:

pagetemplate document metadata as zipped folder or null, if no document metadata exists for this pagetemplate

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPageTemplates

PageTemplates getPageTemplates()
                        throws CometException,
InvalidSessionException

Gets page templates.

Returns:

page templates

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getMetadataOfPageTemplate

List<ContentMetaData> getMetadataOfPageTemplate(int pageTemplateId)
                                         throws CometException

Get metadata for page template that are stored in /pagetemplate/metadata in repository.

Parameters:

pageTemplateId - ID of the page template

Returns:

list of ContentMetaData

Throws:

CometException - the comet exception

getMetadataOfPageTemplateElement

List<ContentMetaData> getMetadataOfPageTemplateElement(int uid,
 int pageTemplateId)
                                                throws CometException

Get metadata for page template element that are stored in /pagetemplate/metadata in repository.

Parameters:

uid - uid of element

pageTemplateId - ID of the page template

Returns:

list of ContentMetaData

Throws:

CometException - the comet exception

getPanelStatements

PanelStatements getPanelStatements()
                            throws CometException,
InvalidSessionException

Gets panel statements.

Returns:

panel statements

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPlaceholderGroups

PlaceholderGroups getPlaceholderGroups()
                                throws CometException,
InvalidSessionException

Gets placeholder groups.

Returns:

placeholder groups

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPlaceholderVariants

PlaceholderVariants getPlaceholderVariants()
                                    throws CometException,
InvalidSessionException

Gets the placeholder variants configuration

Returns:

list of placeholder variants

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPlaceholders

Placeholders getPlaceholders()
                      throws CometException,
InvalidSessionException

Gets placeholders.

Returns:

placeholders

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPreviewStatements

PreviewStatements getPreviewStatements()
                                throws CometException,
InvalidSessionException

Gets preview statements.

Returns:

preview statements

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getProductPanelConfig

CometProductPanelConfig getProductPanelConfig()
                                       throws CometException,
InvalidSessionException

Get the configuration for the product panel

Returns:

product panel config

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getRelatedTos

RelatedTos getRelatedTos()
                  throws CometException,
InvalidSessionException

Gets related tos.

Returns:

related tos

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getRootBuckets

List<Product> getRootBuckets(String searchString)
                      throws CometException,
InvalidSessionException

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.

Parameters:

searchString - the search string

Returns:

root buckets

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getScriptLibrary

byte[] getScriptLibrary(String libraryName)
                 throws CometException,
InvalidSessionException

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"

Parameters:

libraryName - the library name

Returns:

byte [ ]

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getSessionAttribute

Object getSessionAttribute(String key)
                    throws CometException,
InvalidSessionException

Get the session attribute

Parameters:

key - the key

Returns:

session attribute

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getSessionMode

CometBridgeRemote.SessionMode getSessionMode()
                                      throws CometException,
InvalidSessionException

Get the mode for this session.

Returns:

session mode

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getShiroSubject

org.apache.shiro.subject.Subject getShiroSubject(String sessionId)
                                          throws CometException,
InvalidSessionException

Returns shiro subject

Parameters:

sessionId - the session id

Returns:

shiro subject

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getXEntities

XEntities getXEntities()
                throws CometException,
InvalidSessionException

Gets x entities.

Returns:

x entities

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getXIndexes

XIndexes getXIndexes()
              throws CometException,
InvalidSessionException

Gets x indexes.

Returns:

x indexes

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

login

String login(String login,
 String passwd,
 String configurationName,
 String language)
      throws CometException

login (i.e. start a session).

Parameters:

login - the login

passwd - the passwd

configurationName - name of the configuration, such as "demo"

language - language,: specify language codes

Returns:

string

Throws:

CometException - the comet exception

logout

void logout()
     throws CometException,
InvalidSessionException

logout (i.e. close a session)

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

processTocUpdate

void processTocUpdate(CometTocUpdate toc)
               throws CometException,
InvalidSessionException

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

Parameters:

toc - the toc

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

resetApplication

void resetApplication()
               throws CometException,
InvalidSessionException

Reset the application

This method is mainly intended for testing purposes. In regular operation there should be no need to reset the application. All caches are cleared and startup procedures are executed.

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

savePageItemPreview

void savePageItemPreview(int pageTemplateId,
 byte[] data)
                  throws CometException,
InvalidSessionException

Save preview (i.e. JPEG image) of a page item (aka. "Template").
Calling this method is equivalent to CometBridgeRemote.setBinaryData(ConfigurationData.FileID.PAGEITEM_PREVIEW, pageTemplateId, data);

Parameters:

pageTemplateId - the page template id

data - the data

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

savePageTemplate

int savePageTemplate(PageTemplate pageTemplate)
              throws CometException,
InvalidSessionException

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.

Parameters:

pageTemplate - the page template

Returns:

ID of the newly created or updated page template

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

savePageTemplateData

void savePageTemplateData(int pageTemplateId,
 byte[] data)
                   throws CometException,
InvalidSessionException

Save binary (i.e. INDD) data of a page template.
Calling this method is equivalent to CometBridgeRemote.setBinaryData(ConfigurationData.FileID.PAGETEMPLATE_DATA, pageTemplateId, data);

Parameters:

pageTemplateId - the page template id

data - the data

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

savePageTemplatePreview

void savePageTemplatePreview(int pageTemplateId,
 byte[] data)
                      throws CometException,
InvalidSessionException

Save preview (i.e. JPEG image) of a page template.
Calling this method is equivalent to CometBridgeRemote.setBinaryData(ConfigurationData.FileID.PAGETEMPLATE_PREVIEW, pageTemplateId, data);

Parameters:

pageTemplateId - the page template id

data - the data

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setActions

void setActions(Actions actions)
         throws CometException,
InvalidSessionException

Sets actions.

Parameters:

actions - the actions

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setBinaryData

void setBinaryData(ConfigurationData.FileID fileId,
 int id,
 byte[] data)
            throws CometException,
InvalidSessionException

Sets binary data.

Parameters:

fileId - the file id

id - the id

data - the data

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setColors

void setColors(Colors colors)
        throws CometException,
InvalidSessionException

Sets colors.

Parameters:

colors - the colors

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setConditionMenues

void setConditionMenues(ConditionMenues menues)
                 throws CometException,
InvalidSessionException

Sets condition menues.

Parameters:

menues - the menues

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setConditions

void setConditions(Conditions conditions)
            throws CometException,
InvalidSessionException

Sets conditions.

Parameters:

conditions - the conditions

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setDataFiles

void setDataFiles(DataFiles datafiles)
           throws CometException,
InvalidSessionException

Sets data files.

Parameters:

datafiles - the datafiles

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setDomains

void setDomains(Domains domains)
         throws CometException,
InvalidSessionException

Sets domains.

Parameters:

domains - the domains

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setFindStatements

void setFindStatements(FindStatements findStatements)
                throws CometException,
InvalidSessionException

Sets find statements.

Parameters:

findStatements - the find statements

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setFrameRules

void setFrameRules(FrameRules frameRules)
            throws CometException,
InvalidSessionException

Sets frame rules.

Parameters:

frameRules - the frame rules

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setGrids

void setGrids(Grids grids)
       throws CometException,
InvalidSessionException

Sets grids.

Parameters:

grids - the grids

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setGridTypes

void setGridTypes(GridTypes gridTypes)
           throws CometException,
InvalidSessionException

Sets grid types.

Parameters:

gridTypes - the grid types

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPageItems

void setPageItems(PageItems pageItems)
           throws CometException,
InvalidSessionException

Sets page items.

Parameters:

pageItems - the page items

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPageItemStates

void setPageItemStates(PageItemStates pageItemStates)
                throws CometException,
InvalidSessionException

Sets page item states.

Parameters:

pageItemStates - the page item states

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPageItemTypes

void setPageItemTypes(PageItemTypes pageItemTypes)
               throws CometException,
InvalidSessionException

Sets page item types.

Parameters:

pageItemTypes - the page item types

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPageTemplates

void setPageTemplates(PageTemplates pageTemplates)
               throws CometException,
InvalidSessionException

Sets page templates.

Parameters:

pageTemplates - the page templates

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPanelStatements

void setPanelStatements(PanelStatements panelstatements)
                 throws CometException,
InvalidSessionException

Sets panel statements.

Parameters:

panelstatements - the panelstatements

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPlaceholderGroups

void setPlaceholderGroups(PlaceholderGroups groups)
                   throws CometException,
InvalidSessionException

Sets placeholder groups.

Parameters:

groups - the groups

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPlaceholderVariants

void setPlaceholderVariants(PlaceholderVariants variants)
                     throws CometException,
InvalidSessionException

Sets (persists) the placeholder variants configuration

Parameters:

variants - the variants to set

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPlaceholders

void setPlaceholders(Placeholders placeholders)
              throws CometException,
InvalidSessionException

Sets placeholders.

Parameters:

placeholders - the placeholders

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setPreviewStatements

void setPreviewStatements(PreviewStatements previewStatements)
                   throws CometException,
InvalidSessionException

Sets preview statements.

Parameters:

previewStatements - the preview statements

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setRelatedTos

void setRelatedTos(RelatedTos relatedTos)
            throws CometException,
InvalidSessionException

Sets related tos.

Parameters:

relatedTos - the related tos

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setSessionAttribute

void setSessionAttribute(String key,
 Object object)
                  throws CometException,
InvalidSessionException

Set the session attribute

Parameters:

key - the key

object - the object

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setSessionMode

void setSessionMode(CometBridgeRemote.SessionMode mode)
             throws CometException,
InvalidSessionException

Set the mode for this session. See description above for the different session modes.

Parameters:

mode - the mode

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setXEntities

void setXEntities(XEntities xentities)
           throws CometException,
InvalidSessionException

Sets x entities.

Parameters:

xentities - the xentities

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setXIndexes

void setXIndexes(XIndexes xindexes)
          throws CometException,
InvalidSessionException

Sets x indexes.

Parameters:

xindexes - the xindexes

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

loginFromRemote

String loginFromRemote(String login,
 String passwd,
 String projectIdentifier,
 String language)
                throws CometException

Login from remote string.

Parameters:

login - the login

passwd - the passwd

projectIdentifier - the project identifier

language - the language

Returns:

the string

Throws:

CometException - the comet exception

validateUser

void validateUser(String sessionId,
 String login,
 String projectIdentifier)
           throws CometException

Checks whether the user is assigned to the project. If not throws CometException

Parameters:

sessionId - the session id

login - the login

projectIdentifier - name of the configuration, such as "demo"

Throws:

CometException - the comet exception

setSessionProperties

void setSessionProperties(String sessionId,
 String login,
 String passwd,
 String projectIdentifier,
 String language,
 boolean initSessionInfo)
                   throws CometException,
InvalidSessionException

Sets session properties.

Parameters:

sessionId - the session id

login - the login

passwd - the passwd

projectIdentifier - the project identifier

language - the language

initSessionInfo - the init session info

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getScriptIdByName

int getScriptIdByName(String scriptName,
 Class<? extends CometScript> scriptClass)
               throws CometException,
InvalidSessionException

Gets the ID of a script by it's class and name (label).

Gets the ID of a script by it's class and name (label).
If such a script cannot be found, 0 is returned.

Parameters:

scriptName - the script name

scriptClass - the script class

Returns:

the script ID or 0, if such a script cannot be found.

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getLinkScriptId

int getLinkScriptId(String scriptName)
             throws CometException,
InvalidSessionException

Gets the ID of a CometPreviewLinkScript by it's name.

Gets the ID of a CometPreviewLinkScript by it's name.
This is equivalent for getScriptByName (scriptName, CometLinkScript.class);

Parameters:

scriptName - the script name

Returns:

the ID of this CometPreviewLinkScript or 0, if it cannot be found.

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPluginCScriptLibrary

byte[] getPluginCScriptLibrary(String pluginName)
                        throws CometException,
InvalidSessionException

Get plugin cscript client stub.

Parameters:

pluginName - the plugin name

Returns:

byte []

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPluginCScriptLibrary

byte[] getPluginCScriptLibrary(String pluginName,
 ConfigurationData.FileID fileID)
                        throws CometException,
InvalidSessionException

Get plugin cscript or python client stub. The generation style is determined from the fileID, e.g. for PLUGIN_LIBRARY, cscript stub code is generated, for PLUGIN_PYTHON_LIBRARY Python code is generated.

Parameters:

pluginName - the plugin name

fileID - the ID of the file, such as PLUGIN_LIBRARY, PLUGIN_PYTHON_LIBRARY

Returns:

byte []

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getPluginCScriptHeader

byte[] getPluginCScriptHeader(String pluginName)
                       throws CometException,
InvalidSessionException

Get plugin c script header byte [ ].

Parameters:

pluginName - the plugin name

Returns:

byte [ ]

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getAllCScriptIncludes

byte[] getAllCScriptIncludes()
                      throws CometException,
InvalidSessionException

Get all c script includes byte [ ].

Returns:

byte [ ]

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getAllCScriptHeaders

byte[] getAllCScriptHeaders()
                     throws CometException,
InvalidSessionException

Get all c script headers byte [ ].

Returns:

byte [ ]

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getProjectClientName

String getProjectClientName(String sessionID,
 String projectIdentifier)
                     throws CometException

Gets project client name.

Parameters:

sessionID - the session id

projectIdentifier - the project identifier

Returns:

the project client name

Throws:

CometException - the comet exception

getProjectModelIdentifier

String getProjectModelIdentifier(String sessionID,
 String projectIdentifier)
                          throws CometException

Gets project model identifier.

Parameters:

sessionID - the session id

projectIdentifier - the project identifier

Returns:

the project model identifier

Throws:

CometException - the comet exception

loginLocalFromPriintSuite

String loginLocalFromPriintSuite(String login,
 String token,
 String projectIdentifier,
 String language)
                          throws CometException

Login local from priint suite string.

Parameters:

login - the login

token - the token

projectIdentifier - the project identifier

language - the language

Returns:

the string

Throws:

CometException - the comet exception

setSessionMode

void setSessionMode(String sessionId,
 CometBridgeRemote.SessionMode mode)
             throws CometException,
InvalidSessionException

Sets session mode.

Parameters:

sessionId - the session id

mode - the mode

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getInclude

byte[] getInclude(String includePath)
           throws CometException,
InvalidSessionException

Get include byte [ ].

Parameters:

includePath - the include path

Returns:

the byte [ ]

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getJavaPluginIncludes

List<String> getJavaPluginIncludes()
                            throws CometException,
InvalidSessionException

Gets java plugin includes.

Returns:

the java plugin includes

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getLibraryIncludes

List<String> getLibraryIncludes()
                         throws CometException,
InvalidSessionException

Gets library includes.

Returns:

the library includes

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getJavaPluginHeaders

List<String> getJavaPluginHeaders()
                           throws CometException,
InvalidSessionException

Gets java plugin headers.

Returns:

the java plugin headers

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

setSessionProject

void setSessionProject(String projectIdentifier)
                throws InvalidSessionException

Sets session project.

Parameters:

projectIdentifier - the project identifier

Throws:

InvalidSessionException - the invalid session exception

setSessionClient

void setSessionClient(String client)
               throws InvalidSessionException

Sets session client.

Parameters:

client - the client

Throws:

InvalidSessionException - the invalid session exception

includeExists

boolean includeExists(String includePath)
               throws CometException,
InvalidSessionException

Include exists boolean.

Parameters:

includePath - the include path

Returns:

the boolean

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getProductDataMapping

ProductDataMapping getProductDataMapping()
                                  throws CometException,
InvalidSessionException

Gets product data mapping.

Returns:

the product data mapping

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getEntityResultFilter

EntityResultFilter getEntityResultFilter()
                                  throws CometException,
InvalidSessionException

Gets entity result filter.

Returns:

the entity result filter

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getAvailableSearchMethods

List<CometSearchMethod> getAvailableSearchMethods(String client,
 String projectIdentifier)
                                           throws CometException,
InvalidSessionException

Gets available search methods.

Parameters:

client - the client

projectIdentifier - the project identifier

Returns:

the available search methods

Throws:

CometException - the comet exception

InvalidSessionException - the invalid session exception

getUiFallbackLanguage

String getUiFallbackLanguage()

Gets ui fallback language.

Returns:

the ui fallback language

readSnippetData

byte[] readSnippetData(String fileId)
                throws CometException

Read snippet data byte [ ].

Parameters:

fileId - the file id

Returns:

the byte [ ]

Throws:

CometException - the comet exception

readSnippetPreview

byte[] readSnippetPreview(String fileId)
                   throws CometException

Read snippet preview byte [ ].

Parameters:

fileId - the file id

Returns:

the byte [ ]

Throws:

CometException - the comet exception

readSnippetPreviewById

byte[] readSnippetPreviewById(int snippetId)
                       throws CometException

Read snippet preview by id byte [ ].

Parameters:

snippetId - the snippet id

Returns:

the byte [ ]

Throws:

CometException - the comet exception

getTranslations

TranslationsUnit getTranslations()
                          throws CometException

Gets translations for the current session

Returns:

translations for this session / UI language

Throws:

CometException