org.infoglue.deliver.controllers.kernel.impl.simple
Class BasicTemplateController

java.lang.Object
  org.infoglue.deliver.controllers.kernel.impl.simple.BasicTemplateController

All Implemented Interfaces:

TemplateController

Direct Known Subclasses:

EditOnSiteBasicTemplateController

public class BasicTemplateController
extends java.lang.Object
implements TemplateController

This is the most basic template controller supplying the templates using it with methods to fetch contents, structure and other suff needed for a site. Mostly this class just acts as a delegator to other more specialized classes.

Field Summary

protected BrowserBean	browserBean
protected ComponentLogic	componentLogic
protected ContentDeliveryController	contentDeliveryController
protected java.lang.Integer	contentId
protected DatabaseWrapper	databaseWrapper
protected DeliveryContext	deliveryContext
protected static boolean	DO_NOT_USE_INHERITANCE
protected static boolean	DO_NOT_USE_LANGUAGE_FALLBACK
protected InfoGluePrincipal	infoGluePrincipal
protected IntegrationDeliveryController	integrationDeliveryController
protected java.lang.Integer	languageId
static java.lang.String	META_INFO_BINDING_NAME
static java.lang.String	NAV_TITLE_ATTRIBUTE_NAME
protected NodeDeliveryController	nodeDeliveryController
protected boolean	persistedContext
protected javax.servlet.http.HttpServletRequest	request
protected java.lang.Integer	siteNodeId
static java.lang.String	TEMPLATE_ATTRIBUTE_NAME
protected java.util.Map	templateLogicContext
static java.lang.String	TITLE_ATTRIBUTE_NAME
protected static boolean	USE_INHERITANCE
protected static boolean	USE_LANGUAGE_FALLBACK

Constructor Summary

BasicTemplateController(DatabaseWrapper databaseWrapper, InfoGluePrincipal infoGluePrincipal)
The constructor for the templateController.

Method Summary

