com.atlassian.jira.application

Interface ApplicationRoleStore

All Known Implementing Classes:

MockApplicationRoleStore, OfBizApplicationRoleStore

public interface ApplicationRoleStore

Store for storing and retrieving ApplicationRoleStore.ApplicationRoleData.

Since:

v7.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApplicationRoleStore.ApplicationRoleData

Method Summary

Modifier and Type	Method and Description
ApplicationRoleStore.ApplicationRoleData	get(com.atlassian.application.api.ApplicationKey key) Get the ApplicationRoleStore.ApplicationRoleData for the passed ApplicationKey.
void	removeByKey(com.atlassian.application.api.ApplicationKey key) Remove the ApplicationRoleStore.ApplicationRoleData associated with provided application key.
void	removeGroup(String groupName) Removes the association of the given group from all application roles in the database.
ApplicationRoleStore.ApplicationRoleData	save(ApplicationRoleStore.ApplicationRoleData data) Save the passed ApplicationRoleStore.ApplicationRoleData to the database.

Method Detail

get

@Nonnull
ApplicationRoleStore.ApplicationRoleData get(@Nonnull
                                                      com.atlassian.application.api.ApplicationKey key)

Get the ApplicationRoleStore.ApplicationRoleData for the passed ApplicationKey.

Parameters:

key - the key to search for.

Returns:

The ApplicationRoleStore.ApplicationRoleData for the passed ApplicationKey.

save

@Nonnull
ApplicationRoleStore.ApplicationRoleData save(@Nonnull
                                                       ApplicationRoleStore.ApplicationRoleData data)

Save the passed ApplicationRoleStore.ApplicationRoleData to the database.

Parameters:

data - the data to save to the database.

Returns:

the ApplicationRoleStore.ApplicationRoleData as saved in the database.

removeGroup

void removeGroup(@Nonnull
                 String groupName)

Removes the association of the given group from all application roles in the database. NOTE: Current implementation makes no effort to reassign the default group. This means that that you can be left with a role that has no default groups.

Parameters:

groupName - the name of the group to remove.

removeByKey

void removeByKey(@Nonnull
                 com.atlassian.application.api.ApplicationKey key)

Remove the ApplicationRoleStore.ApplicationRoleData associated with provided application key.

Parameters:

key - the key that represents the ApplicationRoleStore.ApplicationRoleData to be removed.