Class MessageHandlerKey
- java.lang.Object
-
- com.inductiveautomation.ignition.common.script.message.MessageHandlerKey
-
- All Implemented Interfaces:
java.lang.Comparable<MessageHandlerKey>
public class MessageHandlerKey extends java.lang.Object implements java.lang.Comparable<MessageHandlerKey>
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.List<java.lang.String>
CLIENT_THREAD_TYPES
static java.util.List<java.lang.String>
GATEWAY_THREAD_TYPES
static java.lang.String
THREAD_DEDICATED
static java.lang.String
THREAD_EDT
static java.lang.String
THREAD_SHARED
-
Constructor Summary
Constructors Constructor Description MessageHandlerKey()
MessageHandlerKey(MessageHandlerKey copy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(MessageHandlerKey other)
boolean
equals(java.lang.Object obj)
java.lang.String
getName()
java.util.List<ZoneRoleRequirement>
getPermissions()
java.lang.String
getThreadType()
int
hashCode()
boolean
hasPermissions(java.util.Collection<java.lang.String> roles, java.util.Collection<java.lang.String> zones)
Checks if the list of roles and zones passed in matches the required zones/roles.boolean
isEnabled()
void
setEnabled(boolean enabled)
void
setName(java.lang.String name)
void
setPermissions(java.util.List<ZoneRoleRequirement> permissions)
void
setThreadType(java.lang.String threadType)
java.lang.String
toString()
-
-
-
Field Detail
-
THREAD_SHARED
public static final java.lang.String THREAD_SHARED
- See Also:
- Constant Field Values
-
THREAD_DEDICATED
public static final java.lang.String THREAD_DEDICATED
- See Also:
- Constant Field Values
-
THREAD_EDT
public static final java.lang.String THREAD_EDT
- See Also:
- Constant Field Values
-
CLIENT_THREAD_TYPES
public static final java.util.List<java.lang.String> CLIENT_THREAD_TYPES
-
GATEWAY_THREAD_TYPES
public static final java.util.List<java.lang.String> GATEWAY_THREAD_TYPES
-
-
Constructor Detail
-
MessageHandlerKey
public MessageHandlerKey()
-
MessageHandlerKey
public MessageHandlerKey(MessageHandlerKey copy)
-
-
Method Detail
-
compareTo
public int compareTo(MessageHandlerKey other)
- Specified by:
compareTo
in interfacejava.lang.Comparable<MessageHandlerKey>
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getName
public java.lang.String getName()
-
setName
public void setName(java.lang.String name)
-
isEnabled
public boolean isEnabled()
-
setEnabled
public void setEnabled(boolean enabled)
-
getThreadType
public java.lang.String getThreadType()
-
setThreadType
public void setThreadType(java.lang.String threadType)
-
getPermissions
@Nullable public java.util.List<ZoneRoleRequirement> getPermissions()
-
setPermissions
public void setPermissions(java.util.List<ZoneRoleRequirement> permissions)
-
hasPermissions
public boolean hasPermissions(@Nullable java.util.Collection<java.lang.String> roles, @Nullable java.util.Collection<java.lang.String> zones)
Checks if the list of roles and zones passed in matches the required zones/roles.- Parameters:
roles
- List of roles the user has. May be null.zones
- List of zones the user has. May be null.- Returns:
- True if at least one match.
-
-