1 package com.atlassian.sal.api.message;
2
3 /**
4 * Help path resolver.
5 * This is used to retrieve product specific help.
6 * Plugins used with multiple Atlassian products may wish to have help integrated with the core product help,
7 * e.g. The administration plugin for embedded crowd directory management has different facilities in JIRA and Confluence
8 * and both JIRA and Confluence supply their own help pages for the plugin.
9 *
10 * @since 2.4
11 */
12 public interface HelpPathResolver {
13 /**
14 * Retrieve the help path for a key.
15 * Implementers may choose to return null if no help is available for the given key.
16 *
17 * @param key Key to the help path. The key passed in may be null.
18 * @return HelpPath for the key.
19 */
20 HelpPath getHelpPath(String key);
21 }