org.eclipse.leshan.client.resource.LwM2mInstanceEnabler 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
Show all versions of leshan-all Show documentation
A LWM2M client and server based on Californium (CoAP) all in one.
The newest version!
/*******************************************************************************
* Copyright (c) 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
* Kai Hudalla (Bosch Software Innovations GmbH) - add documentation
* Achim Kraus (Bosch Software Innovations GmbH) - add reset() for
* REPLACE/UPDATE implementation
*******************************************************************************/
package org.eclipse.leshan.client.resource;
import java.util.List;
import org.eclipse.leshan.client.request.ServerIdentity;
import org.eclipse.leshan.core.model.ObjectModel;
import org.eclipse.leshan.core.node.LwM2mObjectInstance;
import org.eclipse.leshan.core.node.LwM2mResource;
import org.eclipse.leshan.core.request.WriteRequest.Mode;
import org.eclipse.leshan.core.response.ExecuteResponse;
import org.eclipse.leshan.core.response.ObserveResponse;
import org.eclipse.leshan.core.response.ReadResponse;
import org.eclipse.leshan.core.response.WriteResponse;
/**
* A contract for managing a LWM2M object instance on a LWM2M client.
*
* LWM2M clients should implement this interface for each LWM2M object type they support in order to take advantage of
* automatic routing of requests from a LWM2M server to specific LWM2M object instances of that type and forwarding of
* notifications to LWM2M servers observing resources on these instances.
*
*
* Clients can register instances of this interface (representing the client's instances of a particular LWM2M object
* type) using {@link ObjectsInitializer#setInstancesForObject(int, LwM2mInstanceEnabler...)} and then use
* {@link ObjectsInitializer#create(int)} to create a {@link LwM2mObjectEnabler} instance for managing them.
*
*
* Implementations of this interface should adhere to the definition of the implemented LWM2M Object type regarding
* acceptable resource IDs for the read, write and execute methods.
*
*
*/
public interface LwM2mInstanceEnabler {
/**
* @return the id of this instance.
*/
Integer getId();
/**
* Set this id of this instance. It should be called only by
* {@link LwM2mInstanceEnablerFactory#create(ObjectModel, Integer, java.util.Collection)}.
*
* @param id this id of this instance.
*/
void setId(int id);
/**
* Set the model of this instance. It should be called only by
* {@link LwM2mInstanceEnablerFactory#create(ObjectModel, Integer, java.util.Collection)}.
*
* @param model the model of this instance
*/
void setModel(ObjectModel model);
/**
* Adds a callback handler that gets notified about changes to any of this LWM2M object instance's resources.
*
* @param listener the handler to add, a null value is silently ignored
*/
void addResourceChangedListener(ResourceChangedListener listener);
/**
* Stops a callback handler from getting notified about changes to any of this LWM2M object instance's resources.
*
* @param listener the handler to remove, a null value is silently ignored
*/
void removeResourceChangedListener(ResourceChangedListener listener);
/**
* Gets values of all readable resources of this instance.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
*
* @return a success response with an {@link LwM2mObjectInstance} as content or a failure response with optional
* explanation message.
*/
ReadResponse read(ServerIdentity identity);
/**
* Gets the current value of one of this LWM2M object instance's resources.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
* @param resourceId the ID of the resource to get the value of
* @return the response object representing the outcome of the operation. An implementation should set the result's
* {@link ReadResponse#getCode() response code} to either reflect the success or reason for failure to
* retrieve the value.
*/
ReadResponse read(ServerIdentity identity, int resourceId);
/**
* Sets all resources of this LWM2M object instance.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
* @param replace if replace is true a {@link Mode#REPLACE} should be done, else {@link Mode#UPDATE} should be done.
* @param value all the resources to be written.
* @return the response object representing the outcome of the operation. An implementation should set the result's
* {@link WriteResponse#getCode() response code} to either reflect the success or reason for failure to set
* the value.
*/
WriteResponse write(ServerIdentity identity, boolean replace, LwM2mObjectInstance value);
/**
* Sets the value of one of this LWM2M object instance's resources.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
* @param resourceid the ID of the resource to set the value for
* @param value the value to set the resource to
* @return the response object representing the outcome of the operation. An implementation should set the result's
* {@link WriteResponse#getCode() response code} to either reflect the success or reason for failure to set
* the value.
*/
WriteResponse write(ServerIdentity identity, int resourceid, LwM2mResource value);
/**
* Executes the operation represented by one of this LWM2M object instance's resources.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
* @param resourceid the ID of the resource to set the value for
* @param params the input parameters of the operation
* @return the response object representing the outcome of the operation. An implementation should set the result's
* {@link ExecuteResponse#getCode() response code} to either reflect the success or reason for failure to
* execute the operation.
*/
ExecuteResponse execute(ServerIdentity identity, int resourceid, String params);
/**
* Performs an observe register the whole LWM2M object instance.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
* @return a success response with an {@link LwM2mObjectInstance} as content or a failure response with optional
* explanation message.
*/
ObserveResponse observe(ServerIdentity identity);
/**
* Performs an observe register on one of this LWM2M object instance's resources.
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
* @param resourceid the ID of the resource to set the value for
*/
ObserveResponse observe(ServerIdentity identity, int resourceid);
/**
* A callback called when this instance is deleted
*
* @param identity the identity of the requester. This could be an internal call in this case
* identity == ServerIdentity.SYSTEM.
*/
void onDelete(ServerIdentity identity);
/**
* @param objectModel the model of this instance
* @return the list of the implemented resources of this instances mainly used for discover operation
*/
List getAvailableResourceIds(ObjectModel objectModel);
/**
* Reset the current value of one of this LWM2M object instance's resources. Only used for implementation of REPLACE
* to cleanup none mandatory resources.
*
* @param resourceId the ID of the resource to be reseted
*/
void reset(int resourceId);
}