com.jalios.jcms

Class Channel

java.lang.Object

com.jalios.jcms.Channel

All Implemented Interfaces:

JcmsConstants, JaliosConstants, JPropertiesListener

public class Channel
extends java.lang.Object
implements JcmsConstants, JPropertiesListener

The Channel singleton is the main access point of the JCMS API.
This singleton is initialized automatically on startup by the servlet ChannelInitServlet declared in web.xml.

The following methods of Channel may be useful for your developments in JCMS.

Retrieving data from JCMS

• Default JCMS objects

  You can for example use those methods when you need to provide a parameter to any method in a place where you do not have that information available (e.g. using the default admin as the author when creating or updating an object).
  • getDefaultGroup()
  • getDefaultAdmin()
  • getDefaultWorkspace()
  • getDefaultEmail()

• Retrieving single object

  • Retrieve an object given its ID.
    • getStorable(String)
    • getData(String)
    • getData(Class, String)
    • getWorkspace(String)
    • getCategory(String)
    • getPublication(String)
    • getDBData(Class, Long)
  • Retrieve a Group from various information.
    • getGroup(String)
    • getGroupFromDN(String)
  • Retrieve a Member from various information.
    • getMember(String)
    • getMemberFromLogin(String)
    • getMemberFromLogin(String, boolean)
    • getMemberFromEmail(String)
  • Accessing versions of a Data or deleted Data.
    Be aware that those methods re-read the store to access an object and are therefore really slow, use them parsimoniously.
    • getVersionList(String)
    • getVersionList(Data)
    • getDeletedSet(Class)

• Retrieving collection of objects

  CAUTION: methods marked with an asterisk (*) returns an internal Set, DO NOT alter the returned Set, clone if you need to do any modifications.
  • Retrieve collection of Datas of a given Class or from an array of ids.
    Those methods DO NOT control read rights.
    • getDataSet(Class)*
    • getAllDataSet(Class)
    • getAllDataSet()
    • getDataSet(String[])
    • getDataList(String[], boolean, Class)
    • getDBDataIterator(Class)
    • getDBDataList(Class)
    • getDBDataList(Class, int, int)
  • Retrieve collection of Publications of a given Class.
    Those methods control read rights for the given Member.
    • getAllPublicationSet(Class, Member)
    • getAllPublicationSet(Class, Member, boolean)
    • getPublicationSet(Class, Member)
    • getPublicationSet(Class, Member, boolean)
    • getPublicationSet(Class, Member, boolean, Workspace)
  • Retrieve collection of datas which are referring a given Data.
    • getLinkIndexedDataSet(Data, Class)*
    • getLinkIndexedDataSet(Data, Class, String)*
    • getLinkCount(Data)*
  • Select Publications in the given state or with given Workflow.
    • getPublicationSet(Set, boolean)
    • getPublicationSet(Set, Workflow)
  • Retrieve Publications from their title or Publications without any categories.
    • getPublicationSetFromTitle(String)
    • getPublicationWithoutCategories()
  • Retrieve miscellanous JCMS Data.
    • getCommonGroupSet() (Global groups)
    • getWorkspaceSet(Workflow) (Workspace using the given worflow)

Listeners, Data Controllers RightPolicyFilter, Query Filters and Authentication Handlers

• Store Listeners

  Use StoreListener to be informed when Storable are created, updated or deleted from this site.
  • addStoreListener(StoreListener, boolean)
  • addStoreListener(StoreListener, Class, boolean)
  • removeStoreListener(StoreListener)
  • removeStoreListener(StoreListener, Class)

• Channel Listeners

  Use ChannelListener to be informed when the site is shutting down.
  • addChannelListener(ChannelListener)
  • removeChannelListener(ChannelListener)

• Data Controller

  Use DataController to control Data integrity, validation and execution of Data write operation.
  • addDataController(DataController, Class)
  • removeDataController(DataController, Class)
  • getDataControllerSet(Class)

