Package org.openremote.model.protocol

Class ProtocolDiscoveryStartRequestEvent

java.lang.Object

org.openremote.model.event.Event

org.openremote.model.event.shared.SharedEvent

org.openremote.model.event.shared.RealmScopedEvent

org.openremote.model.protocol.ProtocolDiscoveryStartRequestEvent

public class ProtocolDiscoveryStartRequestEvent
extends RealmScopedEvent

Initiates a protocol discovery process (either instance or asset discovery depending on isAssetDiscovery()); for a given client only one discovery process can be running at a time so any already running discovery process will be stopped.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	agentDescriptor
protected boolean	assetDiscovery
protected String	assetId

Fields inherited from class org.openremote.model.event.shared.RealmScopedEvent

realm

Fields inherited from class org.openremote.model.event.shared.SharedEvent

MESSAGE_PREFIX

Fields inherited from class org.openremote.model.event.Event

messageID, timestamp

Constructor Summary

Constructors

Constructor	Description
ProtocolDiscoveryStartRequestEvent(String realm, String agentDescriptor, String assetId, boolean assetDiscovery)

Method Summary

Modifier and Type	Method	Description
String	getAgentDescriptor()
String	getAssetId()	If isAssetDiscovery() then this should be the ID of the Agent on which Asset discovery should be initiated.
boolean	isAssetDiscovery()

Methods inherited from class org.openremote.model.event.shared.RealmScopedEvent

getRealm

Methods inherited from class org.openremote.model.event.Event

getEventType, getEventType, getEventType, getMessageID, getTimestamp, setMessageID, setTimestamp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

agentDescriptor

protected String agentDescriptor

assetId

protected String assetId

assetDiscovery

protected boolean assetDiscovery

Constructor Details

ProtocolDiscoveryStartRequestEvent

public ProtocolDiscoveryStartRequestEvent(String realm,
 String agentDescriptor,
 String assetId,
 boolean assetDiscovery)

Method Details

getAgentDescriptor

public String getAgentDescriptor()

getAssetId

public String getAssetId()

If isAssetDiscovery() then this should be the ID of the Agent on which Asset discovery should be initiated. Otherwise this should be the ID of the parent Asset under which the discovered Agent would be created.

isAssetDiscovery

public boolean isAssetDiscovery()