Module com.zeroc.ice
Package com.zeroc.Ice

Interface PropertiesAdmin

All Superinterfaces:
Object
All Known Implementing Classes:
NativePropertiesAdmin
public interface PropertiesAdmin extends Object
Provides remote access to the properties of a communicator.

  • Method Details

    • getProperty

      String getProperty(String key, Current current)
      Gets a property by key.
      Parameters:
      key - The property key.
      current - The Current object of the incoming request.
      Returns:
      The property value. This value is empty if the property is not set.

    • getPropertiesForPrefix

      Map<String,String> getPropertiesForPrefix(String prefix, Current current)
      Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.
      Parameters:
      prefix - The prefix to search for. May be empty.
      current - The Current object of the incoming request.
      Returns:
      The matching property set.

    • setProperties

      void setProperties(Map<String,String> newProperties, Current current)
      Updates the communicator's properties with the given property set. If an entry in newProperties matches the name of an existing property, that property's value is replaced with the new value. If the new value is the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.
      Parameters:
      newProperties - Properties to add, change, or remove.
      current - The Current object of the incoming request.

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::Ice::PropertiesAdmin"

    • dispatch

      default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request) throws UserException
      Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
      Specified by:
      dispatch in interface Object
      Parameters:
      request - the incoming request
      Returns:
      the outgoing response
      Throws:
      UserException - if a UserException is thrown, Ice will marshal it as the response payload.