com.abiquo.event.interfaces

Interface Traceable<ID extends java.io.Serializable>

public interface Traceable<ID extends java.io.Serializable>

Implementations of this interface are meant to trace Event objects abroad.

Author:

Susana Acedo, Sergi Castro, Serafin Sedano

Method Summary

Modifier and Type	Method and Description
void	error(EntityAction.Action<?> action, ID identity, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, ErrorScope scope) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, ID identity, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, ErrorScope scope, EventDetails details) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, ID identity, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, java.lang.Throwable e, ErrorScope scope) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, ID identity, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, java.lang.Throwable e, ErrorScope scope, EventDetails details) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, ErrorScope scope) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, ErrorScope scope, EventDetails details) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError apiError, ErrorScope scope, EventDetails details, java.lang.String entityUri) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, java.lang.Throwable e, ErrorScope scope) Generates and traces a Event which is performed over a ID.
void	error(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, AbiquoError abiquoError, java.lang.Throwable e, ErrorScope scope, EventDetails details) Generates and traces a Event which is performed over a ID.
void	info(EntityAction.Action<?> action, ID entity, java.util.Optional<java.lang.Integer> enterpriseId) Generates and traces a Event which is performed over a ID.
void	info(EntityAction.Action<?> action, ID entity, java.util.Optional<java.lang.Integer> enterpriseId, EventDetails details) Generates and traces a Event which is performed over a ID add this details.
void	info(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId) Publication of Event whose Event.getEntityIdentifier() does not apply, is not known in the production context or is inferred from the context.
void	info(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, EventDetails details) Create an Event, this implies the addition and formatting the message, add this details.
void	info(EntityAction.Action<?> action, java.lang.String entityUri, java.util.Optional<java.lang.Integer> enterpriseId) Generates and traces a Event which is performed over the entity uri.
void	info(EntityAction.Action<?> action, java.lang.String entityUri, java.util.Optional<java.lang.Integer> enterpriseId, EventDetails details) Generates and traces a Event which is performed over the entity uri.
void	log(Event event) Straight publication of the Event. If any validation is performed depends on actual implementation.
void	warn(EntityAction.Action<?> action, ID identity, java.util.Optional<java.lang.Integer> enterpriseId) Generates and traces a Event which is performed over a ID.
void	warn(EntityAction.Action<?> action, ID identity, java.util.Optional<java.lang.Integer> enterpriseId, EventDetails details) Generates and traces a Event add this details.
void	warn(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId) Generates and traces a Event add this details.
void	warn(EntityAction.Action<?> action, java.util.Optional<java.lang.Integer> enterpriseId, EventDetails details) Generates and traces a Event add this details.

Method Detail

log

void log(Event event)

Straight publication of the Event.
If any validation is performed depends on actual implementation.

Parameters:

event - to publish.

info

void info(EntityAction.Action<?> action,
          java.util.Optional<java.lang.Integer> enterpriseId)

Publication of Event whose Event.getEntityIdentifier() does not apply, is not known in the production context or is inferred from the context.

Whether is possible to infer the Event.getEntityIdentifier() from the context or how it is done relies on the implementation.

In the case of the creation the preferred method is #info(Action, ID) if no EventDetails is needed. #info(Action, ID, EventDetails) otherwise.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

See Also:

#info(Action, ID)

info

void info(EntityAction.Action<?> action,
          java.util.Optional<java.lang.Integer> enterpriseId,
          EventDetails details)

Create an Event, this implies the addition and formatting the message, add this details.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

details - to add to the Event.

info

void info(EntityAction.Action<?> action,
          ID entity,
          java.util.Optional<java.lang.Integer> enterpriseId)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier(). Typical use case is a creation of an entity.

Parameters:

action - action on an entity.

entity - which receive the action.

enterpriseId - enterprise id of the entity.

info

void info(EntityAction.Action<?> action,
          java.lang.String entityUri,
          java.util.Optional<java.lang.Integer> enterpriseId)

Generates and traces a Event which is performed over the entity uri. This method is in charge for composing the message with the messageArgs if any.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier(). Typical use case is a creation of an entity.

Parameters:

action - action on an entity.

entityUri - which receive the action.

enterpriseId - enterprise id of the entity.

info

