org.ametys.plugins.odfweb.cart

Class ODFCartManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.odfweb.cart.ODFCartManager

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class ODFCartManager
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

Component to handle ODF cart items

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ODFCartManager.ODFCartItem

Field Summary

Fields

Modifier and Type	Field and Description
private Context	_context
private ContentTypeExtensionPoint	_cTypeEP
private ContentTypesHelper	_cTypesHelper
private I18nUtils	_i18nUtils
private OdfPageResolver	_odfPageResolver
private ODFCartUserPreferencesStorage	_odfUserPrefStorage
private RenderingContextHandler	_renderingContextHandler
private AmetysObjectResolver	_resolver
private SiteManager	_siteManager
private SourceResolver	_srcResolver
private UserHelper	_userHelper
private UserPreferencesManager	_userPrefManager
static String	CART_USER_PREF_CONTENT_IDS The id of user preference for cart's elements
static String	ROLE The avalon role

Constructor Summary

Constructors

Constructor and Description
ODFCartManager()

Method Summary

Modifier and Type	Method and Description
boolean	addCartItem(UserIdentity owner, String itemId, String siteName) Add a content to the cart
Map<String,Object>	cartItem2Json(ODFCartManager.ODFCartItem item, String siteName, String viewName) Get the JSON representation of a cart item
void	contextualize(Context context)
ODFCartManager.ODFCartItem	getCartItem(String itemId) Get a cart item from its id
List<String>	getCartItemIds(UserIdentity user, String siteName) Get the id of ODF's cart items for a given user
List<ODFCartManager.ODFCartItem>	getCartItems(UserIdentity owner, String siteName) Get the ODF's cart items for a given user
protected String	getMailBody(List<ODFCartManager.ODFCartItem> items, String message, UserIdentity owner, String siteName, String language, boolean text) Get the mail body to sharing cart
protected String	getMailSubject(String siteName, String language) Get the mail subject for sharing cart
protected Page	getPage(ODFCartManager.ODFCartItem item, String siteName) Get the page associated to this cart's item
void	saxCartItem(ContentHandler contentHandler, ODFCartManager.ODFCartItem item, String siteName) SAX a cart's item
void	saxCartItems(ContentHandler contentHandler, UserIdentity owner, String siteName) SAX the cart's items
protected void	saxContent(ContentHandler handler, Content content, String metadataSetName) SAX the content view
protected void	saxPage(ContentHandler handler, ODFCartManager.ODFCartItem item, String siteName) Sax the content's page
protected void	saxTypes(ContentHandler handler, String[] types) Sax the content types
void	service(ServiceManager serviceManager)
void	setCartItems(UserIdentity owner, List<String> itemIds, String siteName) Set the cart's items
Map<String,Object>	shareCartItems(UserIdentity owner, List<String> itemIds, List<String> recipients, String siteName, String language, String message) Share the cart's items by mail

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role

CART_USER_PREF_CONTENT_IDS

public static final String CART_USER_PREF_CONTENT_IDS

The id of user preference for cart's elements

See Also:

Constant Field Values

_userPrefManager

private UserPreferencesManager _userPrefManager

_resolver

private AmetysObjectResolver _resolver

_srcResolver

private SourceResolver _srcResolver

_odfPageResolver

private OdfPageResolver _odfPageResolver

_cTypeEP

private ContentTypeExtensionPoint _cTypeEP

_cTypesHelper

private ContentTypesHelper _cTypesHelper

_odfUserPrefStorage

private ODFCartUserPreferencesStorage _odfUserPrefStorage

_i18nUtils

private I18nUtils _i18nUtils

_userHelper

private UserHelper _userHelper

_siteManager

private SiteManager _siteManager

_renderingContextHandler

private RenderingContextHandler _renderingContextHandler

_context

private Context _context

Constructor Detail

ODFCartManager

public ODFCartManager()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getCartItemIds

public List<String> getCartItemIds(UserIdentity user,
                                   String siteName)
                            throws UserPreferencesException

Get the id of ODF's cart items for a given user

Parameters:

user - the user

siteName - the current site name

Returns:

the list of contents' id

Throws:

UserPreferencesException - if failed to get cart items

getCartItems

public List<ODFCartManager.ODFCartItem> getCartItems(UserIdentity owner,
                                                     String siteName)
                                              throws UserPreferencesException

Get the ODF's cart items for a given user

