com.atlassian.crowd.support

Class SupportInformationServiceImpl

java.lang.Object

com.atlassian.crowd.support.SupportInformationServiceImpl

All Implemented Interfaces:

SupportInformationService

public class SupportInformationServiceImpl
extends Object
implements SupportInformationService

Produces a String containing information about some aspects of the Crowd configuration. This class requires a DirectoryManager, a DefaultGroupMembershipService, and optionally, an ApplicationManager and a AdditionalSupportInformationService. The latter have been made optional because not all products have multiple applications or provide additional support information.

Since:

2.6.2

Constructor Summary

Constructors

Constructor and Description
SupportInformationServiceImpl(DirectoryManager directoryManager, DefaultGroupMembershipService defaultGroupMembershipService)

Method Summary

Modifier and Type	Method and Description
String	getSupportInformation(User currentUser) Returns a human-readable string containing basic user, directory and application data valuable in support requests.
Map<String,String>	getSupportInformationMap(User currentUser) Returns the same data as SupportInformationService.getSupportInformation(User) in map format.
void	setAdditionalSupportInformationServices(List<AdditionalSupportInformationService> additionalSupportInformationServices)
void	setApplicationManager(ApplicationManager applicationManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

SupportInformationServiceImpl

public SupportInformationServiceImpl(DirectoryManager directoryManager,
                                     DefaultGroupMembershipService defaultGroupMembershipService)

Method Detail

getSupportInformation

public String getSupportInformation(@Nullable
                                    User currentUser)

Description copied from interface: SupportInformationService

Returns a human-readable string containing basic user, directory and application data valuable in support requests.

Specified by:

getSupportInformation in interface SupportInformationService

Parameters:

currentUser - currently logged-in user

Returns:

string formatted as "property=value\n"

getSupportInformationMap

public Map<String,String> getSupportInformationMap(@Nullable
                                                   User currentUser)

Description copied from interface: SupportInformationService

Returns the same data as SupportInformationService.getSupportInformation(User) in map format.

Specified by:

getSupportInformationMap in interface SupportInformationService

Parameters:

currentUser - currently logged-in user

Returns:

flat map containing support information, with keys formatted as "category.subcategory(...).attribute"

setApplicationManager

public void setApplicationManager(ApplicationManager applicationManager)

setAdditionalSupportInformationServices

public void setAdditionalSupportInformationServices(@Nullable
                                                    List<AdditionalSupportInformationService> additionalSupportInformationServices)