protected void	addToContext(java.util.Map context) Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc this method adds all objects in the map to the templateLogicContext, the method is protected and is used by getTemplateController to pass on the current context to the new controller if persistedContext is true.
void	addToContext(java.lang.String name, java.lang.Object object) Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc
void	closeTransaction() Commit transactions so far so a different call can be made which otherwise gets a deadlock.
void	commitDatabase() Commits and reopens a database object so we don't have to long transaction.
java.lang.String	decoratePage(java.lang.String page)
java.util.List	getAccessRights(java.lang.String interceptionPointName, java.lang.String parameters) This method returns an access right list so one can get which roles, groups and users can access the page.
java.util.List	getAllGroups() Returns a list of InfoGlueGroups
java.util.List	getAllRoles() Returns a list of InfoGlueRoles
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.lang.String	getArchiveBaseUrlForAssetWithId(java.lang.Integer digitalAssetId) This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset identified by a digitalAssetId.
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.lang.Integer	getAssetFileSizeForAssetWithId(java.lang.Integer digitalAssetId) Returns assetFileSize for a digital asset identified by id.
java.util.Collection	getAssetIds(java.lang.Integer contentId) This method deliveres a list of strings which represents all assetKeys for a content.
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.util.Collection	getAssets(java.lang.Integer contentId) This method deliveres a list of DigitalAssetVO-objects which represents all assets for a content.
java.lang.String	getAssetThumbnailUrl(InfoGluePrincipal principal, java.lang.String assetKey, java.lang.Integer languageId, java.lang.Integer siteNodeId, boolean useLanguageFallback, int width, int height) This method deliveres a String with the URL to the digital asset asked for.
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	getAssetThumbnailUrlForAssetWithId(java.lang.Integer digitalAssetId, int width, int height) This method deliveres a String with the URL to the thumbnail for the digital asset asked for.
java.lang.String	getAssetUrl(InfoGluePrincipal principal, java.lang.String assetKey, java.lang.Integer languageId, java.lang.Integer siteNodeId, boolean useLanguageFallback) This method deliveres a String with the URL to 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	getAssetUrlForAssetWithId(java.lang.Integer digitalAssetId) This method deliveres a String with the URL to the digital asset asked for.
java.util.List	getAssignedCategories(java.lang.Integer contentId, java.lang.String categoryKey, java.lang.Integer languageId, boolean useLanguageFallback) This method gets assignedCategories for a content on a specific categoryKey.
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.Integer siteNodeId, java.lang.String structureBindningName, boolean escapeHTML)
java.util.List	getBoundPages(java.lang.Integer siteNodeId, java.lang.String structureBindningName, boolean escapeHTML, boolean hideUnauthorizedPages) 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) The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
java.util.List	getBoundPages(java.lang.String structureBindningName, boolean escapeHTML) The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
java.util.List	getBoundPages(java.lang.String structureBindningName, boolean escapeHTML, boolean hideUnauthorizedPages) The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
BrowserBean	getBrowserBean() Getter for the browserBean which supplies information about the users browser, OS and other stuff.
java.lang.String	getCategoryPath(java.lang.Integer categoryId) This method gets the full path/name of a given categoryId.
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(boolean escapeHTML) The method returns a list of WebPage-objects that is the children of the current siteNode.
java.util.List	getChildPages(boolean escapeHTML, boolean hideUnauthorizedPages) 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) 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.Integer siteNodeId, java.lang.String sortAttribute, java.lang.String sortOrder) The method returns a list of WebPage-objects that is the children of the given siteNode.
java.util.List	getChildPages(java.lang.Integer siteNodeId, java.lang.String sortAttribute, java.lang.String sortOrder, boolean hideUnauthorizedPages) The method returns a list of WebPage-objects that is the children of the given siteNode.
java.util.List	getChildPages(java.lang.Integer siteNodeId, java.lang.String sortAttribute, java.lang.String sortOrder, 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.
java.util.List	getChildPages(java.lang.String structureBindingName, boolean escapeHTML) The method returns a list of WebPage-objects that is the children of the given siteNode.
java.util.List	getChildPages(java.lang.String structureBindingName, boolean escapeHTML, boolean hideUnauthorizedPages) 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(ContentVersionVO version, java.lang.String attributeName) Finds an attribute on the provided ContentVersion.
java.lang.String	getContentAttribute(ContentVersionVO contentVersionValue, 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.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 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	getContentAttribute(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName, java.util.Set contentVersionId) 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.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 deliveres a String with the content-attribute asked for a specific content and ensure not to get decorated attributes if EditOnSite is turned 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.Integer contentId, java.lang.String attributeName) This method uses the content-attribute to generate a pdf-file.
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.Map	getContentAttributes(java.lang.Integer contentId) This method delivers a map with all unparsed content attributes
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	getContentAttributeUsingLanguageFallback(java.lang.Integer contentId, java.lang.String attributeName, boolean disableEditOnSight) This method deliveres a String with the content-attribute asked for in the language asked for.
java.lang.String	getContentAttributeValue(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName, boolean escapeHTML) This method deliveres a String with the content-attribute asked for in the language asked for.
java.lang.String	getContentAttributeValue(java.lang.Integer contentId, java.lang.String attributeName, boolean escapeHTML) This method deliveres a String with the content-attribute asked for in the language asked for.
java.lang.String	getContentAttributeValue(java.lang.Integer contentId, java.lang.String attributeName, boolean clean, boolean escapeHTML) This method deliveres a String with the content-attribute asked for in the language asked for.
java.lang.String	getContentAttributeWithReturningId(java.lang.Integer contentId, java.lang.Integer languageId, java.lang.String attributeName, boolean clean, java.util.Set contentVersionId) This method deliveres a String with the content-attribute asked for in the language asked for.
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.
java.util.Collection	getContentTypeDefinitionCategories(java.lang.String schemaValue) This method deliveres a list all categories 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
ContentVersionVO	getContentVersionById(java.lang.Integer contentVersionId) Getter for the most recent contentVersion based on a contentVersionId
java.util.List	getContentVersions(java.lang.Integer contentId, java.lang.Integer languageId) Getter for all content versions of a content in a certain language or for all versions no matter language if languageId is null.
java.util.List	getContentVersionsByCategory(java.lang.Integer categoryId, java.lang.String attributeName) This method gets the content related to a category
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() Gets the transaction the controller should work within.
DatabaseWrapper	getDatabaseWrapper()
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.
DocumentConverterHelper	getDocumentTransformerHelper() This method gets the rss utility.
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	getEditOnSightTag(java.lang.Integer contentId, 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.
FormHelper	getFormHelper() This method gets the form utility.
java.lang.Object	getFromContext(java.lang.String name) Gets objects from the context
boolean	getHasLocalizedVersion(java.lang.Integer contentId) This method return true if a localized version with the current language exist
boolean	getHasPrincipalGroup(InfoGluePrincipal infoGluePrincipal, java.lang.String groupName)
boolean	getHasPrincipalRole(InfoGluePrincipal infoGluePrincipal, java.lang.String roleName)
boolean	getHasUserContentAccess(java.lang.Integer contentId) This method return true if the user logged in has access to the content sent in.
boolean	getHasUserContentAccess(java.lang.Integer contentId, java.lang.String action) This method return true if the user logged in has access to do the action on the content sent in.
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.
HttpHelper	getHTTPHelper() This method gets the math utility.
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Getter for request-object
InfoGlueWebServices	getInfoGlueWebServiceHelper() This method gets the webservice utility which has special api:s to call the infoglue system.
java.lang.String	getInlineAssetUrl(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	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	getIsDecorated() A method to check if the current pagenode is decorated with EditOnSight or not.
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.Locale	getLocaleAvailableInTool() 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.lang.String	getLogoutURL() This method returns the logout url.
java.util.List	getMatchingContents(java.lang.String contentTypeDefinitionNamesString, java.lang.String categoryConditionString, boolean useLanguageFallback) This method searches for all contents matching
java.util.List	getMatchingContents(java.lang.String contentTypeDefinitionNamesString, java.lang.String categoryConditionString, java.lang.String freeText, java.util.List freeTextAttributeNames, java.util.Date fromDate, java.util.Date toDate, boolean useLanguageFallback) This method searches for all contents matching
java.util.List	getMatchingContents(java.lang.String contentTypeDefinitionNamesString, java.lang.String categoryConditionString, java.lang.String freeText, java.util.List freeTextAttributeNames, java.util.Date fromDate, java.util.Date toDate, boolean useLanguageFallback, boolean cacheResult, int cacheInterval, java.lang.String cacheName, java.lang.String cacheKey) This method searches for all contents matching
MathHelper	getMathHelper() This method gets the math utility.
java.lang.String	getMetaInfoContentAttribute(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	getMetaInfoContentAttribute(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.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() Deprecated. - Use the new getPageLanguages instead
java.util.List	getNodeAvailableLanguages(java.lang.Integer siteNodeId) Deprecated. - Use the new getPageLanguages instead
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	getOriginalQueryString() This method returns the exact querystring from the original request - not modified
java.lang.String	getOriginalURL() This method returns the exact full url excluding query string from the original request - not modified
java.util.List	getPageAccessRights(java.lang.String interceptionPointName, java.lang.Integer siteNodeId) This method returns an access right list so one can get which roles, groups and users can access the page.
java.lang.String	getPageAsDigitalAssetUrl(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId, java.lang.String fileSuffix, boolean cacheUrl) This method calls an page and stores it as an digitalAsset - that way one can avoid having to serve javascript-files and css-files through InfoGlue.
java.lang.String	getPageBaseUrl() This method deliveres a String with the URL to the page asked for.
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.util.List	getPageLanguages() This method returns a list of all languages available on the current sitenode.
java.util.List	getPageLanguages(java.lang.Integer siteNodeId) This method returns a list of all languages available on the current sitenode.
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.Integer siteNodeId, boolean escapeHTML) 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, boolean escapeHTML) 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	getPageNavTitle(java.lang.String structureBindningName, int index, boolean escapeHTML) 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(ContentVersionVO contentVersionVO, 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(ContentVersionVO contentVersionVO, 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.Integer languageId, 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.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.
java.util.Map	getParsedContentAttributes(java.lang.Integer contentId) This method delivers a map with all parsed content attributes
InfoGluePrincipal	getPrincipal() Returns the logged in user - that is the one currently looking at the page
InfoGluePrincipal	getPrincipal(java.lang.String userName) This method returns the InfoGlue Principal requested
java.util.List	getPrincipalContentVersions(java.lang.String contentTypeDefinitionName, java.lang.String principalName, java.util.Date publishStartDate, java.util.Date publishEndDate, java.util.Date unpublishStartDate, java.util.Date unpublishEndDate) This method searches for all content versions which was last modified by a given user.
java.util.List	getPrincipalGroupCategories(InfoGluePrincipal infoGluePrincipal, java.lang.String groupName, java.lang.String propertyName) Getting all categories assigned to a property for a Role - used for personalisation.
java.util.List	getPrincipalGroupCategories(java.lang.String groupName, java.lang.String propertyName) Getting all categories assigned to a property for a Role - used for personalisation.
java.util.List	getPrincipalGroupRelatedContents(InfoGluePrincipal infoGluePrincipal, java.lang.String groupName, java.lang.String propertyName) Getting all related contents for the current Principals group - used for personalisation.
java.util.List	getPrincipalGroupRelatedContents(java.lang.String groupName, java.lang.String propertyName) Getting all related contents for the current Principals group - used for personalisation.
java.util.List	getPrincipalGroupRelatedPages(InfoGluePrincipal infoGluePrincipal, java.lang.String groupName, java.lang.String propertyName) Getting related pages for a Principals group - used for personalisation.
java.util.List	getPrincipalGroupRelatedPages(InfoGluePrincipal infoGluePrincipal, java.lang.String groupName, java.lang.String propertyName, boolean escapeHTML) Getting related pages for a Principals group - used for personalisation.
java.util.List	getPrincipalGroupRelatedPages(java.lang.String groupName, java.lang.String propertyName) Getting related pages for a Principals group - used for personalisation.
java.util.List	getPrincipalGroupRelatedPages(java.lang.String groupName, java.lang.String propertyName, boolean escapeHTML) Getting related pages for a Principals group - used for personalisation.
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(InfoGluePrincipal infoGluePrincipal, java.lang.String propertyName, boolean escapeSpecialCharacters, boolean findLargestValue) 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.lang.String	getPrincipalPropertyValue(java.lang.String propertyName, boolean escapeSpecialCharacters, boolean findLargestValue) Getting a property for the current Principal - used for personalisation.
java.util.List	getPrincipalRoleCategories(InfoGluePrincipal infoGluePrincipal, java.lang.String roleName, java.lang.String propertyName) Getting all categories assigned to a property for a Group - used for personalisation.
java.util.List	getPrincipalRoleCategories(java.lang.String roleName, java.lang.String propertyName) Getting all categories assigned to a property for a Group - used for personalisation.
java.util.List	getPrincipalRoleRelatedContents(InfoGluePrincipal infoGluePrincipal, java.lang.String roleName, java.lang.String propertyName) Getting all related contents for the current Principals role - used for personalisation.
java.util.List	getPrincipalRoleRelatedContents(java.lang.String roleName, java.lang.String propertyName) Getting all related contents for the current Principals role - used for personalisation.
java.util.List	getPrincipalRoleRelatedPages(InfoGluePrincipal infoGluePrincipal, java.lang.String roleName, java.lang.String propertyName) Getting related pages for a Principals role - used for personalisation.
java.util.List	getPrincipalRoleRelatedPages(InfoGluePrincipal infoGluePrincipal, java.lang.String roleName, java.lang.String propertyName, boolean escapeHTML) Getting related pages for a Principals role - used for personalisation.
java.util.List	getPrincipalRoleRelatedPages(java.lang.String roleName, java.lang.String propertyName) Getting related pages for a Principals role - used for personalisation.
java.util.List	getPrincipalRoleRelatedPages(java.lang.String roleName, java.lang.String propertyName, boolean escapeHTML) Getting related pages for a Principals role - used for personalisation.
java.util.List	getReferencingPages(java.lang.Integer contentId, int maxRows) This method gets a List of pages referencing the given content.
java.util.List	getRelatedContents(InfoGluePrincipal infogluePrincipal, java.lang.String attributeName) This method gets a List of related contents defined in a principal property as an xml-definition.
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.Integer contentId, java.lang.String attributeName, boolean useAttributeLanguageFallBack) 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(InfoGluePrincipal infogluePrincipal, 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.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 attributeName, boolean escapeHTML) 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.util.List	getRelatedPages(java.lang.String bindingName, java.lang.String attributeName, boolean escapeHTML) 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.
java.lang.String	getRepositoryExtraProperty(java.lang.String propertyName) This method gets a property from the extra properties in the repository currently active
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() Getter for the current 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.util.Collection<SiteNodeVO>	getSiteNodesFromWebPages(java.util.Collection webPages) Gets a corresponding list of siteNodeVO:s from a list of webpages.
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.awt.Color foregroundColor, java.awt.Color backgroundColor, java.lang.String backgroundImageUrl)
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	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, java.lang.String backGroundImageUrl)
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 deliveryContextt)
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.util.List	getWorkflowCurrentSteps(java.lang.String workflowId) This method returns the list of hsitorical steps for a workflow instance.
java.util.List	getWorkflowHistoricalSteps(java.lang.String workflowId) This method returns the list of hsitorical steps for a workflow instance.
java.util.List	getWorkflowSteps(java.lang.String workflowId) This method returns the full list of steps for a workflow.
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.
boolean	isPersistedContext()
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	setPersistedContext(boolean persistedContext) If set to true, the current templateLogicContext will be passed to any new templateControllers from this point.
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

META_INFO_BINDING_NAME

public static final java.lang.String META_INFO_BINDING_NAME

See Also:

Constant Field Values

TEMPLATE_ATTRIBUTE_NAME

public static final java.lang.String TEMPLATE_ATTRIBUTE_NAME

See Also:

Constant Field Values

TITLE_ATTRIBUTE_NAME

public static final java.lang.String TITLE_ATTRIBUTE_NAME

See Also:

Constant Field Values

NAV_TITLE_ATTRIBUTE_NAME

public static final java.lang.String NAV_TITLE_ATTRIBUTE_NAME

See Also:

Constant Field Values

USE_LANGUAGE_FALLBACK

protected static final boolean USE_LANGUAGE_FALLBACK

See Also:

Constant Field Values

DO_NOT_USE_LANGUAGE_FALLBACK

protected static final boolean DO_NOT_USE_LANGUAGE_FALLBACK

See Also:

Constant Field Values

USE_INHERITANCE

protected static final boolean USE_INHERITANCE

See Also:

Constant Field Values

DO_NOT_USE_INHERITANCE

protected static final boolean DO_NOT_USE_INHERITANCE

See Also:

Constant Field Values

siteNodeId

protected java.lang.Integer siteNodeId

languageId

protected java.lang.Integer languageId

contentId

protected java.lang.Integer contentId

request

protected javax.servlet.http.HttpServletRequest request

deliveryContext

protected DeliveryContext deliveryContext

browserBean

protected BrowserBean browserBean

nodeDeliveryController

protected NodeDeliveryController nodeDeliveryController

contentDeliveryController

protected ContentDeliveryController contentDeliveryController

integrationDeliveryController

protected IntegrationDeliveryController integrationDeliveryController

componentLogic

protected ComponentLogic componentLogic

infoGluePrincipal

protected InfoGluePrincipal infoGluePrincipal

templateLogicContext

protected java.util.Map templateLogicContext

persistedContext

protected boolean persistedContext

databaseWrapper

protected DatabaseWrapper databaseWrapper

Constructor Detail

BasicTemplateController

public BasicTemplateController(DatabaseWrapper databaseWrapper,
                               InfoGluePrincipal infoGluePrincipal)

The constructor for the templateController. It should be used to initialize the templateController for efficient use.

Method Detail

getDatabase

public org.exolab.castor.jdo.Database getDatabase()
                                           throws SystemException

Gets the transaction the controller should work within. This is to limit the number of connections we use.

Specified by:

getDatabase in interface TemplateController

Throws:

SystemException

getDatabaseWrapper

public DatabaseWrapper getDatabaseWrapper()

Specified by:

getDatabaseWrapper in interface TemplateController

commitDatabase

public void commitDatabase()
                    throws SystemException

Commits and reopens a database object so we don't have to long transaction.

Specified by:

commitDatabase in interface TemplateController

Throws:

SystemException

closeTransaction

public void closeTransaction()
                      throws SystemException

Commit transactions so far so a different call can be made which otherwise gets a deadlock.

Throws:

SystemException

addToContext

public void addToContext(java.lang.String name,
                         java.lang.Object object)

Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc

Specified by:

addToContext in interface TemplateController

addToContext

protected void addToContext(java.util.Map context)

Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc this method adds all objects in the map to the templateLogicContext, the method is protected and is used by getTemplateController to pass on the current context to the new controller if persistedContext is true.

getFromContext

public java.lang.Object getFromContext(java.lang.String name)

Gets objects from the context

setStandardRequestParameters

public 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.

Specified by:

setStandardRequestParameters in interface TemplateController

setHttpRequest

public void setHttpRequest(javax.servlet.http.HttpServletRequest request)

Setter for the template to get all the parameters from the user.

Specified by:

setHttpRequest in interface TemplateController

setBrowserBean

public void setBrowserBean(BrowserBean browserBean)

Setter for the bean which contains information about the users browser.

Specified by:

setBrowserBean in interface TemplateController

getTemplateAttributeName

public java.lang.String getTemplateAttributeName()

Getter for the template attribute name.

Specified by:

getTemplateAttributeName in interface TemplateController

getSiteNodeId

public java.lang.Integer getSiteNodeId()

Getter for the siteNodeId

Specified by:

getSiteNodeId in interface TemplateController

getLanguageId

public java.lang.Integer getLanguageId()

Getter for the languageId

Specified by:

getLanguageId in interface TemplateController

getContentId

public java.lang.Integer getContentId()

Getter for the contentId

Specified by:

getContentId in interface TemplateController

getComponentLogic

public ComponentLogic getComponentLogic()

This method gets a component logic helper object.

Specified by:

getComponentLogic in interface TemplateController

setComponentLogic

public void setComponentLogic(ComponentLogic componentLogic)

This method gets a component logic helper object.

Specified by:

setComponentLogic in interface TemplateController

getVisualFormatter

public VisualFormatter getVisualFormatter()

This method gets the formatter object that helps with formatting of data.

Specified by:

getVisualFormatter in interface TemplateController

getColorHelper

public ColorHelper getColorHelper()

This method gets the color utility.

Specified by:

getColorHelper in interface TemplateController

getFormHelper

public FormHelper getFormHelper()

This method gets the form utility.

getFontHelper

public FontHelper getFontHelper()

This method gets the color utility.

Specified by:

getFontHelper in interface TemplateController

getMathHelper

public MathHelper getMathHelper()

This method gets the math utility.

Specified by:

getMathHelper in interface TemplateController

getHTTPHelper

public HttpHelper getHTTPHelper()

This method gets the math utility.

getChartHelper

public ChartHelper getChartHelper()

This method gets the math utility.

Specified by:

getChartHelper in interface TemplateController

getWebServiceHelper

public WebServiceHelper getWebServiceHelper()

This method gets the webservice utility.

Specified by:

getWebServiceHelper in interface TemplateController

getInfoGlueWebServiceHelper

public InfoGlueWebServices getInfoGlueWebServiceHelper()

This method gets the webservice utility which has special api:s to call the infoglue system.

getNumberFormatHelper

public java.text.NumberFormat getNumberFormatHelper()
                                             throws SystemException

This method gets the NumberFormat instance with the proper locale.

Specified by:

getNumberFormatHelper in interface TemplateController

Throws:

SystemException

getDesEncryptionHelper

public DesEncryptionHelper getDesEncryptionHelper()

This method gets the DesEncryptionHelper.

Specified by:

getDesEncryptionHelper in interface TemplateController

getRssHelper

public RssHelper getRssHelper()

This method gets the rss utility.

Specified by:

getRssHelper in interface TemplateController

getDocumentTransformerHelper

public DocumentConverterHelper getDocumentTransformerHelper()

This method gets the rss utility.

Specified by:

getDocumentTransformerHelper in interface TemplateController

getObjectConverter

public ObjectConverter getObjectConverter()

This method gets the object converter utility.

Specified by:

getObjectConverter in interface TemplateController

getContentAttributes

public java.util.Map getContentAttributes(java.lang.Integer contentId)

This method delivers a map with all unparsed content attributes

getParsedContentAttributes

public java.util.Map getParsedContentAttributes(java.lang.Integer contentId)

This method delivers a map with all parsed content attributes

getContent

public ContentVO getContent()

Getter for the current content

Specified by:

getContent in interface TemplateController

getContent

public ContentVO getContent(java.lang.Integer contentId)

Getter for the current content

Specified by:

getContent in interface TemplateController

getContentVersionById

public ContentVersionVO getContentVersionById(java.lang.Integer contentVersionId)

Getter for the most recent contentVersion based on a contentVersionId

Specified by:

getContentVersionById in interface TemplateController

getContentVersion

public ContentVersionVO getContentVersion(java.lang.Integer contentId)

Getter for the most recent contentVersion on a content

Specified by:

getContentVersion in interface TemplateController

getContentVersion

public ContentVersionVO getContentVersion(java.lang.Integer contentId,
                                          java.lang.Integer languageId,
                                          boolean useLanguageFallback)

Getter for the most recent contentVersion on a content

Specified by:

getContentVersion in interface TemplateController

getContentVersions

public java.util.List getContentVersions(java.lang.Integer contentId,
                                         java.lang.Integer languageId)

Getter for all content versions of a content in a certain language or for all versions no matter language if languageId is null.

Specified by:

getContentVersions in interface TemplateController

getPrincipal

public InfoGluePrincipal getPrincipal()

Returns the logged in user - that is the one currently looking at the page

Specified by:

getPrincipal in interface TemplateController

getAllRoles

public java.util.List getAllRoles()
                           throws java.lang.Exception

Returns a list of InfoGlueRoles

Throws:

java.lang.Exception

getAllGroups

public java.util.List getAllGroups()
                            throws java.lang.Exception

Returns a list of InfoGlueGroups

Throws:

java.lang.Exception

getPrincipal

public InfoGluePrincipal getPrincipal(java.lang.String userName)

This method returns the InfoGlue Principal requested

Specified by:

getPrincipal in interface TemplateController

Parameters:

userName -

getPrincipalPropertyValue

public 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.

Specified by:

getPrincipalPropertyValue in interface TemplateController

getPrincipalPropertyHashValues

public 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.

Specified by:

getPrincipalPropertyHashValues in interface TemplateController

getPrincipalPropertyValue

public 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.

Specified by:

getPrincipalPropertyValue in interface TemplateController

getPrincipalPropertyHashValues

public 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.

Specified by:

getPrincipalPropertyHashValues in interface TemplateController

getPrincipalPropertyValue

public 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.

Specified by:

getPrincipalPropertyValue in interface TemplateController

getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(InfoGluePrincipal infoGluePrincipal,
                                                  java.lang.String propertyName,
                                                  boolean escapeSpecialCharacters,
                                                  boolean findLargestValue)

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

public 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.

Specified by:

getPrincipalPropertyValue in interface TemplateController

getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(java.lang.String propertyName,
                                                  boolean escapeSpecialCharacters,
                                                  boolean findLargestValue)

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

public 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.

Specified by:

getPrincipalPropertyHashValues in interface TemplateController

getPrincipalPropertyHashValues

public 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.

Specified by:

getPrincipalPropertyHashValues in interface TemplateController

getHasPrincipalGroup

public boolean getHasPrincipalGroup(InfoGluePrincipal infoGluePrincipal,
                                    java.lang.String groupName)

getPrincipalGroupRelatedContents

public java.util.List getPrincipalGroupRelatedContents(java.lang.String groupName,
                                                       java.lang.String propertyName)

Getting all related contents for the current Principals group - used for personalisation.

getPrincipalGroupRelatedContents

public java.util.List getPrincipalGroupRelatedContents(InfoGluePrincipal infoGluePrincipal,
                                                       java.lang.String groupName,
                                                       java.lang.String propertyName)

Getting all related contents for the current Principals group - used for personalisation.

getPrincipalGroupRelatedPages

public java.util.List getPrincipalGroupRelatedPages(java.lang.String groupName,
                                                    java.lang.String propertyName)

Getting related pages for a Principals group - used for personalisation.

getPrincipalGroupRelatedPages

public java.util.List getPrincipalGroupRelatedPages(java.lang.String groupName,
                                                    java.lang.String propertyName,
                                                    boolean escapeHTML)

Getting related pages for a Principals group - used for personalisation.

getPrincipalGroupRelatedPages

public java.util.List getPrincipalGroupRelatedPages(InfoGluePrincipal infoGluePrincipal,
                                                    java.lang.String groupName,
                                                    java.lang.String propertyName)

Getting related pages for a Principals group - used for personalisation.

getPrincipalGroupRelatedPages

public java.util.List getPrincipalGroupRelatedPages(InfoGluePrincipal infoGluePrincipal,
                                                    java.lang.String groupName,
                                                    java.lang.String propertyName,
                                                    boolean escapeHTML)

Getting related pages for a Principals group - used for personalisation.

getPrincipalGroupCategories

public java.util.List getPrincipalGroupCategories(java.lang.String groupName,
                                                  java.lang.String propertyName)

Getting all categories assigned to a property for a Role - used for personalisation.

getPrincipalGroupCategories

public java.util.List getPrincipalGroupCategories(InfoGluePrincipal infoGluePrincipal,
                                                  java.lang.String groupName,
                                                  java.lang.String propertyName)

Getting all categories assigned to a property for a Role - used for personalisation.

getHasPrincipalRole

public boolean getHasPrincipalRole(InfoGluePrincipal infoGluePrincipal,
                                   java.lang.String roleName)

getPrincipalRoleRelatedContents

public java.util.List getPrincipalRoleRelatedContents(java.lang.String roleName,
                                                      java.lang.String propertyName)

Getting all related contents for the current Principals role - used for personalisation.

getPrincipalRoleRelatedContents

public java.util.List getPrincipalRoleRelatedContents(InfoGluePrincipal infoGluePrincipal,
                                                      java.lang.String roleName,
                                                      java.lang.String propertyName)

Getting all related contents for the current Principals role - used for personalisation.

getPrincipalRoleRelatedPages

public java.util.List getPrincipalRoleRelatedPages(java.lang.String roleName,
                                                   java.lang.String propertyName)

Getting related pages for a Principals role - used for personalisation.

getPrincipalRoleRelatedPages

public java.util.List getPrincipalRoleRelatedPages(java.lang.String roleName,
                                                   java.lang.String propertyName,
                                                   boolean escapeHTML)

Getting related pages for a Principals role - used for personalisation.

getPrincipalRoleRelatedPages

public java.util.List getPrincipalRoleRelatedPages(InfoGluePrincipal infoGluePrincipal,
                                                   java.lang.String roleName,
                                                   java.lang.String propertyName)

Getting related pages for a Principals role - used for personalisation.

getPrincipalRoleRelatedPages

public java.util.List getPrincipalRoleRelatedPages(InfoGluePrincipal infoGluePrincipal,
                                                   java.lang.String roleName,
                                                   java.lang.String propertyName,
                                                   boolean escapeHTML)

Getting related pages for a Principals role - used for personalisation.

getPrincipalRoleCategories

public java.util.List getPrincipalRoleCategories(java.lang.String roleName,
                                                 java.lang.String propertyName)

Getting all categories assigned to a property for a Group - used for personalisation.

getPrincipalRoleCategories

public java.util.List getPrincipalRoleCategories(InfoGluePrincipal infoGluePrincipal,
                                                 java.lang.String roleName,
                                                 java.lang.String propertyName)

Getting all categories assigned to a property for a Group - used for personalisation.

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Getter for request-object

Specified by:

getHttpServletRequest in interface TemplateController

getRequestParamenterNames

public java.util.Enumeration getRequestParamenterNames()

Getter for request-parameters

Specified by:

getRequestParamenterNames in interface TemplateController

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String parameterName)

