01: /******************************************************************************
02: * JBoss, a division of Red Hat *
03: * Copyright 2006, Red Hat Middleware, LLC, and individual *
04: * contributors as indicated by the @authors tag. See the *
05: * copyright.txt in the distribution for a full listing of *
06: * individual contributors. *
07: * *
08: * This is free software; you can redistribute it and/or modify it *
09: * under the terms of the GNU Lesser General Public License as *
10: * published by the Free Software Foundation; either version 2.1 of *
11: * the License, or (at your option) any later version. *
12: * *
13: * This software is distributed in the hope that it will be useful, *
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16: * Lesser General Public License for more details. *
17: * *
18: * You should have received a copy of the GNU Lesser General Public *
19: * License along with this software; if not, write to the Free *
20: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
21: * 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
22: ******************************************************************************/package org.jboss.portal.core.model.content.spi.handler;
23:
24: import org.jboss.portal.core.model.content.Content;
25:
26: /**
27: * The content handler act as a factory for <code>Content</code> objects from their state. The interface receives also
28: * callbacks of the content lifecycle in order to be able to manage additional resources related to the content.
29: *
30: * @author <a href="mailto:julien@jboss.org">Julien Viet</a>
31: * @version $Revision: 8786 $
32: */
33: public interface ContentHandler {
34: /**
35: * Factory method that creates an instance of content object. This method is called whenever the frameworks needs a
36: * runtime representation of the content state which can be used at runtime by content clients.
37: *
38: * @param contextId the context id in which the state is used
39: * @param state the state
40: * @return the content interface implementation
41: */
42: Content newContent(String contextId, ContentState state);
43:
44: /**
45: * Life cycle method to signal state creation.
46: *
47: * @param contextId the context id in which the state is created
48: * @param state the state
49: */
50: void contentCreated(String contextId, ContentState state);
51:
52: /**
53: * Life cycle method to signal state destruction.
54: *
55: * @param contextId the context id in which the state is destroyed
56: * @param state the state
57: */
58: void contentDestroyed(String contextId, ContentState state);
59: }
|