Package org.ametys.plugins.workspaces

Class WorkspacesHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.WorkspacesHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkspacesHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Utility classes for workspaces

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorkspacesHelper.FileType	Enumeration for file type

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected RightManager	_rightManager	The right manager
protected WorkspaceModuleExtensionPoint	_workspaceModuleEP	The workspace module extension point
static final String	ROLE	Avalon role

Constructor Summary

Constructors

Constructor	Description
WorkspacesHelper()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
String	getAvatar(UserIdentity userIdentity, String lang, int size)	Get user avatar
WorkspacesHelper.FileType	getFileType(String filename)	Get the file type of a resource from its name
WorkspacesHelper.FileType	getFileType(Resource file)	Get the file type of a resource file
String	getLang(Project project)	Get the lang for this project, or en if none found
String	getLang(Project project, String defaultLanguage)	Get the lang for this project, or given default language if none found
Project	getProjectFromRequest()	Get current project from request
List<Map<String,Object>>	handleTags(TaggableAmetysObject taggableAmetysObject, List<Object> tags, TraversableAmetysObject moduleRoot)	Handle tags for the edition of a TaggableAmetysObject
boolean	isImage(Resource file)	Determines if the resource file is an image
void	service(ServiceManager smanager)

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 Details

ROLE

public static final String ROLE

Avalon role

_rightManager

protected RightManager _rightManager

The right manager

_workspaceModuleEP

protected WorkspaceModuleExtensionPoint _workspaceModuleEP

The workspace module extension point

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

Constructor Details

WorkspacesHelper

public WorkspacesHelper()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isImage

public boolean isImage(Resource file)

Determines if the resource file is an image

Parameters:

file - the resource

Returns:

true if the resource file is an image

getFileType

public WorkspacesHelper.FileType getFileType(Resource file)

Get the file type of a resource file

Parameters:

file - the resource

Returns:

the WorkspacesHelper.FileType

getFileType

public WorkspacesHelper.FileType getFileType(String filename)

Get the file type of a resource from its name

Parameters:

filename - the resource's name

Returns:

the WorkspacesHelper.FileType

getAvatar

public String getAvatar(UserIdentity userIdentity,
 String lang,
 int size)

Get user avatar

Parameters:

userIdentity - the user identity

lang - the lang for user's content

size - the size in pixel of image

Returns:

the avatar url

getProjectFromRequest

public Project getProjectFromRequest()

Get current project from request

Returns:

the current project or null if not found.

handleTags

public List<Map<String,Object>> handleTags(TaggableAmetysObject taggableAmetysObject,
 List<Object> tags,
 TraversableAmetysObject moduleRoot)

Handle tags for the edition of a TaggableAmetysObject

Parameters:

taggableAmetysObject - the object to edit

tags - the tags

moduleRoot - the module root, used to check tag creation rights if needed

Returns:

the created tags

getLang

public String getLang(Project project)

Get the lang for this project, or en if none found

Parameters:

project - the project to check

Returns:

a lang in this project, or en if none found

getLang

public String getLang(Project project,
 String defaultLanguage)

Get the lang for this project, or given default language if none found

Parameters:

project - the project to check

defaultLanguage - the default language to return if no language is available for the project or if the site could not be found

Returns:

a lang in this project or given default language