Getter for request-parameter

Specified by:

getRequestParameter in interface TemplateController

getRequestParameterValues

public java.lang.String[] getRequestParameterValues(java.lang.String parameterName)

Getter for request-parameters

Specified by:

getRequestParameterValues in interface TemplateController

getBrowserBean

public BrowserBean getBrowserBean()

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

Specified by:

getBrowserBean in interface TemplateController

setDeliveryControllers

public void setDeliveryControllers(NodeDeliveryController nodeDeliveryController,
                                   ContentDeliveryController contentDeliveryController,
                                   IntegrationDeliveryController integrationDeliveryController)

Setting to enable us to set initialized versions of the Node and Content delivery Controllers.

Specified by:

setDeliveryControllers in interface TemplateController

getAssignedCategories

public java.util.List getAssignedCategories(java.lang.Integer contentId,
                                            java.lang.String categoryKey,
                                            java.lang.Integer languageId,
                                            boolean useLanguageFallback)

This method gets assignedCategories for a content on a specific categoryKey.

Specified by:

getAssignedCategories in interface TemplateController

getCategoryPath

public java.lang.String getCategoryPath(java.lang.Integer categoryId)

This method gets the full path/name of a given categoryId.

Specified by:

getCategoryPath in interface TemplateController

getContentAttribute

