Ice._PropertiesAdminOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ice-compat Show documentation

Ice is a comprehensive RPC framework that helps you build distributed applications with minimal effort using familiar object-oriented idioms

The newest version!

//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
//
// Ice version 3.7.10
//
// 
//
// Generated from file `PropertiesAdmin.ice'
//
// Warning: do not edit this file.
//
// 
//

package Ice;

/**
 * The PropertiesAdmin interface provides remote access to the properties
 * of a communicator.
 *
 **/
public interface _PropertiesAdminOperations
{
    /**
     * Get a property by key. If the property is not set, an empty
     * string is returned.
     *
     * @param key The property key.
     *
     * @param current The Current object for the invocation.
     * @return The property value.
     *
     **/
    String getProperty(String key, Current current);

    /**
     * Get all properties whose keys begin with prefix. If
     * prefix is an empty string then all properties are returned.
     *
     * @param prefix The prefix to search for (empty string if none).
     * @param current The Current object for the invocation.
     * @return The matching property set.
     *
     **/
    java.util.Map getPropertiesForPrefix(String prefix, Current current);

    /**
     * Update the communicator's properties with the given property set.
     *
     * @param newProperties Properties to be added, changed, or removed.
     * 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 an empty string, the property is removed. Any existing properties
     * that are not modified or removed by the entries in newProperties are
     * retained with their original values.
     *
     * @param current The Current object for the invocation.
     **/
    void setProperties(java.util.Map newProperties, Current current);
}