• RightPolicy Filters

  Use RightPolicyFilter to customize behavior of JCMS for rights.
  • addPolicyFilter(PolicyFilter)
  • removePolicyFilter(PolicyFilter)

• Query Filters

  Use QueryFilter to customize behavior of JCMS during search.
  • addQueryFilter(QueryFilter)
  • removeQueryFilter(QueryFilter)

• Authentication Handlers

  Use AuthenticationHandler to provide other authentication method.
  • addAuthenticationHandler(AuthenticationHandler)
  • removeAuthenticationHandler(AuthenticationHandler)

Accessing Properties and Language Properties

The JCMS API provides simple methods to read properties from configuration files and from languages files.
As of version 5.5.0 JCMS does not yet differentiate configuration properties from languages properties.

• Reading configuration property

  Wherever you store your properties (webapp.prop or custom.prop) you can access them at any time using the methods listed below:
  • containsProperty(String)
  • getProperty(String)
  • getProperty(String, String)
  • getBooleanProperty(String, boolean)
  • getIntegerProperty(String, int)
  • getLongProperty(String, long)
  • getFloatProperty(String, float)
  • getDoubleProperty(String, double)
  • getStringArrayProperty(String, String[])
  • getIntArrayProperty(String, int[])

• Reading Language properties

  Language properties are just properties prefixed with the ISO-639 language code. To simplify access to those properties, use glp methods of JcmsUtil.

• Reading multiple properties

• getLanguageProperties()
• getChannelProperties()
• getProperties(String)

Updating and saving properties methods

Should you need to change any of your custom properties, you can use some methods listed below. We do not support the use of the following methods to change any JCMS property at runtime, behaviour of JCMS maybe incorrect if you do not use the user interface for such task.

• updateAndSaveProperties(JProperties)
• setProperty(String, String)

Converting relative path to File

Use the following methods to easely convert relative path into Files and vice-versa. Useful for configuration files, uploaded files, file manipulations, etc.

    File confFile = new File(channel.getDataPath("conf.xml"));
    ...
  

• getRealPath(String)
• getWebappPath()
• getUploadPath(String)
• getUploadParentPath()
• getWebInfPath(String)
• getDataPath(String)
• getRelativePath(File)
• getLucenePath(String) (access with care!)
• getJaliosPath(String) (access with care!)
• getJcmsWorkPath(String) (access with care!)

Communicating by email

Use those method to retrieve the correct sender to use when sending an email from your java code.

    String sender = channel.getSenderFullEmail();
    Strint recipient = newMbr.getFullEmail();
    String subject = "[" + channel.getName() + "] " + "Welcome!"; // TO DO: I18N
    String content = "Welcome " + newMbr.getFriendlyName() + "\nEnjoy our new site!"; // TO DO: I18N
    MailUtil.sendMail(sender, recipient, subject, content);
  

• getSenderFullEmail()
• getSenderFullEmail(Workspace, String)
• getSenderFullEmail(Publication, String)
• getSenderFullEmail(Workspace, Publication, String)

Store Manipulation

WARNING: Modifying the Store can be very dangerous!!! Only use the following methods if you fully understand their behaviour and their consequences.

• Cleaning

  Since jcms-5.5.0 the Store Cleaner allows complete control over operations that should be cleaned when launching a store clean.
  The following methods may be useful to tag the store in its current state (using milestones) and to add filters needed to control the clean operation.
  • appendMilestone(String)
  • addCleanFilter(CustomCleanFilter)
  • removeCleanFilter(CustomCleanFilter)
  • cleanStore(CleanFilter, JcmsContext)
  • getCleanFilterList()
  The dump of current objects in memory is still possible, be aware of the consequences: generateLogFromMemory()

• Retrieving Store Informations

  • getStoreLoadReport()
  • getStoreSize()
  • getStoreCreateCount()
  • getStoreUpdateCount()
  • getStoreDeleteCount()

Others methods of the Channel should be used wisely even though they are public.

Version:

$Revision: 54028 $