Java API Documentation (v 3.4)
- 1 Quick Start Guide
- 1.1 Set up dependencies
- 2 Internal structure and basic usage
Quick Start Guide
Set up dependencies
Update your atlassian-plugin.xml
to import the services provided by our API as components:
Make sure the User Profiles for Confluence Add-on is already installed on your Confluence system.
Check Installation and Licensing (v 3.4) for further information.
Internal structure and basic usage
The UPC Java API consists out of two basic elements: the profile element and the profile element data. Profile elements can be added and removed in the UPC administration (check Configure User Profile Elements (v 3.4) for further information). Values may afterwards be added for every user via an LDAP sync or by manually editing user profiles (in the administration or the user does it on his own) or even by using our new Java API.
To interact with profile elements, just inject and use the provided UppProfileElementManager. With this manager you will be able to load the available profile elements. Afterwards you may want to access some data which is related to a user. To achieve that, just inject and use the provided UppProfileElementDataManager.
Profile element and data types
There are several profile element and data types which are used to work with the API. To provide you a better start, we are going to list all currently available profile elements and their matching data models in the following table:
Profile Element Models | Profile Element Data Models |
---|---|
AutocompleteProfileElement | AutocompleteProfileElementData |
MultiSelectProfileElement | MultiSelectProfileElementData |
SingleSelectProfileElement | SingleSelectProfileElementData |
TextBasedProfileElement | TextBasedProfileElementData |
UserProfileElement | UserProfileElementData |
You have to use matching profile element and data types to be able to interact with the API. Furthermore the specialized data objects make an interaction with a specific data type more easy.
Event publication
SINCE VERSION 3.3.15
ProfileElementDataChangedEvent
The User Profiles for Jira App publishes events every minute, which contain all changes that are taken since the last publication. One event contains a maximum of 1000 changes as a collection of updates. Each update contains a key of an user, a profile element and the new data. The following table shows the models of the change sets:
Profile Element Change Set Models | Profile Element Models | Data Models |
---|---|---|
AutocompleteProfileElementDataUpdate | AutocompleteProfileElement | Set<String> |
MultiSelectProfileElementDataUpdate | MultiSelectProfileElement | Set<OptionedProfileElement.Option> |
SingleSelectProfileElementDataUpdate | SingleSelectProfileElement | OptionedProfileElement.Option |
TextBasedProfileElementDataUpdate | TextBasedProfileElement | String |
UserProfileElementDataUpdate | UserProfileElement | UserKey |
ProfileElementNameChangedEvent
This event is published when the default name of a profile element is changed. It contains the updated profile element.
ProfileElementRemovedEvent
This event is published when a profile element is removed. It contains the removed profile element.
ProfileElementOptionNameChangedEvent
This event is published when the default name of an option of a profile element is changed. It contains the updated profile element and the updated option.
ProfileElementOptionRemovedEvent
This event is published when an option of a profile element is removed. It contains the updated profile element and the removed option.
Examples
To kickstart you a little bit more, we want to provide you with a few examples on what you can currently do with our Java API:
UppProfileElementManager
Loading all profile elements
Loading a specific profile element with a specific id (for example 1)
UppProfileElementDataManager
Loading profile element data for a profile element and an user
Loading all profile elements for an user
Storing profile element data for a profile element and an user
To be able to store data, the type of the profile Element must match the type of the data.
Â