void info(EntityAction.Action<?> action,
          ID entity,
          java.util.Optional<java.lang.Integer> enterpriseId,
          EventDetails details)

Generates and traces a Event which is performed over a ID add this details. This method is in charge for composing the message with the messageArgs if any.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier(). Typical use case is a creation of an entity.

Parameters:

action - action on an entity.

entity - which receive the action.

enterpriseId - enterprise id of the entity.

details - extra information to add to the Event.

info

void info(EntityAction.Action<?> action,
          java.lang.String entityUri,
          java.util.Optional<java.lang.Integer> enterpriseId,
          EventDetails details)

Generates and traces a Event which is performed over the entity uri. This method is in charge for composing the message with the messageArgs if any.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier(). Typical use case is a creation of an entity.

Parameters:

action - action on an entity.

entityUri - which receive the action.

enterpriseId - enterprise id of the entity.

details - extra information to add to the Event.

warn

void warn(EntityAction.Action<?> action,
          java.util.Optional<java.lang.Integer> enterpriseId)

Generates and traces a Event add this details. This method is in charge for composing the message with the messageArgs if any.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

warn

void warn(EntityAction.Action<?> action,
          java.util.Optional<java.lang.Integer> enterpriseId,
          EventDetails details)

Generates and traces a Event add this details. This method is in charge for composing the message with the messageArgs if any.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

details - extra information to add to the Event.

warn

void warn(EntityAction.Action<?> action,
          ID identity,
          java.util.Optional<java.lang.Integer> enterpriseId)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier(). Typical use case is a creation of an entity.

Parameters:

action - action on an entity.

identity - which receive the action.

enterpriseId - enterprise id of the entity.

warn

void warn(EntityAction.Action<?> action,
          ID identity,
          java.util.Optional<java.lang.Integer> enterpriseId,
          EventDetails details)

Generates and traces a Event add this details. This method is in charge for composing the message with the messageArgs if any.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier(). Typical use case is a creation of an entity.

Parameters:

action - action on an entity.

identity - which receive the action.

enterpriseId - enterprise id of the entity.

details - extra information to add to the Event.

error

void error(EntityAction.Action<?> action,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           ErrorScope scope)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

scope - which belongs the Event.

error

void error(EntityAction.Action<?> action,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           java.lang.Throwable e,
           ErrorScope scope)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

e - exception that was arouse.

scope - which belongs the Event.

error

void error(EntityAction.Action<?> action,
           ID identity,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           ErrorScope scope)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

identity - which receive the action.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

scope - which belongs the Event.

error

void error(EntityAction.Action<?> action,
           ID identity,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           java.lang.Throwable e,
           ErrorScope scope)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

identity - which receive the action.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

e - exception that was arouse.

scope - which belongs the Event.

error

void error(EntityAction.Action<?> action,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           ErrorScope scope,
           EventDetails details)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

scope - which belongs the Event.

details - extra information to add to the Event.

error

void error(EntityAction.Action<?> action,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           java.lang.Throwable e,
           ErrorScope scope,
           EventDetails details)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

e - exception that was arouse.

scope - which belongs the Event.

details - extra information to add to the Event.

error

void error(EntityAction.Action<?> action,
           ID identity,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           ErrorScope scope,
           EventDetails details)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

identity - which receive the action.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

scope - which belongs the Event.

details - extra information to add to the Event.

error

void error(EntityAction.Action<?> action,
           ID identity,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError abiquoError,
           java.lang.Throwable e,
           ErrorScope scope,
           EventDetails details)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

Parameters:

action - action on an entity.

identity - which receive the action.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

e - exception that was arouse.

scope - which belongs the Event.

details - extra information to add to the Event.

error

void error(EntityAction.Action<?> action,
           java.util.Optional<java.lang.Integer> enterpriseId,
           AbiquoError apiError,
           ErrorScope scope,
           EventDetails details,
           java.lang.String entityUri)

Generates and traces a Event which is performed over a ID. This method is in charge for composing the message with the messageArgs if any.

This method generates a ErrorDetails with the parameters.

This method is useful to make sure that the correct entity is added as Event.getEntityIdentifier().

Parameters:

action - action on an entity.

enterpriseId - enterprise id of the entity.

abiquoError - abiquo error with code and message.

scope - which belongs the Event.

details - extra information to add to the Event.

entityUri - which receive the action.