Package com.inductiveautomation.ignition.gateway.dataroutes

Record Class RoutePushContext

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.dataroutes.RoutePushContext

All Implemented Interfaces:

ResourceAction.ContextObject

public record RoutePushContext(HttpMethod method, URI uri, String actor)
extends Record
implements ResourceAction.ContextObject

Used as the "context object" for push operations that originate from resource CRUD routes.

See Also:

• PushOperation.getContextObject()
• ResourceCollectionChangeEvent.getContextObject()
• ResourceChangeContext.getContextObject()

Constructor Summary

Constructors

Constructor	Description
RoutePushContext(HttpMethod method, URI uri, String actor)	Creates an instance of a RoutePushContext record class.

Method Summary

Modifier and Type	Method	Description
String	actor()	Returns the value of the actor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static RoutePushContext	forRequest(RequestContext requestContext)
String	getActor()
final int	hashCode()	Returns a hash code value for this object.
HttpMethod	method()	Returns the value of the method record component.
final String	toString()	Returns a string representation of this record class.
URI	uri()	Returns the value of the uri record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RoutePushContext

public RoutePushContext(HttpMethod method,
 URI uri,
 String actor)

Creates an instance of a RoutePushContext record class.

Parameters:

method - the value for the method record component

uri - the value for the uri record component

actor - the value for the actor record component

Method Details

forRequest

public static RoutePushContext forRequest(RequestContext requestContext)

getActor

public String getActor()

Specified by:

getActor in interface ResourceAction.ContextObject

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

method

public HttpMethod method()

Returns the value of the method record component.

Returns:

the value of the method record component

uri

public URI uri()

Returns the value of the uri record component.

Returns:

the value of the uri record component

actor

public String actor()

Returns the value of the actor record component.

Returns:

the value of the actor record component