Package com.atlassian.jira.projects.shortcuts

Class DefaultShortcutsService

java.lang.Object

com.atlassian.jira.projects.shortcuts.DefaultShortcutsService

All Implemented Interfaces:

ShortcutsService

@Component
public class DefaultShortcutsService
extends Object
implements ShortcutsService

Default implementation of the ShortcutsService interface.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NAME_LENGTH

Constructor Summary

Constructors

Constructor	Description
DefaultShortcutsService(ShortcutsManager shortcutsManager, ProjectPermissionsHelper projectPermissionsHelper, I18nHelper.BeanFactory i18nHelperFactory, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.sal.api.features.DarkFeatureManager darkFeatureManager)

Method Summary

Modifier and Type	Method	Description
io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut>	addShortcut(ProjectShortcut shortcut, ApplicationUser user)	Adds new shortcut to given project
io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut>	deleteShortcut(Integer id, ApplicationUser user)	Delete shortcut with given ID
io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut>	getShortcut(Integer id, ApplicationUser user)	Find shortcut with given ID in selected project
List<ProjectShortcut>	getShortcuts(Project project, ApplicationUser user)	Fetch shortcuts for given project
boolean	isUrlSafe(String url)	Check whether given URL is safe as per URI scheme Allow listing
io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut>	updateShortcut(ProjectShortcut shortcut, ApplicationUser user)	Updates shortcut

Methods inherited from class java.lang.Object

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

Field Details

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

See Also:

• Constant Field Values

Constructor Details

DefaultShortcutsService

@Autowired
public DefaultShortcutsService(ShortcutsManager shortcutsManager,
 ProjectPermissionsHelper projectPermissionsHelper,
 I18nHelper.BeanFactory i18nHelperFactory,
 com.atlassian.event.api.EventPublisher eventPublisher,
 com.atlassian.sal.api.features.DarkFeatureManager darkFeatureManager)

Method Details

addShortcut

public io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut> addShortcut(ProjectShortcut shortcut,
 ApplicationUser user)

Description copied from interface: ShortcutsService

Adds new shortcut to given project

Specified by:

addShortcut in interface ShortcutsService

Parameters:

shortcut - shortcut's data to be added. Note that the operation will ignore {ProjectShortcut.getId()} value

user - user performing the operation

Returns:

updated shortcut object or ErrorCollection in case of error

updateShortcut

public io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut> updateShortcut(ProjectShortcut shortcut,
 ApplicationUser user)

Description copied from interface: ShortcutsService

Updates shortcut

Specified by:

updateShortcut in interface ShortcutsService

Parameters:

shortcut - a new shortcut's data. Object's ID will be used to find the one to update.

user - user performing the operation

Returns:

updated shortcut object or ErrorCollection in case of error

isUrlSafe

public boolean isUrlSafe(String url)

Check whether given URL is safe as per URI scheme Allow listing

Specified by:

isUrlSafe in interface ShortcutsService

Parameters:

url - the URL

Returns:

true when URL is safe, false otherwise

getShortcuts

public List<ProjectShortcut> getShortcuts(Project project,
 ApplicationUser user)

Description copied from interface: ShortcutsService

Fetch shortcuts for given project

Specified by:

getShortcuts in interface ShortcutsService

Parameters:

project - the project

user - user performing the operation

Returns:

a list of shortcuts. null should never happen

getShortcut

public io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut> getShortcut(Integer id,
 ApplicationUser user)

Description copied from interface: ShortcutsService

Find shortcut with given ID in selected project

Specified by:

getShortcut in interface ShortcutsService

Parameters:

id - the shortcut's ID

user - user performing the operation

Returns:

either {ProjectShortcut} or ErrorCollection in case of error

deleteShortcut

public io.atlassian.fugue.Either<ErrorCollection,ProjectShortcut> deleteShortcut(Integer id,
 ApplicationUser user)

Description copied from interface: ShortcutsService

Delete shortcut with given ID

Specified by:

deleteShortcut in interface ShortcutsService

Parameters:

id - the shortcut's ID

user - user performing the operation

Returns:

ProjectShortcut when shortcut was existing and was successfully deleted ErrorCollection in case of error