org.openhubframework.openhub.api.entity

Class ExternalCall

java.lang.Object

org.openhubframework.openhub.api.entity.SuperEntity<Long>

org.openhubframework.openhub.api.entity.ExternalCall

All Implemented Interfaces:

Serializable, HumanReadable, Identifiable<Long>

@Entity
public class ExternalCall
extends SuperEntity<Long>

Evidence of calls to external systems (billing, VF, ...). This table serves for checking of duplication calls to external systems and checks obsolete calls.

Entity ID contains real entity ID for operations which change existing data or correlationID for operations which creates new data.

Special case are confirmations which have operation with the name ""confirmation"" and entity ID will be set to message ID. There are only confirmations which failed previously.

Author:

Petr Juza

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIRM_OPERATION

Constructor Summary

Constructors

Constructor and Description
ExternalCall()

Method Summary

Modifier and Type	Method and Description
static ExternalCall	createFailedConfirmation(Message msg) Creates new failed confirmation call.
static ExternalCall	createProcessingCall(String operationName, String entityId, Message msg) Creates a new external call with processing state.
boolean	equals(Object obj) Two entities are equal if their ID is equal.
Instant	getCreationTimestamp() Gets creation date of this entity.
String	getEntityId() Gets entity ID.
int	getFailedCount() Gets count of failed tries.
Long	getId() Gets unique external call ID.
Instant	getLastUpdateTimestamp() Gets timestamp when the entity was changed last time.
Message	getMessage() Gets main asynch.
Long	getMsgId() Gets parent message ID.
Instant	getMsgTimestamp() Gets message timestamp from source system.
String	getOperationName() Gets target operation identification (e.g.
ExternalCallStateEnum	getState() Gets state of processing.
boolean	isConfirmationCall() Gets true when external call represents confirmation call.
void	setCreationTimestamp(Instant creationTimestamp)
void	setEntityId(String entityId)
void	setFailedCount(int failedCount)
void	setId(Long id) Sets unique identifier of the entity.
void	setLastUpdateTimestamp(Instant lastUpdateTimestamp)
void	setMessage(Message message)
void	setMsgId(Long msgId)
void	setMsgTimestamp(Instant msgTimestamp)
void	setOperationName(String operationName)
void	setState(ExternalCallStateEnum state)
String	toHumanString() Returns human readable entity identification with start and end round brackets.
String	toString()

Methods inherited from class org.openhubframework.openhub.api.entity.SuperEntity

hashCode, isNew

Methods inherited from class java.lang.Object

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

Field Detail

CONFIRM_OPERATION

public static final String CONFIRM_OPERATION

See Also:

Constant Field Values

Constructor Detail

ExternalCall

public ExternalCall()

Method Detail

createFailedConfirmation

public static ExternalCall createFailedConfirmation(Message msg)

Creates new failed confirmation call.

Parameters:

msg - the message

Returns:

external call entity

createProcessingCall

public static ExternalCall createProcessingCall(String operationName,
                                                String entityId,
                                                Message msg)

Creates a new external call with processing state.

Parameters:

operationName - the name of operation

entityId - the ID of entity (external ID as constraint of processing)

msg - the message

Returns:

external call entity

getId

public Long getId()

Gets unique external call ID.

Specified by:

getId in interface Identifiable<Long>

Overrides:

getId in class SuperEntity<Long>

Returns:

unique ID

setId

public void setId(Long id)

Description copied from interface: Identifiable

Sets unique identifier of the entity.

Specified by:

setId in interface Identifiable<Long>

Overrides:

setId in class SuperEntity<Long>

Parameters:

id - unique identifier

getMsgId

public Long getMsgId()

Gets parent message ID.

Returns:

message ID

setMsgId

public void setMsgId(Long msgId)

getMessage

public Message getMessage()

Gets main asynch. message.

Returns:

message

setMessage

public void setMessage(Message message)

getOperationName

public String getOperationName()

Gets target operation identification (e.g. target system name + operation name).

Returns:

operation name

setOperationName

public void setOperationName(String operationName)

getState

public ExternalCallStateEnum getState()

Gets state of processing.

Returns:

state

setState

public void setState(ExternalCallStateEnum state)

getEntityId

public String getEntityId()

Gets entity ID.

Returns:

entity ID

setEntityId

public void setEntityId(String entityId)

getCreationTimestamp

public Instant getCreationTimestamp()

Gets creation date of this entity.

Returns:

creation date

setCreationTimestamp

public void setCreationTimestamp(Instant creationTimestamp)

getLastUpdateTimestamp

public Instant getLastUpdateTimestamp()

Gets timestamp when the entity was changed last time.

Returns:

timestamp

setLastUpdateTimestamp

public void setLastUpdateTimestamp(Instant lastUpdateTimestamp)

getMsgTimestamp

public Instant getMsgTimestamp()

Gets message timestamp from source system.

Returns:

message timestamp

See Also:

Message.getMsgTimestamp()

setMsgTimestamp

public void setMsgTimestamp(Instant msgTimestamp)

getFailedCount

public int getFailedCount()

Gets count of failed tries. This value has sense only when isConfirmationCall() is true.

Returns:

failedCount of failed tries

setFailedCount

public void setFailedCount(int failedCount)

isConfirmationCall

public boolean isConfirmationCall()

Gets true when external call represents confirmation call.

Returns:

true for confirmation call, otherwise false

equals

public boolean equals(Object obj)

Description copied from class: SuperEntity

Two entities are equal if their ID is equal.

Overrides:

equals in class SuperEntity<Long>

toString

public String toString()

Overrides:

toString in class SuperEntity<Long>

toHumanString

public String toHumanString()

Description copied from interface: HumanReadable

Returns human readable entity identification with start and end round brackets.

Specified by:

toHumanString in interface HumanReadable

Overrides:

toHumanString in class SuperEntity<Long>

Returns:

entity identification