Parameters:

owner - the user

siteName - the current site name

Returns:

the list of contents

Throws:

UserPreferencesException - if failed to get cart items

getCartItem

public ODFCartManager.ODFCartItem getCartItem(String itemId)

Get a cart item from its id

Parameters:

itemId - the item's id

Returns:

the cart item or null if no content was found

setCartItems

public void setCartItems(UserIdentity owner,
                         List<String> itemIds,
                         String siteName)
                  throws UserPreferencesException

Set the cart's items

Parameters:

owner - The cart owner

itemIds - the id of items to set in the cart

siteName - the site name

Throws:

UserPreferencesException - if failed to save cart

addCartItem

public boolean addCartItem(UserIdentity owner,
                           String itemId,
                           String siteName)
                    throws UserPreferencesException

Add a content to the cart

Parameters:

owner - the cart owner

itemId - the id of content to add into the cart

siteName - the site name

Returns:

true if the content was successfuly added

Throws:

UserPreferencesException - if failed to save cart

shareCartItems

public Map<String,Object> shareCartItems(UserIdentity owner,
                                         List<String> itemIds,
                                         List<String> recipients,
                                         String siteName,
                                         String language,
                                         String message)

Share the cart's items by mail

Parameters:

owner - The cart owner

itemIds - the id of contents to set in the cart

recipients - the mails to share with

siteName - the site name

language - the language

message - the message to add to selection

Returns:

the results

getMailSubject

protected String getMailSubject(String siteName,
                                String language)

Get the mail subject for sharing cart

Parameters:

siteName - The site name

language - the language

Returns:

the mail subject

getMailBody

protected String getMailBody(List<ODFCartManager.ODFCartItem> items,
                             String message,
                             UserIdentity owner,
                             String siteName,
                             String language,
                             boolean text)
                      throws IOException

Get the mail body to sharing cart

Parameters:

items - The cart's items

message - The message

owner - The cart's owner

siteName - The site name

language - the language

text - true to get the body to text body (html otherwise)

Returns:

the cart items to HTML format

Throws:

IOException - if failed to mail body

saxCartItems

public void saxCartItems(ContentHandler contentHandler,
                         UserIdentity owner,
                         String siteName)
                  throws SAXException,
                         IOException,
                         UserPreferencesException

SAX the cart's items

Parameters:

contentHandler - The content handler to sax into

owner - the cart owner

siteName - the site name

Throws:

SAXException - if an error occurred while saxing

IOException - if an I/O exception occurred

UserPreferencesException - if failed to get cart items

saxCartItem

public void saxCartItem(ContentHandler contentHandler,
                        ODFCartManager.ODFCartItem item,
                        String siteName)
                 throws SAXException,
                        IOException

SAX a cart's item

Parameters:

contentHandler - The content handler to sax into

item - the cart's item

siteName - the site name

Throws:

SAXException - if an error occurred while saxing

IOException - if an I/O exception occurred

cartItem2Json

public Map<String,Object> cartItem2Json(ODFCartManager.ODFCartItem item,
                                        String siteName,
                                        String viewName)
                                 throws IOException

Get the JSON representation of a cart item

Parameters:

item - The cart's item

siteName - The site name

viewName - The name of content view to use

Returns:

The cart items properties

Throws:

IOException - if failed to read content view

saxTypes

protected void saxTypes(ContentHandler handler,
                        String[] types)
                 throws SAXException

Sax the content types

Parameters:

handler - The content handler to sax into

types - The content types

Throws:

SAXException - if an error occurred while saxing

saxContent

protected void saxContent(ContentHandler handler,
                          Content content,
                          String metadataSetName)
                   throws SAXException,
                          IOException

SAX the content view

Parameters:

handler - The content handler to sax into

content - The content

metadataSetName - The view

Throws:

SAXException - if an error occurred while saxing

IOException - if an I/O exception occurred

saxPage

protected void saxPage(ContentHandler handler,
                       ODFCartManager.ODFCartItem item,
                       String siteName)
                throws SAXException

Sax the content's page

Parameters:

handler - The content handler to sax into

item - The cart's item

siteName - The current site name

Throws:

SAXException - if an error occurred while saxing

getPage

protected Page getPage(ODFCartManager.ODFCartItem item,
                       String siteName)

Get the page associated to this cart's item

Parameters:

item - The item

siteName - The site name

Returns:

the page or null if not found