Package com.zeroc.IceGrid

Interface RegistryPluginFacade

public interface RegistryPluginFacade
The RegistryPluginFacade is implemented by IceGrid and can be used by plugins and filter implementations to retrieve information from IceGrid about the well-known objects or adapters. It's also used to register/unregister replica group and type filters.

  • Method Details

    • getApplicationInfo

      ApplicationInfo getApplicationInfo(String name) throws ApplicationNotExistException
      Get an application descriptor.
      Parameters:
      name - The application name.
      Returns:
      The application descriptor.
      Throws:
      ApplicationNotExistException - Raised if the application doesn't exist.

    • getServerInfo

      ServerInfo getServerInfo(String id) throws ServerNotExistException
      Get the server information for the server with the given id.
      Parameters:
      id - The server id.
      Returns:
      The server information.
      Throws:
      ServerNotExistException - Raised if the server doesn't exist.

    • getAdapterServer

      String getAdapterServer(String adapterId) throws AdapterNotExistException
      Get the ID of the server to which the given adapter belongs.
      Parameters:
      adapterId - The adapter ID.
      Returns:
      The server ID or the empty string if the given identifier is not associated to an object adapter defined with an application descriptor.
      Throws:
      AdapterNotExistException - Raised if the adapter doesn't exist.

    • getAdapterApplication

      String getAdapterApplication(String adapterId) throws AdapterNotExistException
      Get the name of the application to which the given adapter belongs.
      Parameters:
      adapterId - The adapter ID.
      Returns:
      The application name or the empty string if the given identifier is not associated to a replica group or object adapter defined with an application descriptor.
      Throws:
      AdapterNotExistException - Raised if the adapter doesn't exist.

    • getAdapterNode

      String getAdapterNode(String adapterId) throws AdapterNotExistException
      Get the name of the node to which the given adapter belongs.
      Parameters:
      adapterId - The adapter ID.
      Returns:
      The node name or the empty string if the given identifier is not associated to an object adapter defined with an application descriptor.
      Throws:
      AdapterNotExistException - Raised if the adapter doesn't exist.

    • getAdapterInfo

      AdapterInfo[] getAdapterInfo(String id) throws AdapterNotExistException
      Get the adapter information for the replica group or adapter with the given id.
      Parameters:
      id - The adapter id.
      Returns:
      A sequence of adapter information structures. If the given id refers to an adapter, this sequence will contain only one element. If the given id refers to a replica group, the sequence will contain the adapter information of each member of the replica group.
      Throws:
      AdapterNotExistException - Raised if the adapter or replica group doesn't exist.

    • getObjectInfo

      ObjectInfo getObjectInfo(Identity id) throws ObjectNotRegisteredException
      Get the object info for the object with the given identity.
      Parameters:
      id - The identity of the object.
      Returns:
      The object info.
      Throws:
      ObjectNotRegisteredException - Raised if the object isn't registered with the registry.

    • getNodeInfo

      NodeInfo getNodeInfo(String name) throws NodeNotExistException, NodeUnreachableException
      Get the node information for the node with the given name.
      Parameters:
      name - The node name.
      Returns:
      The node information.
      Throws:
      NodeNotExistException - Raised if the node doesn't exist.
      NodeUnreachableException - Raised if the node could not be reached.

    • getNodeLoad

      LoadInfo getNodeLoad(String name) throws NodeNotExistException, NodeUnreachableException
      Get the load averages of the node.
      Parameters:
      name - The node name.
      Returns:
      The node load information.
      Throws:
      NodeNotExistException - Raised if the node doesn't exist.
      NodeUnreachableException - Raised if the node could not be reached.

    • getPropertyForAdapter

      String getPropertyForAdapter(String adapterId, String name) throws AdapterNotExistException
      Get the property value for the given property and adapter. The property is looked up in the server or service descriptor where the adapter is defined.
      Parameters:
      adapterId - The adapter ID
      name - The name of the property.
      Returns:
      The property value.
      Throws:
      AdapterNotExistException - Raised if the adapter doesn't exist.

    • addReplicaGroupFilter

      void addReplicaGroupFilter(String id, ReplicaGroupFilter filter)
      Add a replica group filter.
      Parameters:
      id - The identifier of the filter. This identifier must match the value of the "filter" attribute specified in the replica group descriptor. To filter dynamically registered replica groups, you should use the empty filter id.
      filter - The filter implementation.

    • removeReplicaGroupFilter

      boolean removeReplicaGroupFilter(String id, ReplicaGroupFilter filter)
      Remove a replica group filter.
      Parameters:
      id - The identifier of the filter.
      filter - The filter implementation.
      Returns:
      True of the filter was removed, false otherwise.

    • addTypeFilter

      void addTypeFilter(String type, TypeFilter filter)
      Add a type filter.
      Parameters:
      type - The type to register this filter with.
      filter - The filter implementation.

    • removeTypeFilter

      boolean removeTypeFilter(String type, TypeFilter filter)
      Remove a type filter.
      Parameters:
      type - The type to register this filter with.
      filter - The filter implementation.
      Returns:
      True of the filter was removed, false otherwise.