public 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.

Specified by:

getContentAttribute in interface TemplateController

getContentAttribute

public 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.

Specified by:

getContentAttribute in interface TemplateController

getContentAttribute

public java.lang.String getContentAttribute(java.lang.Integer contentId,
                                            java.lang.String attributeName,
                                            boolean clean)

This method deliveres a String with the content-attribute asked for a specific content and ensure not to get decorated attributes if EditOnSite is turned on.

Specified by:

getContentAttribute in interface TemplateController

Parameters:

contentId - the contentId of a content

attributeName - the attribute name in the content. (ie. Title, Leadin etc)

clean - has no effect in this class.

Returns:

the contentAttribute or empty string if none found.

See Also:

org.infoglue.deliver.controllers.kernel.impl.simple.EditOnSiteTemplateController#getContentAttribute(java.lang.String, boolean)

getContentAttribute

public java.lang.String getContentAttribute(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.

Specified by:

getContentAttribute in interface TemplateController

getContentAttribute

public java.lang.String getContentAttribute(ContentVersionVO contentVersionValue,
                                            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.

Specified by:

getContentAttribute in interface TemplateController

getMetaInfoContentAttribute

public java.lang.String getMetaInfoContentAttribute(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.

Specified by:

getMetaInfoContentAttribute in interface TemplateController

getContentAttributeWithReturningId

public java.lang.String getContentAttributeWithReturningId(java.lang.Integer contentId,
                                                           java.lang.Integer languageId,
                                                           java.lang.String attributeName,
                                                           boolean clean,
                                                           java.util.Set contentVersionId)

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.

Specified by:

getContentAttributeWithReturningId in interface TemplateController

getContentAttribute

public 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.

Specified by:

getContentAttribute in interface TemplateController

getContentAttribute

public 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.

Specified by:

getContentAttribute in interface TemplateController

getContentAttribute

public 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.

Specified by:

getContentAttribute in interface TemplateController

getContentAttributeValue

public java.lang.String getContentAttributeValue(java.lang.Integer contentId,
                                                 java.lang.String attributeName,
                                                 boolean escapeHTML)

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.

getContentAttributeValue

public java.lang.String getContentAttributeValue(java.lang.Integer contentId,
                                                 java.lang.String attributeName,
                                                 boolean clean,
                                                 boolean escapeHTML)

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.

getContentAttributeValue

public java.lang.String getContentAttributeValue(java.lang.Integer contentId,
                                                 java.lang.Integer languageId,
                                                 java.lang.String attributeName,
                                                 boolean escapeHTML)

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.

getContentAttribute

public 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.

Specified by:

getContentAttribute in interface TemplateController

getMetaInfoContentAttribute

public java.lang.String getMetaInfoContentAttribute(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.

getContentAttribute

public java.lang.String getContentAttribute(java.lang.Integer contentId,
                                            java.lang.Integer languageId,
                                            java.lang.String attributeName,
                                            java.util.Set contentVersionId)

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.

getContentAttribute

public java.lang.String getContentAttribute(ContentVersionVO version,
                                            java.lang.String attributeName)

Finds an attribute on the provided ContentVersion.

getContentAttributeUsingLanguageFallback

public java.lang.String getContentAttributeUsingLanguageFallback(java.lang.Integer contentId,
                                                                 java.lang.String attributeName,
                                                                 boolean disableEditOnSight)

This method deliveres a String with the content-attribute asked for in the language asked for. If the attribute is not found in the language requested it fallbacks to the master language.

Specified by:

getContentAttributeUsingLanguageFallback in interface TemplateController

getParsedContentAttribute

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public java.lang.String getParsedContentAttribute(java.lang.Integer contentId,
                                                  java.lang.Integer languageId,
                                                  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

public java.lang.String getParsedContentAttribute(ContentVersionVO contentVersionVO,
                                                  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

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public 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.

Specified by:

getParsedContentAttribute in interface TemplateController

getParsedContentAttribute

public java.lang.String getParsedContentAttribute(ContentVersionVO contentVersionVO,
                                                  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.

Specified by:

getParsedContentAttribute in interface TemplateController

getAssetKeys

public java.util.Collection getAssetKeys(java.lang.String contentBindningName)

This method deliveres a list of strings which represents all assetKeys for a content.

Specified by:

getAssetKeys in interface TemplateController

getAssetKeys

public java.util.Collection getAssetKeys(java.lang.Integer contentId)

This method deliveres a list of strings which represents all assetKeys for a content.

Specified by:

getAssetKeys in interface TemplateController

getAssetIds

public java.util.Collection getAssetIds(java.lang.Integer contentId)

This method deliveres a list of strings which represents all assetKeys for a content.

Specified by:

getAssetIds in interface TemplateController

getAssets

public java.util.Collection getAssets(java.lang.Integer contentId)

This method deliveres a list of DigitalAssetVO-objects which represents all assets for a content.

Specified by:

getAssets in interface TemplateController

getContentTypeDefinitionAssetKeys

public java.util.Collection getContentTypeDefinitionAssetKeys(java.lang.String schemaValue)

This method deliveres a list of strings which represents all assetKeys defined for a contentTypeDefinition.

Specified by:

getContentTypeDefinitionAssetKeys in interface TemplateController

getContentTypeDefinitionCategories

public java.util.Collection getContentTypeDefinitionCategories(java.lang.String schemaValue)

This method deliveres a list all categories defined for a contentTypeDefinition.

Specified by:

getContentTypeDefinitionCategories in interface TemplateController

getAssetThumbnailUrl

public 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.

Specified by:

getAssetThumbnailUrl in interface TemplateController

getAssetThumbnailUrl

public 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.

Specified by:

getAssetThumbnailUrl in interface TemplateController

getAssetThumbnailUrlForAssetWithId

public java.lang.String getAssetThumbnailUrlForAssetWithId(java.lang.Integer digitalAssetId,
                                                           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.

Specified by:

getAssetThumbnailUrlForAssetWithId in interface TemplateController

getAssetThumbnailUrl

public 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.

Specified by:

getAssetThumbnailUrl in interface TemplateController

getAssetThumbnailUrl

public 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.

Specified by:

getAssetThumbnailUrl in interface TemplateController

getAssetUrl

public 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.

Specified by:

getAssetUrl in interface TemplateController

getEncodedUrl

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

Specified by:

getEncodedUrl in interface TemplateController

getAssetUrl

public java.lang.String getAssetUrl(java.lang.Integer contentId)

This method deliveres a String with the URL to the digital asset asked for.

Specified by:

getAssetUrl in interface TemplateController

getAssetUrl

public 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.

Specified by:

getAssetUrl in interface TemplateController

getAssetUrlForAssetWithId

public java.lang.String getAssetUrlForAssetWithId(java.lang.Integer digitalAssetId)

This method deliveres a String with the URL to the digital asset asked for.

Specified by:

getAssetUrlForAssetWithId in interface TemplateController

getAssetUrl

public 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.

Specified by:

getAssetUrl in interface TemplateController

getAssetUrl

public 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.

Specified by:

getAssetUrl in interface TemplateController

getAssetUrl

public java.lang.String getAssetUrl(InfoGluePrincipal principal,
                                    java.lang.String assetKey,
                                    java.lang.Integer languageId,
                                    java.lang.Integer siteNodeId,
                                    boolean useLanguageFallback)

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.

getAssetThumbnailUrl

public java.lang.String getAssetThumbnailUrl(InfoGluePrincipal principal,
                                             java.lang.String assetKey,
                                             java.lang.Integer languageId,
                                             java.lang.Integer siteNodeId,
                                             boolean useLanguageFallback,
                                             int width,
                                             int height)

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

public 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.

Specified by:

getInlineAssetUrl in interface TemplateController

getInlineAssetUrl

public java.lang.String getInlineAssetUrl(java.lang.Integer contentId,
                                          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.

Specified by:

getInlineAssetUrl in interface TemplateController

getAssetFileSize

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

Specified by:

getAssetFileSize in interface TemplateController

getAssetFileSize

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

Specified by:

getAssetFileSize in interface TemplateController

getAssetFileSize

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

Specified by:

getAssetFileSize in interface TemplateController

getAssetFileSizeForAssetWithId

public java.lang.Integer getAssetFileSizeForAssetWithId(java.lang.Integer digitalAssetId)

Returns assetFileSize for a digital asset identified by id.

Parameters:

digitalAssetId -

Returns:

getAssetFileSize

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

Specified by:

getAssetFileSize in interface TemplateController

getRelatedContentsByQualifyer

public 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.

Specified by:

getRelatedContentsByQualifyer in interface TemplateController

getRelatedContents

public 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.

Specified by:

getRelatedContents in interface TemplateController

getRelatedContents

public 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.

Specified by:

getRelatedContents in interface TemplateController

getRelatedContents

public 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.

Specified by:

getRelatedContents in interface TemplateController

getRelatedContents

public java.util.List getRelatedContents(java.lang.Integer contentId,
                                         java.lang.String attributeName,
                                         boolean useAttributeLanguageFallBack)

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.

Specified by:

getRelatedContents in interface TemplateController

getRelatedContents

public java.util.List getRelatedContents(InfoGluePrincipal infogluePrincipal,
                                         java.lang.String attributeName)

This method gets a List of related contents defined in a principal property as an xml-definition.

getRelatedPages

public 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.

Specified by:

getRelatedPages in interface TemplateController

getRelatedPages

public java.util.List getRelatedPages(java.lang.String attributeName,
                                      boolean escapeHTML)

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

public 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.

Specified by:

getRelatedPages in interface TemplateController

getRelatedPages

public java.util.List getRelatedPages(java.lang.String bindingName,
                                      java.lang.String attributeName,
                                      boolean escapeHTML)

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

public 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.

Specified by:

getRelatedPages in interface TemplateController

getRelatedPages

public java.util.List getRelatedPages(InfoGluePrincipal infogluePrincipal,
                                      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.

getReferencingPages

public java.util.List getReferencingPages(java.lang.Integer contentId,
                                          int maxRows)

This method gets a List of pages referencing the given content.

Specified by:

getReferencingPages in interface TemplateController

getArchiveBaseUrl

public 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.

Specified by:

getArchiveBaseUrl in interface TemplateController

getArchiveBaseUrlForAssetWithId

public java.lang.String getArchiveBaseUrlForAssetWithId(java.lang.Integer digitalAssetId)

This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset identified by a digitalAssetId.

getArchiveBaseUrl

public 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.

Specified by:

getArchiveBaseUrl in interface TemplateController

getArchiveEntries

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

Specified by:

getArchiveEntries in interface TemplateController

getArchiveBaseUrl

public 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.

Specified by:

getArchiveBaseUrl in interface TemplateController

getContentAttributeAsPDFUrl

public 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.

Specified by:

getContentAttributeAsPDFUrl in interface TemplateController

getContentAttributeAsPDFUrl

public java.lang.String getContentAttributeAsPDFUrl(java.lang.Integer contentId,
                                                    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.

getContentAttributeAsImageUrl

public 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.)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getRenderedTextUrl

public 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.

Specified by:

getRenderedTextUrl in interface TemplateController

Parameters:

contentId - a content id containing attributes to tell the image renderer how to look.

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 or text is null or empty

getRenderedTextUrl

public 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.

Specified by:

getRenderedTextUrl in interface TemplateController

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 or text is null or empty

getContentAttributeAsImageUrl

public 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)

Specified by:

getContentAttributeAsImageUrl in interface TemplateController

getContentAttributes

public java.util.List getContentAttributes(java.lang.String schemaValue)

This method returns a list of elements/attributes based on the contentType sent in.

Specified by:

getContentAttributes in interface TemplateController

getStringAsImageUrl

public 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.

Specified by:

getStringAsImageUrl in interface TemplateController

getStringAsImageUrl

public 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,
                                            java.lang.String backGroundImageUrl)

getStringAsImageUrl

public 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)

Specified by:

getStringAsImageUrl in interface TemplateController

getStringAsImageUrl

public 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 backgroundImageUrl)

getDigitalAssetBaseUrl

public java.lang.String getDigitalAssetBaseUrl()
                                        throws java.lang.Exception

This method returns the base url for the digital assets.

Specified by:

getDigitalAssetBaseUrl in interface TemplateController

Throws:

java.lang.Exception

getDigitalAssetId

public java.lang.Integer getDigitalAssetId(java.lang.Integer contentId,
                                           java.lang.String assetKey)
                                    throws java.lang.Exception

This method returns the Id the digital assets.

Specified by:

getDigitalAssetId in interface TemplateController

Throws:

java.lang.Exception

getDigitalAssetId

public 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.

Specified by:

getDigitalAssetId in interface TemplateController

Throws:

java.lang.Exception

getRepositoryExtraProperty

public java.lang.String getRepositoryExtraProperty(java.lang.String propertyName)

This method gets a property from the extra properties in the repository currently active

getRepositoryBaseUrl

public java.lang.String getRepositoryBaseUrl()
                                      throws java.lang.Exception

This method returns the base url for the digital assets.

Specified by:

getRepositoryBaseUrl in interface TemplateController

Throws:

java.lang.Exception

getRepositoryRootSiteNode

public SiteNodeVO getRepositoryRootSiteNode()
                                     throws java.lang.Exception

This method returns the root node for the current repository.

Specified by:

getRepositoryRootSiteNode in interface TemplateController

Throws:

java.lang.Exception

getRepositoryRootSiteNode

public SiteNodeVO getRepositoryRootSiteNode(java.lang.Integer repositoryId)
                                     throws java.lang.Exception

This method returns the root node for the current repository.

Specified by:

getRepositoryRootSiteNode in interface TemplateController

Throws:

java.lang.Exception

getParentRepositoryId

public java.lang.Integer getParentRepositoryId(java.lang.Integer repositoryId)

This method returns the parent repositoryId if any for the given repository.

Specified by:

getParentRepositoryId in interface TemplateController

getParentRepositoryId

public java.lang.Integer getParentRepositoryId()

This method returns the parent repositoryId if any for the given repository.

Specified by:

getParentRepositoryId in interface TemplateController

getPageUrl

public 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.

Specified by:

getPageUrl in interface TemplateController

getPageUrl

public java.lang.String getPageUrl(WebPage webpage,
                                   java.lang.Integer contentId)

This method just gets a new URL but with the given contentId in it.

Specified by:

getPageUrl in interface TemplateController

getPageBaseUrl

public 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.

Specified by:

getPageBaseUrl in interface TemplateController

getPageBaseUrl

public java.lang.String getPageBaseUrl()

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.

getSiteNode

public SiteNodeVO getSiteNode()

Getter for the current siteNode

Specified by:

getSiteNode in interface TemplateController

getSiteNode

public SiteNodeVO getSiteNode(java.lang.Integer siteNodeId)

This method fetches the given siteNode

Specified by:

getSiteNode in interface TemplateController

getSiteNodeId

public java.lang.Integer getSiteNodeId(java.lang.String structureBindningName)

Getter for the siteNodeId on a specific bound page

Specified by:

getSiteNodeId in interface TemplateController

getSiteNodesFromWebPages

public java.util.Collection<SiteNodeVO> getSiteNodesFromWebPages(java.util.Collection webPages)

Gets a corresponding list of siteNodeVO:s from a list of webpages.

Specified by:

getSiteNodesFromWebPages in interface TemplateController

getContentId

public java.lang.Integer getContentId(java.lang.String contentBindningName)

Getter for bound contentId for a binding

Specified by:

getContentId in interface TemplateController

getMetaInformationContentId

public java.lang.Integer getMetaInformationContentId()

This method gets the meta information of the current sitenode.

Specified by:

getMetaInformationContentId in interface TemplateController

getMetaInformationContentId

public java.lang.Integer getMetaInformationContentId(java.lang.Integer siteNodeId)

This method gets the meta information of a particular sitenode.

Specified by:

getMetaInformationContentId in interface TemplateController

getChildContents

public java.util.Collection getChildContents(java.lang.Integer contentId,
                                             boolean includeFolders)

This method gets the children of a content.

Specified by:

getChildContents in interface TemplateController

getContentId

public java.lang.Integer getContentId(java.lang.Integer siteNodeId,
                                      java.lang.String contentBindningName)

Getter for bound contentId for a binding on a special siteNode

Specified by:

getContentId in interface TemplateController

getContentVersionsByCategory

public java.util.List getContentVersionsByCategory(java.lang.Integer categoryId,
                                                   java.lang.String attributeName)

This method gets the content related to a category

Specified by:

getContentVersionsByCategory in interface TemplateController

Parameters:

categoryId - The id of the Category

attributeName - The ContentTypeDefinition attribute name of the Category relationship.

Returns:

A list of relevant CategoryVersionVOs

getPrincipalContentVersions

public java.util.List getPrincipalContentVersions(java.lang.String contentTypeDefinitionName,
                                                  java.lang.String principalName,
                                                  java.util.Date publishStartDate,
                                                  java.util.Date publishEndDate,
                                                  java.util.Date unpublishStartDate,
                                                  java.util.Date unpublishEndDate)

This method searches for all content versions which was last modified by a given user.

Specified by:

getPrincipalContentVersions in interface TemplateController

getMatchingContents

public java.util.List getMatchingContents(java.lang.String contentTypeDefinitionNamesString,
                                          java.lang.String categoryConditionString,
                                          boolean useLanguageFallback)

This method searches for all contents matching

Specified by:

getMatchingContents in interface TemplateController

getMatchingContents

public java.util.List getMatchingContents(java.lang.String contentTypeDefinitionNamesString,
                                          java.lang.String categoryConditionString,
                                          java.lang.String freeText,
                                          java.util.List freeTextAttributeNames,
                                          java.util.Date fromDate,
                                          java.util.Date toDate,
                                          boolean useLanguageFallback)

This method searches for all contents matching

Specified by:

getMatchingContents in interface TemplateController

getMatchingContents

public java.util.List getMatchingContents(java.lang.String contentTypeDefinitionNamesString,
                                          java.lang.String categoryConditionString,
                                          java.lang.String freeText,
                                          java.util.List freeTextAttributeNames,
                                          java.util.Date fromDate,
                                          java.util.Date toDate,
                                          boolean useLanguageFallback,
                                          boolean cacheResult,
                                          int cacheInterval,
                                          java.lang.String cacheName,
                                          java.lang.String cacheKey)

This method searches for all contents matching

Specified by:

getMatchingContents in interface TemplateController

getOperatingMode

public 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.

Specified by:

getOperatingMode in interface TemplateController

getPageUrl

public 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.

Specified by:

getPageUrl in interface TemplateController

getPageUrlOnPosition

public 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.

Specified by:

getPageUrlOnPosition in interface TemplateController

getPageUrl

public 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.

Specified by:

getPageUrl in interface TemplateController

getCurrentPageUrl

public 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.

Specified by:

getCurrentPageUrl in interface TemplateController

getOriginalURL

public java.lang.String getOriginalURL()

This method returns the exact full url excluding query string from the original request - not modified

Specified by:

getOriginalURL in interface TemplateController

Returns:

getOriginalQueryString

public java.lang.String getOriginalQueryString()

This method returns the exact querystring from the original request - not modified

Specified by:

getOriginalQueryString in interface TemplateController

Returns:

getOriginalFullURL

public java.lang.String getOriginalFullURL()

This method returns the exact full url from the original request - not modified

Specified by:

getOriginalFullURL in interface TemplateController

Returns:

getPageUrl

public 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.

Specified by:

getPageUrl in interface TemplateController

getPageAsDigitalAssetUrl

public java.lang.String getPageAsDigitalAssetUrl(java.lang.Integer siteNodeId,
                                                 java.lang.Integer languageId,
                                                 java.lang.Integer contentId,
                                                 java.lang.String fileSuffix,
                                                 boolean cacheUrl)

This method calls an page and stores it as an digitalAsset - that way one can avoid having to serve javascript-files and css-files through InfoGlue. Not suitable for use if you have very dynamic css:es or scripts which includes logic depending on user info etc.. mostly usable if you have a static css or controls it on the pageCache parameters.

Specified by:

getPageAsDigitalAssetUrl in interface TemplateController

getCurrentPagePath

public 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.

Specified by:

getCurrentPagePath in interface TemplateController

getParentSiteNode

public SiteNodeVO getParentSiteNode(java.lang.Integer siteNodeId)

This method returns the parent siteNode to the given siteNode.

Specified by:

getParentSiteNode in interface TemplateController

getPageUrlAfterLanguageChange

public 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.

Specified by:

getPageUrlAfterLanguageChange in interface TemplateController

getPageTitle

public 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.

Specified by:

getPageTitle in interface TemplateController

getPageNavTitle

public 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.

Specified by:

getPageNavTitle in interface TemplateController

getPageNavTitle

public java.lang.String getPageNavTitle(java.lang.String structureBindningName,
                                        boolean escapeHTML)

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

public 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.

Specified by:

getPageNavTitle in interface TemplateController

getPageNavTitle

public java.lang.String getPageNavTitle(java.lang.Integer siteNodeId,
                                        boolean escapeHTML)

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

public 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.

Specified by:

getPageNavTitle in interface TemplateController

getPageNavTitle

public java.lang.String getPageNavTitle(java.lang.String structureBindningName,
                                        int index,
                                        boolean escapeHTML)

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

public 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.

Specified by:

getIsPageCacheDisabled in interface TemplateController

getPageContentType

public java.lang.String getPageContentType()

This method returns the contenttype this page should return. This is important when sending assets or css:contents.

Specified by:

getPageContentType in interface TemplateController

getIsPageProtected

public 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.

Specified by:

getIsPageProtected in interface TemplateController

getIsInPageComponentMode

public boolean getIsInPageComponentMode()

Description copied from interface: TemplateController

This method returns true if the user is in component editor mode.

Specified by:

getIsInPageComponentMode in interface TemplateController

getIsEditOnSightDisabled

public 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.

Specified by:

getIsEditOnSightDisabled in interface TemplateController

getAvailableLanguages

public java.util.List getAvailableLanguages()

This method returns a list of all languages available on the current site/repository.

Specified by:

getAvailableLanguages in interface TemplateController

getNodeAvailableLanguages

public java.util.List getNodeAvailableLanguages()

Deprecated. - Use the new getPageLanguages instead

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.

Specified by:

getNodeAvailableLanguages in interface TemplateController

getNodeAvailableLanguages

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

Deprecated. - Use the new getPageLanguages instead

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.

Specified by:

getNodeAvailableLanguages in interface TemplateController

getPageLanguages

public java.util.List getPageLanguages()

This method returns a list of all languages available on the current sitenode. This method will return all languages enabled for this repository minus any disabled languages for the siteNode.

Specified by:

getPageLanguages in interface TemplateController

getPageLanguages

public java.util.List getPageLanguages(java.lang.Integer siteNodeId)

This method returns a list of all languages available on the current sitenode. This method will return all languages enabled for this repository minus any disabled languages for the siteNode.

Specified by:

getPageLanguages in interface TemplateController

getChildPages

public 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.

Specified by:

getChildPages in interface TemplateController

getChildPages

public java.util.List getChildPages(boolean escapeHTML)

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

public java.util.List getChildPages(boolean escapeHTML,
                                    boolean hideUnauthorizedPages)

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

public 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.

Specified by:

getChildPages in interface TemplateController

getChildPages

public java.util.List getChildPages(java.lang.String structureBindingName,
                                    boolean escapeHTML)

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

public java.util.List getChildPages(java.lang.String structureBindingName,
                                    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

public 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.

Specified by:

getChildPages in interface TemplateController

getChildPages

public java.util.List getChildPages(java.lang.Integer siteNodeId,
                                    boolean escapeHTML)

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

public 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.

Specified by:

getChildPages in interface TemplateController

getChildPages

public java.util.List getChildPages(java.lang.Integer siteNodeId,
                                    java.lang.String sortAttribute,
                                    java.lang.String sortOrder)

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

public java.util.List getChildPages(java.lang.Integer siteNodeId,
                                    java.lang.String sortAttribute,
                                    java.lang.String sortOrder,
                                    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

public java.util.List getChildPages(java.lang.Integer siteNodeId,
                                    java.lang.String sortAttribute,
                                    java.lang.String sortOrder,
                                    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.

getBoundPages

public java.util.List getBoundPages(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.

Specified by:

getBoundPages in interface TemplateController

getBoundPages

public java.util.List getBoundPages(java.lang.String structureBindningName,
                                    boolean escapeHTML)

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.

getBoundPages

public java.util.List getBoundPages(java.lang.String structureBindningName,
                                    boolean escapeHTML,
                                    boolean hideUnauthorizedPages)

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.

getBoundPages

public java.util.List getBoundPages(java.lang.Integer siteNodeId,
                                    java.lang.String structureBindningName)

Description copied from interface: TemplateController

This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.

Specified by:

getBoundPages in interface TemplateController

getBoundPages

public java.util.List getBoundPages(java.lang.Integer siteNodeId,
                                    java.lang.String structureBindningName,
                                    boolean escapeHTML)

getBoundPages

public java.util.List getBoundPages(java.lang.Integer siteNodeId,
                                    java.lang.String structureBindningName,
                                    boolean escapeHTML,
                                    boolean hideUnauthorizedPages)

This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.

getLocalizedBoundPages

public 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.

Specified by:

getLocalizedBoundPages in interface TemplateController

getBoundContent

public 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.

Specified by:

getBoundContent in interface TemplateController

getBoundContents

public 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.

Specified by:

getBoundContents in interface TemplateController

getBoundFolderContents

public 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.

Specified by:

getBoundFolderContents in interface TemplateController

getBoundFolderContents

public 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.

Specified by:

getBoundFolderContents in interface TemplateController

getChildContents

public 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.

Specified by:

getChildContents in interface TemplateController

getChildContents

public 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.

Specified by:

getChildContents in interface TemplateController

getContentTypeDefinitionVO

public ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.Integer contentId)

The method returns the ContentTypeVO-objects of the given contentId.

Specified by:

getContentTypeDefinitionVO in interface TemplateController

getContentTypeDefinitionVO

public ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.String name)

The method returns the ContentTypeVO-object with the given name.

Specified by:

getContentTypeDefinitionVO in interface TemplateController

getBoundPage

public 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.

Specified by:

getBoundPage in interface TemplateController

renderString

public java.lang.String renderString(java.lang.String template)

This method allows a user to get any string rendered as a template.

Specified by:

renderString in interface TemplateController

renderString

public java.lang.String renderString(java.lang.String template,
                                     boolean useSubContext)

This method allows a user to get any string rendered as a template.

Specified by:

renderString in interface TemplateController

include

public 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.

Specified by:

include in interface TemplateController

include

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

Specified by:

include in interface TemplateController

include

public 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.

Specified by:

include in interface TemplateController

getUrlContent

public 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.

Specified by:

getUrlContent in interface TemplateController

getUrlContent

public 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.

Specified by:

getUrlContent in interface TemplateController

getUrlContent

public 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.

Specified by:

getUrlContent in interface TemplateController

getUrlContent

public 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.

Specified by:

getUrlContent in interface TemplateController

getObjectWithName

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

Specified by:

getObjectWithName in interface TemplateController

replace

public 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.

Specified by:

replace in interface TemplateController

replace

public 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.

Specified by:

replace in interface TemplateController

getIsCurrentSiteNode

public 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.

Specified by:

getIsCurrentSiteNode in interface TemplateController

getIsParentToCurrent

public 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.

Specified by:

getIsParentToCurrent in interface TemplateController

getHasLocalizedVersion

public boolean getHasLocalizedVersion(java.lang.Integer contentId)

This method return true if a localized version with the current language exist

Specified by:

getHasLocalizedVersion in interface TemplateController

getAccessRights

public java.util.List getAccessRights(java.lang.String interceptionPointName,
                                      java.lang.String parameters)

This method returns an access right list so one can get which roles, groups and users can access the page.

Specified by:

getAccessRights in interface TemplateController

getPageAccessRights

public java.util.List getPageAccessRights(java.lang.String interceptionPointName,
                                          java.lang.Integer siteNodeId)

This method returns an access right list so one can get which roles, groups and users can access the page.

Specified by:

getPageAccessRights in interface TemplateController

getHasUserPageAccess

public boolean getHasUserPageAccess(java.lang.Integer siteNodeId)

This method return true if the user logged in has access to the siteNode sent in.

Specified by:

getHasUserPageAccess in interface TemplateController

getHasUserPageAccess

public 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.

Specified by:

getHasUserPageAccess in interface TemplateController

getHasUserContentAccess

public boolean getHasUserContentAccess(java.lang.Integer contentId)

This method return true if the user logged in has access to the content sent in.

Specified by:

getHasUserContentAccess in interface TemplateController

getHasUserContentAccess

public boolean getHasUserContentAccess(java.lang.Integer contentId,
                                       java.lang.String action)

This method return true if the user logged in has access to do the action on the content sent in.

getHasUserPageWriteAccess

public boolean getHasUserPageWriteAccess(java.lang.Integer siteNodeId)

This method return true if the user logged in has access to the siteNode sent in.

Specified by:

getHasUserPageWriteAccess in interface TemplateController

getFormAttributes

public 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.

Specified by:

getFormAttributes in interface TemplateController

getFormAttributes

public 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.

Specified by:

getFormAttributes in interface TemplateController

getWorkflowSteps

public java.util.List getWorkflowSteps(java.lang.String workflowId)

This method returns the full list of steps for a workflow.

getWorkflowHistoricalSteps

public java.util.List getWorkflowHistoricalSteps(java.lang.String workflowId)

This method returns the list of hsitorical steps for a workflow instance.

getWorkflowCurrentSteps

public java.util.List getWorkflowCurrentSteps(java.lang.String workflowId)

This method returns the list of hsitorical steps for a workflow instance.

setCookie

public 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.

Specified by:

setCookie in interface TemplateController

Parameters:

cookieName -

value -

domain -

path -

maxAge -

getCookie

public java.lang.String getCookie(java.lang.String cookieName)

This method gets a cookie.

Specified by:

getCookie in interface TemplateController

Parameters:

cookieName -

getLanguage

public LanguageVO getLanguage(java.lang.Integer languageId)

This method supplies a method to get the locale of the language currently in use.

Specified by:

getLanguage in interface TemplateController

getLanguage

public LanguageVO getLanguage(java.lang.String languageCode)

This method supplies a method to get the locale of the language currently in use.

Specified by:

getLanguage in interface TemplateController

getLanguageCode

public java.util.Locale getLanguageCode(java.lang.Integer languageId)
                                 throws SystemException

This method supplies a method to get the locale of the language sent in.

Specified by:

getLanguageCode in interface TemplateController

Throws:

SystemException

getLocale

public java.util.Locale getLocale()
                           throws SystemException

This method supplies a method to get the locale of the language currently in use.

Specified by:

getLocale in interface TemplateController

Throws:

SystemException

getLocaleAvailableInTool

public java.util.Locale getLocaleAvailableInTool()
                                          throws SystemException

This method supplies a method to get the locale of the language currently in use.

Specified by:

getLocaleAvailableInTool in interface TemplateController

Throws:

SystemException

getLogoutURL

public java.lang.String getLogoutURL()
                              throws java.lang.Exception

This method returns the logout url.

Throws:

java.lang.Exception

getTemplateController

public 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.

Specified by:

getTemplateController in interface TemplateController

Throws:

SystemException

java.lang.Exception

getTemplateController

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

Specified by:

getTemplateController in interface TemplateController

Throws:

SystemException

java.lang.Exception

decoratePage

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

Specified by:

decoratePage in interface TemplateController

getEditOnSightTag

public java.lang.String getEditOnSightTag(java.lang.Integer contentId,
                                          java.lang.String attributeName,
                                          java.lang.String html,
                                          boolean showInPublishedMode)

This method adds the neccessairy html to a output for it to be editable. It returns an empty string if the delivery engine is in published mode and the showInPublishedMode is not set to true. Otherwise it shows the htnl you sent in within a clickable tag.

getEditOnSightTag

public 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. It returns an empty string if the delivery engine is in published mode and the showInPublishedMode is not set to true. Otherwise it shows the htnl you sent in within a clickable tag.

Specified by:

getEditOnSightTag in interface TemplateController

getAssignPropertyBindingTag

public 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.

Specified by:

getAssignPropertyBindingTag in interface TemplateController

Parameters:

componentContentId -

propertyName -

html -

showInPublishedMode -

Returns:

getDeliveryContext

public DeliveryContext getDeliveryContext()

Specified by:

getDeliveryContext in interface TemplateController

setDeliveryContext

public void setDeliveryContext(DeliveryContext deliveryContext)

Specified by:

setDeliveryContext in interface TemplateController

isPersistedContext

public boolean isPersistedContext()

Returns:

true if this TemplateController will persist the templateLogic context in nested parsing.

setPersistedContext

public void setPersistedContext(boolean persistedContext)

If set to true, the current templateLogicContext will be passed to any new templateControllers from this point. New TemplateControllers are created in all nested parsing of the template, like include getParsedContentAttribute etc.

Parameters:

persistedContext -

getThreatFoldersAsContents

public boolean getThreatFoldersAsContents()

Specified by:

getThreatFoldersAsContents in interface TemplateController

setThreatFoldersAsContents

public void setThreatFoldersAsContents(boolean threatFoldersAsContents)

Specified by:

setThreatFoldersAsContents in interface TemplateController

getIsDecorated

public boolean getIsDecorated()

A method to check if the current pagenode is decorated with EditOnSight or not. Checks if it's the BasicTemplateController or the EditOnSiteBasicTemplateController which is used as a render.

Specified by:

getIsDecorated in interface TemplateController

Returns:

true if the pagenode is rendered with EditOnSight decoration.