Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.infoglue.deliver.controllers.kernel.impl.simple
Interface TemplateController

All Known Implementing Classes:
BasicTemplateController, EditOnSiteBasicTemplateController
public interface TemplateController

Author:
Mattias Bogeblad

Method Summary
 void addToContext(java.lang.String name, java.lang.Object object)
          Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc
 java.lang.String decoratePage(java.lang.String page)
           
 java.lang.String getArchiveBaseUrl(java.lang.Integer contentId, java.lang.String assetKey)
          This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
 java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName, int index, java.lang.String assetKey)
          This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
 java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName, java.lang.String assetKey)
          This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
 java.util.Vector getArchiveEntries(java.lang.Integer contentId, java.lang.String assetKey)
           
 java.lang.Integer getAssetFileSize(java.lang.Integer contentId)
           
 java.lang.Integer getAssetFileSize(java.lang.Integer contentId, java.lang.String assetKey)
           
 java.lang.Integer getAssetFileSize(java.lang.String contentBindningName, int index)
           
 java.lang.Integer getAssetFileSize(java.lang.String contentBindningName, java.lang.String assetKey)
           
 java.util.Collection getAssetKeys(java.lang.Integer contentId)
          This method deliveres a list of strings which represents all assetKeys for a content.
 java.util.Collection getAssetKeys(java.lang.String contentBindningName)
          This method deliveres a list of strings which represents all assetKeys for a content.
 java.lang.String getAssetThumbnailUrl(java.lang.Integer contentId, int width, int height)
          This method deliveres a String with the URL to the thumbnail for the digital asset asked for.
 java.lang.String getAssetThumbnailUrl(java.lang.Integer contentId, java.lang.String assetKey, int width, int height)
          This method deliveres a String with the URL to the thumbnail for the digital asset asked for.
 java.lang.String getAssetThumbnailUrl(java.lang.String contentBindningName, int width, int height)
          This method deliveres a String with the URL to the thumbnail of the digital asset asked for.
 java.lang.String getAssetThumbnailUrl(java.lang.String contentBindningName, java.lang.String assetKey, int width, int height)
          This method deliveres a String with the URL to the thumbnail of the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.Integer contentId)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.Integer contentId, java.lang.String assetKey)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.String contentBindningName)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.String contentBindningName, int index)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.String contentBindningName, java.lang.String assetKey)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssignPropertyBindingTag(java.lang.String propertyName, boolean createNew, java.lang.String html, boolean showInPublishedMode)
          This method returns the neccessairy html to assign by klicking on a link.
 java.util.List getAvailableLanguages()
          This method returns a list of all languages available on the current site/repository.
 ContentVO getBoundContent(java.lang.String structureBindningName)
          The method returns a single ContentVO-objects that is the bound content of named binding.
 java.util.List getBoundContents(java.lang.String structureBindningName)
          The method returns a list of ContentVO-objects that is the bound content of named binding.
 java.util.List getBoundFolderContents(java.lang.Integer siteNodeId, java.lang.String structureBindningName, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder)
          The method returns a list of ContentVO-objects that is children to the bound content of named binding on the siteNode sent in.
 java.util.List getBoundFolderContents(java.lang.String structureBindningName, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder)
          The method returns a list of ContentVO-objects that is children to the bound content of named binding.
 WebPage getBoundPage(java.lang.String structureBindningName, int position)
          The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
 java.util.List getBoundPages(java.lang.Integer siteNodeId, java.lang.String structureBindningName)
          This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.
 java.util.List getBoundPages(java.lang.String structureBindningName)
           
 BrowserBean getBrowserBean()
          Getter for the browserBean which supplies information about the users browser, OS and other stuff.
 ChartHelper getChartHelper()
          This method gets the math utility.
 java.util.Collection getChildContents(java.lang.Integer contentId, boolean includeFolders)
          This method gets the children of a content.
 java.util.List getChildContents(java.lang.Integer contentId, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder)
          The method returns a list of ContentVO-objects that is children to the bound content sent in.
 java.util.List getChildContents(java.lang.Integer contentId, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder, boolean includeFolders)
          The method returns a list of ContentVO-objects that is children to the bound content sent in.
 java.util.List getChildPages()
          The method returns a list of WebPage-objects that is the children of the current siteNode.
 java.util.List getChildPages(java.lang.Integer siteNodeId)
          The method returns a list of WebPage-objects that is the children of the given siteNode.
 java.util.List getChildPages(java.lang.Integer siteNodeId, boolean escapeHTML, boolean hideUnauthorizedPages)
          The method returns a list of WebPage-objects that is the children of the given siteNode.
 java.util.List getChildPages(java.lang.String structureBindingName)
          The method returns a list of WebPage-objects that is the children of the given siteNode.
 ColorHelper getColorHelper()
          This method gets the color utility.
 ComponentLogic getComponentLogic()
          This method gets a component logic helper object.
 ContentVO getContent()
          Getter for the current content
 ContentVO getContent(java.lang.Integer contentId)
          Getter for the current content
 java.lang.String getContentAttribute(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for in the language asked for.
 java.lang.String getContentAttribute(java.lang.Integer contentId, java.lang.Integer langaugeId, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttribute(java.lang.Integer contentId, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for.
 java.lang.String getContentAttribute(java.lang.Integer contentId, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttribute(java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for if it exists in the content defined in the url-parameter contentId.
 java.lang.String getContentAttribute(java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for.
 java.lang.String getContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.lang.String backgroundImageUrl)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight)
          This method deliveres a String with the content-attribute asked for generated as a gif-file.
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.lang.String backgroundImageUrl)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor, java.lang.String backgroundImageUrl)
           
 java.lang.String getContentAttributeAsPDFUrl(java.lang.String contentBindningName, java.lang.String attributeName)
          This method uses the content-attribute to generate a pdf-file.
 java.util.List getContentAttributes(java.lang.String schemaValue)
          This method returns a list of elements/attributes based on the contentType sent in.
 java.lang.String getContentAttributeWithReturningId(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName, boolean clean, java.util.List contentVersionId)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.Integer getContentId()
          Getter for the contentId
 java.lang.Integer getContentId(java.lang.Integer siteNodeId, java.lang.String contentBindningName)
          Getter for bound contentId for a binding on a special siteNode
 java.lang.Integer getContentId(java.lang.String contentBindningName)
          Getter for bound contentId for a binding
 java.util.Collection getContentTypeDefinitionAssetKeys(java.lang.String schemaValue)
          This method deliveres a list of strings which represents all assetKeys defined for a contentTypeDefinition.
 ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.Integer contentId)
          The method returns the ContentTypeVO-objects of the given contentId.
 ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.String name)
          The method returns the ContentTypeVO-object with the given name.
 ContentVersionVO getContentVersion(java.lang.Integer contentId)
          Getter for the most recent contentVersion on a content
 ContentVersionVO getContentVersion(java.lang.Integer contentId, java.lang.Integer languageId, boolean useLanguageFallback)
          Getter for the most recent contentVersion on a content
 java.util.List getContentVersionsByCategory(java.lang.Integer categoryId, java.lang.String attributeName)
          Finds a list of ContentVersionVOs that are related to the provided category under the given attribute name.
 java.lang.String getCookie(java.lang.String cookieName)
          This method gets a cookie.
 java.lang.String getCurrentPagePath()
          This method constructs a string representing the path to the page with respect to where in the structure the page is.
 java.lang.String getCurrentPageUrl()
          This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.
 org.exolab.castor.jdo.Database getDatabase()
          Sets the transaction the controller should work within.
 DeliveryContext getDeliveryContext()
           
 DesEncryptionHelper getDesEncryptionHelper()
          This method gets the DesEncryptionHelper.
 java.lang.String getDigitalAssetBaseUrl()
          This method returns the base url for the digital assets.
 java.lang.Integer getDigitalAssetId(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String assetKey)
          This method returns the Id the digital assets.
 java.lang.Integer getDigitalAssetId(java.lang.Integer contentId, java.lang.String assetKey)
          This method returns the Id the digital assets.
 java.lang.String getEditOnSightTag(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName, java.lang.String html, boolean showInPublishedMode)
          This method adds the neccessairy html to a output for it to be editable.
 java.lang.String getEncodedUrl(java.lang.String s, java.lang.String enc)
           
 FontHelper getFontHelper()
          This method gets the color utility.
 java.util.List getFormAttributes(java.lang.Integer contentId, java.lang.String attributeName)
          This method returns a list of form elements/attributes based on the schema sent in.
 java.util.List getFormAttributes(java.lang.String contentBindningName, java.lang.String attributeName)
          This method returns a list of form elements/attributes based on the schema sent in.
 boolean getHasLocalizedVersion(java.lang.Integer contentId)
          This method return true if a localized version with the current language exist
 boolean getHasUserPageAccess(java.lang.Integer siteNodeId)
          This method return true if the user logged in has access to the siteNode sent in.
 boolean getHasUserPageAccess(java.lang.Integer siteNodeId, java.lang.String interceptionPointName)
          This method return true if the user logged in has access to the siteNode sent in.
 boolean getHasUserPageWriteAccess(java.lang.Integer siteNodeId)
          This method return true if the user logged in has access to the siteNode sent in.
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
          Getter for request-object
 java.lang.String getInlineAssetUrl(java.lang.String assetKey)
          This method deliveres a String with the URL to the digital asset asked for.
 boolean getIsCurrentSiteNode(java.lang.Integer siteNodeId)
          This method helps us find out if the current site node is the same as the one sent in.
 boolean getIsEditOnSightDisabled()
          This method returns true if the page in question (ie sitenode) has page-caching disabled.
 boolean getIsInPageComponentMode()
          This method returns true if the user is in component editor mode.
 boolean getIsPageCacheDisabled()
          This method returns true if the if the page in question (ie sitenode) has page-caching disabled.
 boolean getIsPageProtected()
          This method returns true if the page in question (ie sitenode) has it's protected property enabled.
 boolean getIsParentToCurrent(java.lang.Integer siteNodeId)
          This method helps us find out if the current site node is the same or a child to the sent in one.
 LanguageVO getLanguage(java.lang.Integer languageId)
          This method supplies a method to get the locale of the language currently in use.
 LanguageVO getLanguage(java.lang.String languageCode)
          This method supplies a method to get the locale of the language currently in use.
 java.util.Locale getLanguageCode(java.lang.Integer languageId)
          This method supplies a method to get the locale of the language sent in.
 java.lang.Integer getLanguageId()
          Getter for the languageId
 java.util.Locale getLocale()
          This method supplies a method to get the locale of the language currently in use.
 java.util.List getLocalizedBoundPages(java.lang.String structureBindningName)
          The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
 java.util.List getMatchingContents(java.lang.String contentTypeDefinitionNamesString, java.lang.String categoryConditionString, boolean useLanguageFallback)
          This method searches for all contents matching
 MathHelper getMathHelper()
          This method gets the math utility.
 java.lang.Integer getMetaInformationContentId()
          This method gets the meta information of the current sitenode.
 java.lang.Integer getMetaInformationContentId(java.lang.Integer siteNodeId)
          This method gets the meta information of a particular sitenode.
 java.util.List getNodeAvailableLanguages()
          This method returns a list of all languages available on the current sitenode.
 java.util.List getNodeAvailableLanguages(java.lang.Integer siteNodeId)
           
 java.text.NumberFormat getNumberFormatHelper()
          This method gets the NumberFormat instance with the proper locale.
 ObjectConverter getObjectConverter()
          This method gets the object converter utility.
 java.lang.Object getObjectWithName(java.lang.String classname)
           
 java.lang.Integer getOperatingMode()
          This method returns which mode the delivery-engine is running in.
 java.lang.String getOriginalFullURL()
          This method returns the exact full url from the original request - not modified
 java.lang.String getPageBaseUrl(java.lang.String structureBindningName)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageContentType()
          This method returns the contenttype this page should return.
 java.lang.String getPageNavTitle(java.lang.Integer siteNodeId)
          This method deliveres a String with the Navigation title the page asked for has.
 java.lang.String getPageNavTitle(java.lang.String structureBindningName)
          This method deliveres a String with the Navigation title the page asked for has.
 java.lang.String getPageNavTitle(java.lang.String structureBindningName, int index)
          This method deliveres a String with the Navigation title the page asked for has.
 java.lang.String getPageTitle()
          This method deliveres a String with the Navigation title the page the user are on has.
 java.lang.String getPageUrl(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId)
          This method deliveres a new url pointing to the same address as now but with new parameters.
 java.lang.String getPageUrl(java.lang.String structureBindningName)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageUrl(java.lang.String structureBindningName, java.lang.Integer contentId)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageUrl(java.lang.String structureBindningName, int position, java.lang.Integer contentId)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageUrl(WebPage webpage, java.lang.Integer contentId)
          This method just gets a new URL but with the given contentId in it.
 java.lang.String getPageUrlAfterLanguageChange(java.lang.String languageCode)
          This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.
 java.lang.String getPageUrlOnPosition(java.lang.String structureBindningName, int position)
          This method deliveres a String with the URL to the page asked for.
 java.lang.Integer getParentRepositoryId()
          This method returns the parent repositoryId if any for the given repository.
 java.lang.Integer getParentRepositoryId(java.lang.Integer repositoryId)
          This method returns the parent repositoryId if any for the given repository.
 SiteNodeVO getParentSiteNode(java.lang.Integer siteNodeId)
          This method returns the parent siteNode to the given siteNode.
 java.lang.String getParsedContentAttribute(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getParsedContentAttribute(java.lang.Integer contentId, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
 java.lang.String getParsedContentAttribute(java.lang.Integer contentId, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getParsedContentAttribute(java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
 java.lang.String getParsedContentAttribute(java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getParsedContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
 java.lang.String getParsedContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 InfoGluePrincipal getPrincipal()
           
 InfoGluePrincipal getPrincipal(java.lang.String userName)
          This method returns the InfoGlue Principal requested
 java.util.Map getPrincipalPropertyHashValues(InfoGluePrincipal infoGluePrincipal, java.lang.String propertyName)
          Getting a property for a Principal - used for personalisation.
 java.util.Map getPrincipalPropertyHashValues(InfoGluePrincipal infoGluePrincipal, java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for a Principal - used for personalisation.
 java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName)
          Getting a property for the current Principal - used for personalisation.
 java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for the current Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(InfoGluePrincipal infoGluePrincipal, java.lang.String propertyName)
          Getting a property for the current Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(InfoGluePrincipal infoGluePrincipal, java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for a Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(java.lang.String propertyName)
          Getting a property for the current Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for the current Principal - used for personalisation.
 java.util.List getRelatedContents(java.lang.Integer contentId, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedContents(java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedContents(java.lang.String bindingName, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedContentsByQualifyer(java.lang.String qualifyerXML)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedPages(java.lang.Integer contentId, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedPages(java.lang.String attributeName)
          This method gets a List of related siteNodes defined in an attribute as an xml-definition.
 java.util.List getRelatedPages(java.lang.String bindingName, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.lang.String getRenderedTextUrl(java.lang.Integer contentId, java.lang.String text, java.util.Map renderAttributes)
          Renders a text from values configured in a content, iterates over the contenttype defenition names and look for font properties.
 java.lang.String getRenderedTextUrl(java.lang.String text, java.util.Map renderAttributes)
          Renders a text from configuration stored in the propertyfile or in the map.
 java.lang.String getRepositoryBaseUrl()
          This method returns the base url for the digital assets.
 SiteNodeVO getRepositoryRootSiteNode()
          This method returns the root node for the current repository.
 SiteNodeVO getRepositoryRootSiteNode(java.lang.Integer repositoryId)
          This method returns the root node for the current repository.
 java.util.Enumeration getRequestParamenterNames()
          Getter for request-parameters
 java.lang.String getRequestParameter(java.lang.String parameterName)
          Getter for request-parameter
 java.lang.String[] getRequestParameterValues(java.lang.String parameterName)
          Getter for request-parameters
 RssHelper getRssHelper()
          This method gets the rss utility.
 SiteNodeVO getSiteNode()
          This method fetches the given siteNode
 SiteNodeVO getSiteNode(java.lang.Integer siteNodeId)
          This method fetches the given siteNode
 java.lang.Integer getSiteNodeId()
          Getter for the siteNodeId
 java.lang.Integer getSiteNodeId(java.lang.String structureBindningName)
          Getter for the siteNodeId on a specific bound page
 java.lang.String getStringAsImageUrl(java.lang.String text, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
           
 java.lang.String getStringAsImageUrl(java.lang.String text, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
          This method deliveres a String with the content-attribute asked for generated as a png-file.
 java.lang.String getTemplateAttributeName()
          Getter for the template attribute name.
 TemplateController getTemplateController(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId, javax.servlet.http.HttpServletRequest request, InfoGluePrincipal infoGluePrincipal, DeliveryContext deliveryContext)
           
 TemplateController getTemplateController(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId, InfoGluePrincipal infoGluePrincipal, DeliveryContext deliveryContext)
          This method should be much more sophisticated later and include a check to see if there is a digital asset uploaded which is more specialized and can be used to act as serverside logic to the template.
 boolean getThreatFoldersAsContents()
           
 java.lang.String getUrlContent(java.lang.String url)
          This method fetches a given URL contents.
 java.lang.String getUrlContent(java.lang.String url, boolean includeRequest)
          This method fetches a given URL contents.
 java.lang.String getUrlContent(java.lang.String url, boolean includeRequest, java.lang.String encoding)
          This method fetches a given URL contents.
 java.lang.String getUrlContent(java.lang.String url, java.lang.String encoding)
          This method fetches a given URL contents.
 WebServiceHelper getWebServiceHelper()
          This method gets the webservice utility.
 VisualFormatter getVisualFormatter()
          This method gets the formatter object that helps with formatting of data.
 java.lang.String include(java.lang.String contentBindningName, java.lang.String attributeName)
          This method allows the current template to include another template which is also rendered in the current context as if it were a part.
 java.lang.String include(java.lang.String contentBindningName, java.lang.String attributeName, boolean cacheInclude)
           
 java.lang.String include(java.lang.String contentBindningName, java.lang.String attributeName, boolean cacheInclude, java.lang.String cName, java.lang.Object cObject)
          This method allows the current template to include another template which is also rendered in the current context as if it were a part.
 java.lang.String renderString(java.lang.String template)
          This method allows a user to get any string rendered as a template.
 java.lang.String renderString(java.lang.String template, boolean useSubContext)
          This method allows a user to get any string rendered as a template.
 java.lang.String replace(java.lang.String originalString, java.lang.String expressionToReplace, java.lang.String newString)
          This method lets a user substitute a string located in the page by a regular expression with another string.
 java.lang.String replace(java.lang.String originalString, java.lang.String substring, java.lang.String stringToReplace, java.lang.String newString)
          This method lets a user substitute a string located in the page by a regular expression with another string.
 void setBrowserBean(BrowserBean browserBean)
          Setter for the bean which contains information about the users browser.
 void setComponentLogic(ComponentLogic componentLogic)
          This method gets a component logic helper object.
 void setCookie(java.lang.String cookieName, java.lang.String value, java.lang.String domain, java.lang.String path, java.lang.Integer maxAge)
          This method sets a cookie.
 void setDeliveryContext(DeliveryContext deliveryContext)
           
 void setDeliveryControllers(NodeDeliveryController nodeDeliveryController, ContentDeliveryController contentDeliveryController, IntegrationDeliveryController integrationDeliveryController)
          Setting to enable us to set initialized versions of the Node and Content delivery Controllers.
 void setHttpRequest(javax.servlet.http.HttpServletRequest request)
          Setter for the template to get all the parameters from the user.
 void setStandardRequestParameters(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId)
          Setter for the template to get all the parameters from the user.
 void setThreatFoldersAsContents(boolean threatFoldersAsContents)
           
 

Method Detail

getDatabase

org.exolab.castor.jdo.Database getDatabase()
                                           throws SystemException
Sets the transaction the controller should work within. This is to limit the number of connections we use.

Throws:
SystemException

addToContext

void addToContext(java.lang.String name,
                  java.lang.Object object)
Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc

setStandardRequestParameters

void setStandardRequestParameters(java.lang.Integer siteNodeId,
                                  java.lang.Integer languageId,
                                  java.lang.Integer contentId)
Setter for the template to get all the parameters from the user.

setHttpRequest

void setHttpRequest(javax.servlet.http.HttpServletRequest request)
Setter for the template to get all the parameters from the user.

setBrowserBean

void setBrowserBean(BrowserBean browserBean)
Setter for the bean which contains information about the users browser.

getTemplateAttributeName

java.lang.String getTemplateAttributeName()
Getter for the template attribute name.

getSiteNodeId

java.lang.Integer getSiteNodeId()
Getter for the siteNodeId

getLanguageId

java.lang.Integer getLanguageId()
Getter for the languageId

getContentId

java.lang.Integer getContentId()
Getter for the contentId

getComponentLogic

ComponentLogic getComponentLogic()
This method gets a component logic helper object.

setComponentLogic

void setComponentLogic(ComponentLogic componentLogic)
This method gets a component logic helper object.

getVisualFormatter

VisualFormatter getVisualFormatter()
This method gets the formatter object that helps with formatting of data.

getColorHelper

ColorHelper getColorHelper()
This method gets the color utility.

getFontHelper

FontHelper getFontHelper()
This method gets the color utility.

getMathHelper

MathHelper getMathHelper()
This method gets the math utility.

getChartHelper

ChartHelper getChartHelper()
This method gets the math utility.

getWebServiceHelper

WebServiceHelper getWebServiceHelper()
This method gets the webservice utility.

getNumberFormatHelper

java.text.NumberFormat getNumberFormatHelper()
                                             throws SystemException
This method gets the NumberFormat instance with the proper locale.

Throws:
SystemException

getDesEncryptionHelper

DesEncryptionHelper getDesEncryptionHelper()
This method gets the DesEncryptionHelper.

getRssHelper

RssHelper getRssHelper()
This method gets the rss utility.

getObjectConverter

ObjectConverter getObjectConverter()
This method gets the object converter utility.

getContent

ContentVO getContent()
Getter for the current content

getContent

ContentVO getContent(java.lang.Integer contentId)
Getter for the current content

getPrincipal

InfoGluePrincipal getPrincipal()

getPrincipal

InfoGluePrincipal getPrincipal(java.lang.String userName)
This method returns the InfoGlue Principal requested

Parameters:
userName -

getPrincipalPropertyValue

java.lang.String getPrincipalPropertyValue(java.lang.String propertyName)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyHashValues

java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyValue

java.lang.String getPrincipalPropertyValue(InfoGluePrincipal infoGluePrincipal,
                                           java.lang.String propertyName)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyHashValues

java.util.Map getPrincipalPropertyHashValues(InfoGluePrincipal infoGluePrincipal,
                                             java.lang.String propertyName)
Getting a property for a Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyValue

java.lang.String getPrincipalPropertyValue(InfoGluePrincipal infoGluePrincipal,
                                           java.lang.String propertyName,
                                           boolean escapeSpecialCharacters)
Getting a property for a Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyValue

java.lang.String getPrincipalPropertyValue(java.lang.String propertyName,
                                           boolean escapeSpecialCharacters)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyHashValues

java.util.Map getPrincipalPropertyHashValues(InfoGluePrincipal infoGluePrincipal,
                                             java.lang.String propertyName,
                                             boolean escapeSpecialCharacters)
Getting a property for a Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getPrincipalPropertyHashValues

java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName,
                                             boolean escapeSpecialCharacters)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getHttpServletRequest

javax.servlet.http.HttpServletRequest getHttpServletRequest()
Getter for request-object

getRequestParamenterNames

java.util.Enumeration getRequestParamenterNames()
Getter for request-parameters

getRequestParameter

java.lang.String getRequestParameter(java.lang.String parameterName)
Getter for request-parameter

getRequestParameterValues

java.lang.String[] getRequestParameterValues(java.lang.String parameterName)
Getter for request-parameters

getBrowserBean

BrowserBean getBrowserBean()
Getter for the browserBean which supplies information about the users browser, OS and other stuff.

setDeliveryControllers

void setDeliveryControllers(NodeDeliveryController nodeDeliveryController,
                            ContentDeliveryController contentDeliveryController,
                            IntegrationDeliveryController integrationDeliveryController)
Setting to enable us to set initialized versions of the Node and Content delivery Controllers.

getContentAttribute

java.lang.String getContentAttribute(java.lang.String contentBindningName,
                                     java.lang.String attributeName,
                                     boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getContentAttribute

java.lang.String getContentAttribute(java.lang.String attributeName,
                                     boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getContentAttribute

java.lang.String getContentAttribute(java.lang.Integer contentId,
                                     java.lang.String attributeName,
                                     boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getContentAttribute

java.lang.String getContentAttribute(java.lang.Integer contentId,
                                     java.lang.Integer langaugeId,
                                     java.lang.String attributeName,
                                     boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getContentAttributeWithReturningId

java.lang.String getContentAttributeWithReturningId(java.lang.Integer contentId,
                                                    java.lang.Integer languageId,
                                                    java.lang.String attributeName,
                                                    boolean clean,
                                                    java.util.List contentVersionId)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getContentAttribute

java.lang.String getContentAttribute(java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for if it exists in the content defined in the url-parameter contentId.

getContentAttribute

java.lang.String getContentAttribute(java.lang.String contentBindningName,
                                     java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getContentAttribute

java.lang.String getContentAttribute(java.lang.Integer contentId,
                                     java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getContentAttribute

java.lang.String getContentAttribute(java.lang.Integer contentId,
                                     java.lang.Integer languageId,
                                     java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for in the language asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.String contentBindningName,
                                           java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.Integer contentId,
                                           java.lang.String attributeName)
This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted. The attribute is fetched from the specified content.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.String attributeName,
                                           boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.String contentBindningName,
                                           java.lang.String attributeName,
                                           boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.Integer contentId,
                                           java.lang.String attributeName,
                                           boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getParsedContentAttribute

java.lang.String getParsedContentAttribute(java.lang.Integer contentId,
                                           java.lang.Integer languageId,
                                           java.lang.String attributeName,
                                           boolean clean)
This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getAssetKeys

java.util.Collection getAssetKeys(java.lang.String contentBindningName)
This method deliveres a list of strings which represents all assetKeys for a content.

getAssetKeys

java.util.Collection getAssetKeys(java.lang.Integer contentId)
This method deliveres a list of strings which represents all assetKeys for a content.

getAssetThumbnailUrl

java.lang.String getAssetThumbnailUrl(java.lang.Integer contentId,
                                      int width,
                                      int height)
This method deliveres a String with the URL to the thumbnail for the digital asset asked for. This method assumes that the content sent in only has one asset attached.

getAssetThumbnailUrl

java.lang.String getAssetThumbnailUrl(java.lang.Integer contentId,
                                      java.lang.String assetKey,
                                      int width,
                                      int height)
This method deliveres a String with the URL to the thumbnail for the digital asset asked for. This method takes a key for the asset you want to make a thumbnail from.

getAssetThumbnailUrl

java.lang.String getAssetThumbnailUrl(java.lang.String contentBindningName,
                                      int width,
                                      int height)
This method deliveres a String with the URL to the thumbnail of the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getAssetThumbnailUrl

java.lang.String getAssetThumbnailUrl(java.lang.String contentBindningName,
                                      java.lang.String assetKey,
                                      int width,
                                      int height)
This method deliveres a String with the URL to the thumbnail of the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getAssetUrl

java.lang.String getAssetUrl(java.lang.String contentBindningName)
This method deliveres a String with the URL to the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getEncodedUrl

java.lang.String getEncodedUrl(java.lang.String s,
                               java.lang.String enc)

getAssetUrl

java.lang.String getAssetUrl(java.lang.Integer contentId)
This method deliveres a String with the URL to the digital asset asked for.

getAssetUrl

java.lang.String getAssetUrl(java.lang.Integer contentId,
                             java.lang.String assetKey)
This method deliveres a String with the URL to the digital asset asked for.

getAssetUrl

java.lang.String getAssetUrl(java.lang.String contentBindningName,
                             int index)
This method deliveres a String with the URL to the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getAssetUrl

java.lang.String getAssetUrl(java.lang.String contentBindningName,
                             java.lang.String assetKey)
This method deliveres a String with the URL to the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getInlineAssetUrl

java.lang.String getInlineAssetUrl(java.lang.String assetKey)
This method deliveres a String with the URL to the digital asset asked for. In this special case the image is fetched from the article being generated. This means that this method only is of interest if you have attached assets to either a template or to an content and are useing parsedContentAttribute.

getAssetFileSize

java.lang.Integer getAssetFileSize(java.lang.Integer contentId)

getAssetFileSize

java.lang.Integer getAssetFileSize(java.lang.Integer contentId,
                                   java.lang.String assetKey)

getAssetFileSize

java.lang.Integer getAssetFileSize(java.lang.String contentBindningName,
                                   int index)

getAssetFileSize

java.lang.Integer getAssetFileSize(java.lang.String contentBindningName,
                                   java.lang.String assetKey)

getRelatedContentsByQualifyer

java.util.List getRelatedContentsByQualifyer(java.lang.String qualifyerXML)
This method gets a List of related contents defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getRelatedContents

java.util.List getRelatedContents(java.lang.String attributeName)
This method gets a List of related contents defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getRelatedContents

java.util.List getRelatedContents(java.lang.String bindingName,
                                  java.lang.String attributeName)
This method gets a List of related contents defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getRelatedContents

java.util.List getRelatedContents(java.lang.Integer contentId,
                                  java.lang.String attributeName)
This method gets a List of related contents defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getRelatedPages

java.util.List getRelatedPages(java.lang.String attributeName)
This method gets a List of related siteNodes defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getRelatedPages

java.util.List getRelatedPages(java.lang.String bindingName,
                               java.lang.String attributeName)
This method gets a List of related contents defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getRelatedPages

java.util.List getRelatedPages(java.lang.Integer contentId,
                               java.lang.String attributeName)
This method gets a List of related contents defined in an attribute as an xml-definition. This is an ugly method right now. Later we should have xmlDefinitions that are fully qualified so it can be used to access other systems than our own.

getArchiveBaseUrl

java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName,
                                   java.lang.String assetKey)
This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.

getArchiveBaseUrl

java.lang.String getArchiveBaseUrl(java.lang.Integer contentId,
                                   java.lang.String assetKey)
This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.

getArchiveEntries

java.util.Vector getArchiveEntries(java.lang.Integer contentId,
                                   java.lang.String assetKey)

getArchiveBaseUrl

java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName,
                                   int index,
                                   java.lang.String assetKey)
This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.

getContentAttributeAsPDFUrl

java.lang.String getContentAttributeAsPDFUrl(java.lang.String contentBindningName,
                                             java.lang.String attributeName)
This method uses the content-attribute to generate a pdf-file. The content-attribute is parsed before it is sent to the renderer, and the resulting string must follow the XSL-FO specification. The method checks if a previous file exists that has the same attributes as the wanted one and if so - we don't generate it again.

getContentAttributes

java.util.List getContentAttributes(java.lang.String schemaValue)
This method returns a list of elements/attributes based on the contentType sent in.

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight)
This method deliveres a String with the content-attribute asked for generated as a gif-file. That is - the text is printed as an image. You can specify a number of things to control the generation. Just experiment and the names are pretty much self explainatory. The method checks if a previous file exists that has the same attributes as the wanted one and if so - we don't generate it again. TODO: consider implement a more general getTextAsImageUrl so we dont need a zillion different variants for different ways to access the contentAttribute. (we need to calculate a unique string from the text and all the other stuff.)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.lang.String foregroundColor,
                                               java.lang.String backgroundColor)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.lang.String foregroundColor,
                                               java.lang.String backgroundColor,
                                               java.lang.String backgroundImageUrl)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.lang.String foregroundColor,
                                               java.lang.String backgroundColor)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.awt.Color foregroundColor,
                                               java.awt.Color backgroundColor)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.awt.Color foregroundColor,
                                               java.awt.Color backgroundColor,
                                               java.lang.String backgroundImageUrl)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.awt.Color foregroundColor,
                                               java.awt.Color backgroundColor)

getContentAttributeAsImageUrl

java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId,
                                               java.lang.String attributeName,
                                               int canvasWidth,
                                               int canvasHeight,
                                               int textStartPosX,
                                               int textStartPosY,
                                               int textWidth,
                                               int textHeight,
                                               java.lang.String fontName,
                                               int fontStyle,
                                               int fontSize,
                                               java.awt.Color foregroundColor,
                                               java.awt.Color backgroundColor,
                                               java.lang.String backgroundImageUrl)

getStringAsImageUrl

java.lang.String getStringAsImageUrl(java.lang.String text,
                                     int canvasWidth,
                                     int canvasHeight,
                                     int textStartPosX,
                                     int textStartPosY,
                                     int textWidth,
                                     int textHeight,
                                     java.lang.String fontName,
                                     int fontStyle,
                                     int fontSize,
                                     java.lang.String foregroundColor,
                                     java.lang.String backgroundColor)
This method deliveres a String with the content-attribute asked for generated as a png-file. That is - the text is printed as an image. You can specify a number of things to control the generation. Just experiment and the names are pretty much self explainatory. The method checks if a previous file exists that has the same attributes as the wanted one and if so - we don't generate it again.

getStringAsImageUrl

java.lang.String getStringAsImageUrl(java.lang.String text,
                                     int canvasWidth,
                                     int canvasHeight,
                                     int textStartPosX,
                                     int textStartPosY,
                                     int textWidth,
                                     int textHeight,
                                     java.lang.String fontName,
                                     int fontStyle,
                                     int fontSize,
                                     java.awt.Color foregroundColor,
                                     java.awt.Color backgroundColor)

getDigitalAssetBaseUrl

java.lang.String getDigitalAssetBaseUrl()
                                        throws java.lang.Exception
This method returns the base url for the digital assets.

Throws:
java.lang.Exception

getDigitalAssetId

java.lang.Integer getDigitalAssetId(java.lang.Integer contentId,
                                    java.lang.String assetKey)
                                    throws java.lang.Exception
This method returns the Id the digital assets.

Throws:
java.lang.Exception

getDigitalAssetId

java.lang.Integer getDigitalAssetId(java.lang.Integer contentId,
                                    java.lang.Integer languageId,
                                    java.lang.String assetKey)
                                    throws java.lang.Exception
This method returns the Id the digital assets.

Throws:
java.lang.Exception

getParentRepositoryId

java.lang.Integer getParentRepositoryId(java.lang.Integer repositoryId)
This method returns the parent repositoryId if any for the given repository.

getParentRepositoryId

java.lang.Integer getParentRepositoryId()
This method returns the parent repositoryId if any for the given repository.

getRepositoryRootSiteNode

SiteNodeVO getRepositoryRootSiteNode()
                                     throws java.lang.Exception
This method returns the root node for the current repository.

Throws:
java.lang.Exception

getRepositoryRootSiteNode

SiteNodeVO getRepositoryRootSiteNode(java.lang.Integer repositoryId)
                                     throws java.lang.Exception
This method returns the root node for the current repository.

Throws:
java.lang.Exception

getRepositoryBaseUrl

java.lang.String getRepositoryBaseUrl()
                                      throws java.lang.Exception
This method returns the base url for the digital assets.

Throws:
java.lang.Exception

getPageUrl

java.lang.String getPageUrl(java.lang.String structureBindningName)
This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getPageUrl

java.lang.String getPageUrl(WebPage webpage,
                            java.lang.Integer contentId)
This method just gets a new URL but with the given contentId in it.

getPageBaseUrl

java.lang.String getPageBaseUrl(java.lang.String structureBindningName)
This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getSiteNodeId

java.lang.Integer getSiteNodeId(java.lang.String structureBindningName)
Getter for the siteNodeId on a specific bound page

getSiteNode

SiteNodeVO getSiteNode(java.lang.Integer siteNodeId)
This method fetches the given siteNode

getSiteNode

SiteNodeVO getSiteNode()
This method fetches the given siteNode

getContentId

java.lang.Integer getContentId(java.lang.String contentBindningName)
Getter for bound contentId for a binding

getMetaInformationContentId

java.lang.Integer getMetaInformationContentId()
This method gets the meta information of the current sitenode.

getMetaInformationContentId

java.lang.Integer getMetaInformationContentId(java.lang.Integer siteNodeId)
This method gets the meta information of a particular sitenode.

getChildContents

java.util.Collection getChildContents(java.lang.Integer contentId,
                                      boolean includeFolders)
This method gets the children of a content.

getContentId

java.lang.Integer getContentId(java.lang.Integer siteNodeId,
                               java.lang.String contentBindningName)
Getter for bound contentId for a binding on a special siteNode

getPageUrl

java.lang.String getPageUrl(java.lang.String structureBindningName,
                            java.lang.Integer contentId)
This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute. This method also allows the user to specify that the content is important. This method is mostly used for master/detail-pages.

getPageUrlOnPosition

java.lang.String getPageUrlOnPosition(java.lang.String structureBindningName,
                                      int position)
This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName and also allows the user to specify a special siteNode in an ordered collection. which refers to the AvailableServiceBinding.name-attribute.

getPageUrl

java.lang.String getPageUrl(java.lang.String structureBindningName,
                            int position,
                            java.lang.Integer contentId)
This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName and also allows the user to specify a special siteNode in an ordered collection. which refers to the AvailableServiceBinding.name-attribute. This method also allows the user to specify that the content is important. This method is mostly used for master/detail-pages.

getCurrentPageUrl

java.lang.String getCurrentPageUrl()
This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.

getOriginalFullURL

java.lang.String getOriginalFullURL()
This method returns the exact full url from the original request - not modified

Returns:

getPageUrl

java.lang.String getPageUrl(java.lang.Integer siteNodeId,
                            java.lang.Integer languageId,
                            java.lang.Integer contentId)
This method deliveres a new url pointing to the same address as now but with new parameters.

getCurrentPagePath

java.lang.String getCurrentPagePath()
This method constructs a string representing the path to the page with respect to where in the structure the page is. It also takes the page title into consideration.

getParentSiteNode

SiteNodeVO getParentSiteNode(java.lang.Integer siteNodeId)
This method returns the parent siteNode to the given siteNode.

getPageUrlAfterLanguageChange

java.lang.String getPageUrlAfterLanguageChange(java.lang.String languageCode)
This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.

getPageTitle

java.lang.String getPageTitle()
This method deliveres a String with the Navigation title the page the user are on has. The navigation-title is fetched from the meta-info-content bound to the site node.

getPageNavTitle

java.lang.String getPageNavTitle(java.lang.String structureBindningName)
This method deliveres a String with the Navigation title the page asked for has. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute. The navigation-title is fetched from the meta-info-content bound to the site node.

getPageNavTitle

java.lang.String getPageNavTitle(java.lang.Integer siteNodeId)
This method deliveres a String with the Navigation title the page asked for has. The navigation-title is fetched from the meta-info-content bound to the site node.

getPageNavTitle

java.lang.String getPageNavTitle(java.lang.String structureBindningName,
                                 int index)
This method deliveres a String with the Navigation title the page asked for has. As the siteNode can have multiple bindings the method requires a bindingName and a collection index. The navigation-title is fetched from the meta-info-content bound to the site node.

getIsPageCacheDisabled

boolean getIsPageCacheDisabled()
This method returns true if the if the page in question (ie sitenode) has page-caching disabled. This is essential to turn off when you have a dynamic page like an external application or searchresult.

getPageContentType

java.lang.String getPageContentType()
This method returns the contenttype this page should return. This is important when sending assets or css:contents.

getIsPageProtected

boolean getIsPageProtected()
This method returns true if the page in question (ie sitenode) has it's protected property enabled. This is essential when checking if we should authenticate users before allowing them access.

getIsEditOnSightDisabled

boolean getIsEditOnSightDisabled()
This method returns true if the page in question (ie sitenode) has page-caching disabled. This is essential to turn off when you have a dynamic page like an external application or searchresult.

getIsInPageComponentMode

boolean getIsInPageComponentMode()
This method returns true if the user is in component editor mode.

getAvailableLanguages

java.util.List getAvailableLanguages()
This method returns a list of all languages available on the current site/repository.

getNodeAvailableLanguages

java.util.List getNodeAvailableLanguages()
This method returns a list of all languages available on the current sitenode. The logic is that we check which languages are found in the meta-content in the current mode.

getNodeAvailableLanguages

java.util.List getNodeAvailableLanguages(java.lang.Integer siteNodeId)

getChildPages

java.util.List getChildPages()
The method returns a list of WebPage-objects that is the children of the current siteNode. The method is great for navigation-purposes on a structured site.

getChildPages

java.util.List getChildPages(java.lang.String structureBindingName)
The method returns a list of WebPage-objects that is the children of the given siteNode. The method is great for navigation-purposes on a structured site.

getChildPages

java.util.List getChildPages(java.lang.Integer siteNodeId,
                             boolean escapeHTML,
                             boolean hideUnauthorizedPages)
The method returns a list of WebPage-objects that is the children of the given siteNode. The method is great for navigation-purposes on a structured site.

getChildPages

java.util.List getChildPages(java.lang.Integer siteNodeId)
The method returns a list of WebPage-objects that is the children of the given siteNode. The method is great for navigation-purposes on a structured site.

getBoundPages

java.util.List getBoundPages(java.lang.String structureBindningName)

getBoundPages

java.util.List getBoundPages(java.lang.Integer siteNodeId,
                             java.lang.String structureBindningName)
This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.

getLocalizedBoundPages

java.util.List getLocalizedBoundPages(java.lang.String structureBindningName)
The method returns a list of WebPage-objects that is the bound sitenodes of named binding. The method is great for navigation-purposes on any site. We also filter out all pages that don't have a localized version of the page meta-content.

getBoundContent

ContentVO getBoundContent(java.lang.String structureBindningName)
The method returns a single ContentVO-objects that is the bound content of named binding. It's used for getting one content.

getBoundContents

java.util.List getBoundContents(java.lang.String structureBindningName)
The method returns a list of ContentVO-objects that is the bound content of named binding. The method is great for collection-pages on any site.

getBoundFolderContents

java.util.List getBoundFolderContents(java.lang.String structureBindningName,
                                      boolean searchRecursive,
                                      java.lang.String sortAttribute,
                                      java.lang.String sortOrder)
The method returns a list of ContentVO-objects that is children to the bound content of named binding. The method is great for collection-pages on any site where you want to bind to a folder containing all contents to list. You can also state if the method should recurse into subfolders and how the contents should be sorted. The recursion only deals with three levels at the moment for performance-reasons.

getBoundFolderContents

java.util.List getBoundFolderContents(java.lang.Integer siteNodeId,
                                      java.lang.String structureBindningName,
                                      boolean searchRecursive,
                                      java.lang.String sortAttribute,
                                      java.lang.String sortOrder)
The method returns a list of ContentVO-objects that is children to the bound content of named binding on the siteNode sent in. The method is great for collection-pages on any site where you want to bind to a folder containing all contents to list. You can also state if the method should recurse into subfolders and how the contents should be sorted. The recursion only deals with three levels at the moment for performance-reasons.

getChildContents

java.util.List getChildContents(java.lang.Integer contentId,
                                boolean searchRecursive,
                                java.lang.String sortAttribute,
                                java.lang.String sortOrder)
The method returns a list of ContentVO-objects that is children to the bound content sent in. The method is great for collection-pages on any site where you want to bind to a folder containing all contents to list. You can also state if the method should recurse into subfolders and how the contents should be sorted. The recursion only deals with three levels at the moment for performance-reasons.

getChildContents

java.util.List getChildContents(java.lang.Integer contentId,
                                boolean searchRecursive,
                                java.lang.String sortAttribute,
                                java.lang.String sortOrder,
                                boolean includeFolders)
The method returns a list of ContentVO-objects that is children to the bound content sent in. The method is great for collection-pages on any site where you want to bind to a folder containing all contents to list. You can also state if the method should recurse into subfolders and how the contents should be sorted. The recursion only deals with three levels at the moment for performance-reasons.

getContentVersion

ContentVersionVO getContentVersion(java.lang.Integer contentId)
Getter for the most recent contentVersion on a content

getContentVersion

ContentVersionVO getContentVersion(java.lang.Integer contentId,
                                   java.lang.Integer languageId,
                                   boolean useLanguageFallback)
Getter for the most recent contentVersion on a content

getContentVersionsByCategory

java.util.List getContentVersionsByCategory(java.lang.Integer categoryId,
                                            java.lang.String attributeName)
Finds a list of ContentVersionVOs that are related to the provided category under the given attribute name.

Parameters:
categoryId - The id of the Category
attributeName - The ContentTypeDefinition attribute name of the Category relationship.
Returns:
A list of relevant CategoryVersionVOs

getMatchingContents

java.util.List getMatchingContents(java.lang.String contentTypeDefinitionNamesString,
                                   java.lang.String categoryConditionString,
                                   boolean useLanguageFallback)
This method searches for all contents matching

getOperatingMode

java.lang.Integer getOperatingMode()
This method returns which mode the delivery-engine is running in. The mode is important to be able to show working, preview and published data separate.

getContentTypeDefinitionVO

ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.Integer contentId)
The method returns the ContentTypeVO-objects of the given contentId.

getContentTypeDefinitionVO

ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.String name)
The method returns the ContentTypeVO-object with the given name.

getContentTypeDefinitionAssetKeys

java.util.Collection getContentTypeDefinitionAssetKeys(java.lang.String schemaValue)
This method deliveres a list of strings which represents all assetKeys defined for a contentTypeDefinition.

getBoundPage

WebPage getBoundPage(java.lang.String structureBindningName,
                     int position)
The method returns a list of WebPage-objects that is the bound sitenodes of named binding. The method is great for navigation-purposes on any site. Improve later so the list is cached once for every instance. Otherwise we fetch the whole list again and its not necessairy as this controller only concerns one request.

renderString

java.lang.String renderString(java.lang.String template)
This method allows a user to get any string rendered as a template.

renderString

java.lang.String renderString(java.lang.String template,
                              boolean useSubContext)
This method allows a user to get any string rendered as a template.

include

java.lang.String include(java.lang.String contentBindningName,
                         java.lang.String attributeName)
This method allows the current template to include another template which is also rendered in the current context as if it were a part. The method assumes that the result can be cached. Use the other include method if you wish to be able to control if the result is cached or not.

include

java.lang.String include(java.lang.String contentBindningName,
                         java.lang.String attributeName,
                         boolean cacheInclude)

include

java.lang.String include(java.lang.String contentBindningName,
                         java.lang.String attributeName,
                         boolean cacheInclude,
                         java.lang.String cName,
                         java.lang.Object cObject)
This method allows the current template to include another template which is also rendered in the current context as if it were a part. Use this method if you wish to be able to control if the result is cached or not.

getUrlContent

java.lang.String getUrlContent(java.lang.String url)
This method fetches a given URL contents. This means that we can include a external url's contents in our application.

getUrlContent

java.lang.String getUrlContent(java.lang.String url,
                               boolean includeRequest)
This method fetches a given URL contents. This means that we can include a external url's contents in our application. This second method is used to not send extra params through.

getUrlContent

java.lang.String getUrlContent(java.lang.String url,
                               java.lang.String encoding)
This method fetches a given URL contents. This means that we can include a external url's contents in our application.

getUrlContent

java.lang.String getUrlContent(java.lang.String url,
                               boolean includeRequest,
                               java.lang.String encoding)
This method fetches a given URL contents. This means that we can include a external url's contents in our application. This second method is used to not send extra params through.

getObjectWithName

java.lang.Object getObjectWithName(java.lang.String classname)

replace

java.lang.String replace(java.lang.String originalString,
                         java.lang.String expressionToReplace,
                         java.lang.String newString)
This method lets a user substitute a string located in the page by a regular expression with another string. Very useful in certain situations.

replace

java.lang.String replace(java.lang.String originalString,
                         java.lang.String substring,
                         java.lang.String stringToReplace,
                         java.lang.String newString)
This method lets a user substitute a string located in the page by a regular expression with another string. This method also lets the user specify a subpart of the string to be able to be more specific. Very useful in certain situations.

getIsCurrentSiteNode

boolean getIsCurrentSiteNode(java.lang.Integer siteNodeId)
This method helps us find out if the current site node is the same as the one sent in.

getIsParentToCurrent

boolean getIsParentToCurrent(java.lang.Integer siteNodeId)
This method helps us find out if the current site node is the same or a child to the sent in one. So if the current page is a child(in the entire hierarchy below) below the siteNode sent in the method returns true. Useful for navigational purposes.

getHasLocalizedVersion

boolean getHasLocalizedVersion(java.lang.Integer contentId)
This method return true if a localized version with the current language exist

getHasUserPageAccess

boolean getHasUserPageAccess(java.lang.Integer siteNodeId)
This method return true if the user logged in has access to the siteNode sent in.

getHasUserPageAccess

boolean getHasUserPageAccess(java.lang.Integer siteNodeId,
                             java.lang.String interceptionPointName)
This method return true if the user logged in has access to the siteNode sent in.

getHasUserPageWriteAccess

boolean getHasUserPageWriteAccess(java.lang.Integer siteNodeId)
This method return true if the user logged in has access to the siteNode sent in.

getFormAttributes

java.util.List getFormAttributes(java.lang.String contentBindningName,
                                 java.lang.String attributeName)
This method returns a list of form elements/attributes based on the schema sent in. These consitutes the entire form and a template can then be used to render it in the appropriate technique.

getFormAttributes

java.util.List getFormAttributes(java.lang.Integer contentId,
                                 java.lang.String attributeName)
This method returns a list of form elements/attributes based on the schema sent in. These consitutes the entire form and a template can then be used to render it in the appropriate technique.

getLanguage

LanguageVO getLanguage(java.lang.Integer languageId)
This method supplies a method to get the locale of the language currently in use.

getLanguage

LanguageVO getLanguage(java.lang.String languageCode)
This method supplies a method to get the locale of the language currently in use.

getLanguageCode

java.util.Locale getLanguageCode(java.lang.Integer languageId)
                                 throws SystemException
This method supplies a method to get the locale of the language sent in.

Throws:
SystemException

getLocale

java.util.Locale getLocale()
                           throws SystemException
This method supplies a method to get the locale of the language currently in use.

Throws:
SystemException

setCookie

void setCookie(java.lang.String cookieName,
               java.lang.String value,
               java.lang.String domain,
               java.lang.String path,
               java.lang.Integer maxAge)
This method sets a cookie.

Parameters:
cookieName -
value -
domain -
path -
maxAge -

getCookie

java.lang.String getCookie(java.lang.String cookieName)
This method gets a cookie.

Parameters:
cookieName -

getDeliveryContext

DeliveryContext getDeliveryContext()

setDeliveryContext

void setDeliveryContext(DeliveryContext deliveryContext)

getTemplateController

TemplateController getTemplateController(java.lang.Integer siteNodeId,
                                         java.lang.Integer languageId,
                                         java.lang.Integer contentId,
                                         InfoGluePrincipal infoGluePrincipal,
                                         DeliveryContext deliveryContext)
                                         throws SystemException,
                                                java.lang.Exception
This method should be much more sophisticated later and include a check to see if there is a digital asset uploaded which is more specialized and can be used to act as serverside logic to the template.

Throws:
SystemException
java.lang.Exception

getTemplateController

TemplateController getTemplateController(java.lang.Integer siteNodeId,
                                         java.lang.Integer languageId,
                                         java.lang.Integer contentId,
                                         javax.servlet.http.HttpServletRequest request,
                                         InfoGluePrincipal infoGluePrincipal,
                                         DeliveryContext deliveryContext)
                                         throws SystemException,
                                                java.lang.Exception
Throws:
SystemException
java.lang.Exception

decoratePage

java.lang.String decoratePage(java.lang.String page)

getEditOnSightTag

java.lang.String getEditOnSightTag(java.lang.Integer contentId,
                                   java.lang.Integer languageId,
                                   java.lang.String attributeName,
                                   java.lang.String html,
                                   boolean showInPublishedMode)
This method adds the neccessairy html to a output for it to be editable.

getAssignPropertyBindingTag

java.lang.String getAssignPropertyBindingTag(java.lang.String propertyName,
                                             boolean createNew,
                                             java.lang.String html,
                                             boolean showInPublishedMode)
This method returns the neccessairy html to assign by klicking on a link.

Parameters:
propertyName -
html -
showInPublishedMode -
Returns:

getThreatFoldersAsContents

boolean getThreatFoldersAsContents()

setThreatFoldersAsContents

void setThreatFoldersAsContents(boolean threatFoldersAsContents)

getRenderedTextUrl

java.lang.String getRenderedTextUrl(java.lang.Integer contentId,
                                    java.lang.String text,
                                    java.util.Map renderAttributes)
Renders a text from values configured in a content, iterates over the contenttype defenition names and look for font properties.

Parameters:
contentId - a content id containing attributes to match preferences of the textrenderer. ie fontsize, fontname.
text - the text to render
renderAttributes - render attributes in a map to override the content settings
Returns:
the asseturl or empty string if something is wrong

getRenderedTextUrl

java.lang.String getRenderedTextUrl(java.lang.String text,
                                    java.util.Map renderAttributes)
Renders a text from configuration stored in the propertyfile or in the map.

Parameters:
text - the text to render
renderAttributes - render attributes in a map to override the default or propertyfile settings
Returns:
the asseturl or empty string if something is wrong
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005 InfoGlue.org All Rights Reserved.