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