Constructor Detail

• TrsFeedManager

  public TrsFeedManager()

Method Detail

• setInstance

  public static void setInstance​(TrsFeedManager trsFeedManager)

  Sets the TrsFeedManager singleton instance.

  Parameters:

  trsFeedManager - the TrsFeedManager to use.

• getInstance

  public static TrsFeedManager getInstance()

  Gets the TrsFeedManager singleton instance.

  Returns:

  the TrsFeedManager singleton instance.

  See Also:

  setInstance(TrsFeedManager)

• registerFeedController

  public final void registerFeedController​(TrsFeedController trsFeedController)

  Registers a TRS feed controller. A TrsFeedController must be registered before any call on the TrsAdminService or before any TrsService using it is registered. Typically, a TrsFeedController must be registered during the application initialization phase after the TrsFeedManager is configured.

  Parameters:

  trsFeedController - the TRS feed controller.

• getFeedController

  public TrsFeedController getFeedController​(String feedIdentifer)
                                      throws MissingTrsFeedException

  Gets the TrsFeedController for a managed TRS feed.

  Parameters:

  feedIdentifer - the TRS feed identifier.

  Returns:

  the TRS feed controller.

  Throws:

  MissingTrsFeedException - if there are no TRS feed identified by feedIdentifier.

• getFeeds

  public Collection<TrsFeed> getFeeds()

  Gets every managed TrsFeed.

  Returns:

  a collection of TrsFeed.

• populateRootServices

  public void populateRootServices​(RootServices rootServices)

  Populates a RootServices resource with registered TRS feeds.

  Parameters:

  rootServices - the RootServices resource to populate.

• getFeedEndpoint

  protected abstract URI getFeedEndpoint​(TrsFeed feed)

  Gets a TrsFeed endpoint.

  Parameters:

  feed - the TrsFeed to get the endpoint of.

  Returns:

  the TrsFeed endpoint.

• getFunctionalUserIdentifier

  public Optional<String> getFunctionalUserIdentifier()
                                               throws TrsFunctionalUserStoreException

  Gets the TRS functional user identifier.

  Returns:

  the TRS functional user identifier if any.

  Throws:

  TrsFunctionalUserStoreException - if an error prevents getting the TRS functional user identifier

• getFunctionalUser

  public Person getFunctionalUser​(boolean includeBoundConsumersCount)
                           throws MissingTrsFunctionalUserException,
                                  UnresolvedTrsFunctionalUserException,
                                  TrsFunctionalUserStoreException

  Gets the TRS functional user.

  Parameters:

  includeBoundConsumersCount - whether or not to include the bound consumers count.

  Returns:

  the TRS functional user as an OSLC Person.

  Throws:

  MissingTrsFunctionalUserException - if the TRS functional user is not set.

  UnresolvedTrsFunctionalUserException - if the TRS functional user can't be resolved.

  TrsFunctionalUserStoreException - if an error prevents getting the TRS functional user.

• setFunctionalUser

  public Person setFunctionalUser​(String identifier)
                           throws UnresolvedTrsFunctionalUserException,
                                  TrsFunctionalUserStoreException

  Sets the TRS functional user. Internally verify the user with PersonStore.getInstance().getPerson(identifier).

  Parameters:

  identifier - the identifier of the TRS functional user to set.

  Returns:

  the new TRS functional user as an OSLC Person.

  Throws:

  UnresolvedTrsFunctionalUserException - if the TRS functional user can't be resolved.

  TrsFunctionalUserStoreException - if an error prevents setting the TRS functional user.

• removeFunctionalUser

  public void removeFunctionalUser()
                            throws TrsFunctionalUserStoreException

  Removes the current TRS functional user.

  This action corrupts all the registered TRS feeds to ensure no event is missed while no functional user is assigned.
  By corrupting the feeds, a rebuild will be requested when a functional user is reassigned (even if it is the same as before).

  Throws:

  TrsFunctionalUserStoreException - if an error prevents the TRS functional user removal.

• getExposedProjectAreas

  public Collection<ProjectArea> getExposedProjectAreas()
                                                 throws ProjectAreaStoreException,
                                                        MissingTrsFunctionalUserException,
                                                        UnresolvedTrsFunctionalUserException,
                                                        TrsFunctionalUserStoreException

  Gets all the OSLC project areas exposed to TRS feeds. This method is a shortcut for ProjectAreaStore.getInstance().getAccessibleOslcProjectAreas(getFunctionalUser(false).getIdentifier()).

  Returns:

  all the OSLC project areas exposed to TRS feeds.

  Throws:

  ProjectAreaStoreException - if project areas cannot be resolved.

  MissingTrsFunctionalUserException - if the TRS functional user is not set.

  UnresolvedTrsFunctionalUserException - if the TRS functional user can't be resolved.

  TrsFunctionalUserStoreException - if an error prevents getting the TRS functional user.

• getNonExposedProjectAreas

  public Collection<ProjectArea> getNonExposedProjectAreas()
                                                    throws ProjectAreaStoreException,
                                                           MissingTrsFunctionalUserException,
                                                           UnresolvedTrsFunctionalUserException,
                                                           TrsFunctionalUserStoreException

  Gets all the OSLC project areas not exposed to TRS feeds. This method is a shortcut for ProjectAreaStore.getInstance().getRestrictedOslcProjectAreas(getFunctionalUser(false).getIdentifier()).

  Returns:

  all the OSLC project areas exposed to TRS feeds.

  Throws:

  ProjectAreaStoreException - if project areas cannot be resolved.

  MissingTrsFunctionalUserException - if the TRS functional user is not set.

  UnresolvedTrsFunctionalUserException - if the TRS functional user can't be resolved.

  TrsFunctionalUserStoreException - if an error prevents getting the TRS functional user.

• getProjectAreaSeed

  protected abstract Optional<ResourceSeed> getProjectAreaSeed​(ProjectArea projectArea)

  Gets the optional resource seed corresponding to a TRS-exposed ProjectArea resource.

  Applications must override this method to provide the project area resource seed, if they are providing the process feed, to enable the exposed-projects-mismatch checking. The exposed-projects-mismatch checking ensures that all OSLC-enabled projects, to which the TRS functional user has access, are indeed exposed by the TRS feeds; otherwise a rebuild hint is informed to the admin user.

  Parameters:

  projectArea - the exposed project area

  Returns:

  the resource seed corresponding to a TRS-exposed project area resource, or an empty optional.

  Since:

  3.5.1