org.eclipse.leshan.server.client.ClientRegistry Maven / Gradle / Ivy

Go to download

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

A LWM2M client and server based on Californium (CoAP) all in one.

There is a newer version: 1.0.0-M11

/*******************************************************************************
 * Copyright (c) 2013-2015 Sierra Wireless and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 * 
 * The Eclipse Public License is available at
 *    http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 *    http://www.eclipse.org/org/documents/edl-v10.html.
 * 
 * Contributors:
 *     Sierra Wireless - initial API and implementation
 *******************************************************************************/
package org.eclipse.leshan.server.client;

import java.util.Collection;

/**
 * A registry to access registered clients
 */
public interface ClientRegistry {

    /**
     * Retrieves a registered client by end-point.
     * 
     * @param endpoint
     * @return the matching client or null if not found
     */
    Client get(String endpoint);

    /**
     * Returns an unmodifiable list of all registered clients.
     * 
     * @return the registered clients
     */
    Collection allClients();

    /**
     * Adds a new listener to be notified with client registration events.
     * 
     * @param listener
     */
    void addListener(ClientRegistryListener listener);

    /**
     * Removes a client registration listener.
     * 
     * @param listener the listener to be removed
     */
    void removeListener(ClientRegistryListener listener);

    /**
     * Registers a new client.
     * 
     * An implementation must notify all registered listeners as part of processing the registration request.
     * 
     * @param client the client to register, identified by its end-point.
     * @return true if the client was properly registered and false if the registration is not
     *         allowed.
     */
    boolean registerClient(Client client);

    /**
     * Updates registration properties for a given client.
     * 
     * @param update the registration properties to update
     * @return the updated registered client or null if no client is registered under the given end-point
     *         name
     */
    Client updateClient(ClientUpdate update);

    /**
     * De-registers a client.
     * 
     * @param registrationId the client registrationId
     * @return the previously registered client or null if no client is registered under the given ID
     */
    Client deregisterClient(String registrationId);

    /**
     * Retrieves a registered client by registration id.
     * 
     * @param registration id
     * @return the matching client or null if not found
     */
    Client findByRegistrationId(String id);
}