Package com.caplin.motif.fx.ret.common.permission

Class AdminConnectionManager

java.lang.Object
com.caplin.motif.fx.ret.common.permission.AdminConnectionManager
public class AdminConnectionManager extends Object
Mediates a connection to the TrAPI Admin API.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdminConnectionManager(com.caplin.ret.trapi.connection.ConnectionManager<com.caplin.ret.trapi.connection.AdminConnection> connectionManager)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    connect()
    Establishes a connection to the Admin API.
    com.caplin.ret.trapi.connection.AdminConnection
    getAdminConnection()
    Getter for property 'adminConnection'.
    com.caplin.ret.trapi.admin.AdminService
    getAdminService()
    Getter for property 'adminService'.
    PermissionService
    getPermissionService()
    Getter for property 'permissionsProvider'.
    void
    refresh()
    Refreshes the Admin API's internal caches to force a reload from the database.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AdminConnectionManager

      public AdminConnectionManager(com.caplin.ret.trapi.connection.ConnectionManager<com.caplin.ret.trapi.connection.AdminConnection> connectionManager)

  • Method Details

    • getAdminConnection

      public com.caplin.ret.trapi.connection.AdminConnection getAdminConnection()
      Getter for property 'adminConnection'.
      Returns:
      Value for property 'adminConnection'.

    • getAdminService

      public com.caplin.ret.trapi.admin.AdminService getAdminService()
      Getter for property 'adminService'.
      Returns:
      Value for property 'adminService'.

    • getPermissionService

      public PermissionService getPermissionService()
      Getter for property 'permissionsProvider'.
      Returns:
      Value for property 'permissionsProvider'.

    • connect

      public void connect() throws com.caplin.ret.trapi.exception.ConnectionException
      Establishes a connection to the Admin API.
      Throws:
      com.caplin.ret.trapi.exception.ConnectionException - throw by the delegate if the connection fails.

    • refresh

      public void refresh()
      Refreshes the Admin API's internal caches to force a reload from the database.