Interface BrokerAgent


public interface BrokerAgent
Definition for an agent offering access to SpecialistsBrokers, each of which operates on a remote projects that is registered for the given symbolic name.

Example:
SpecialistsBroker#requestSpecialist(BrokerAgent.TYPE).BrokerAgent#getBroker(symbolicProjectName) This agent is also available in non project related contexts (e.g. server schedule entries). In this case the methods getBroker(long) and getBroker(String) will deliver null. To get hold of a project related broker use getBrokerByProjectName(String).

Since:
4.2.405
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    The specialized agent's type to be used to look up the agent via a SpecialistsBroker.
  • Method Summary

    Modifier and Type
    Method
    Description
    getBroker(long revision)
    Get hold of a broker operating on the given revision.
    getBroker(String symbolicProjectName)
    Try getting hold of a broker for a remote project registered under the given symbolic name.
    getBrokerByProjectId(long projectId)
    Returns a broker related to the project specified by given projectId or null if no project exists with the given ID or the current user has no access to the project.
    Returns a broker related to the project specified by given projectName or null if no project exists with the given name or the current user has no access to the project.
  • Field Details

  • Method Details

    • getBroker

      @Nullable SpecialistsBroker getBroker(@NotNull String symbolicProjectName)
      Try getting hold of a broker for a remote project registered under the given symbolic name.
      Parameters:
      symbolicProjectName - The symbolic project name.
      Returns:
      The according broker or null.
      Since:
      4.2.405
    • getBroker

      @Nullable SpecialistsBroker getBroker(long revision)
      Get hold of a broker operating on the given revision.
      Parameters:
      revision - The revision to operate on.
      Returns:
      The broker or null
      Since:
      5.0.100
    • getBrokerByProjectName

      @Nullable SpecialistsBroker getBrokerByProjectName(@NotNull String projectName)
      Returns a broker related to the project specified by given projectName or null if no project exists with the given name or the current user has no access to the project.
      Since:
      5.0.207
    • getBrokerByProjectId

      @Nullable SpecialistsBroker getBrokerByProjectId(long projectId)
      Returns a broker related to the project specified by given projectId or null if no project exists with the given ID or the current user has no access to the project.
      Since:
      5.1.32