es.upv.dsic.gti_ia.trace
Class TraceInteract

java.lang.Object
  es.upv.dsic.gti_ia.trace.TraceInteract

public class TraceInteract
extends Object

Methods to interact with the trace manager in order to publish and unpublish tracing services, to subscribe and unsubscribe to/from tracing services and to list available tracing entities and services.

Author:

L Burdalo (lburdalo@dsic.upv.es)

Constructor Summary

TraceInteract()

Method Summary

static void	cancelTracingServiceSubscription(AgentID tms_aid, BaseAgent requesterAgent, String serviceName) Cancel subscription to a tracing service from any tracing entity.
static void	cancelTracingServiceSubscription(AgentID tms_aid, BaseAgent requesterAgent, String serviceName, AgentID originEntity) Cancel subscription to a tracing service from a specific tracing entity.
static void	cancelTracingServiceSubscription(BaseAgent requesterAgent, String serviceName) Cancel subscription to a tracing service from any tracing entity.
static void	cancelTracingServiceSubscription(BaseAgent requesterAgent, String serviceName, AgentID originEntity) Cancel subscription to a tracing service from a specific tracing entity.
static void	listTracingEntities(AgentID tms_aid, BaseAgent applicantAgent) Request a list of registered tracing entities to a specific trace manager entity.
static void	listTracingEntities(BaseAgent applicantAgent) Request a list of registered tracing entities.
static void	listTracingServices(AgentID tms_aid, BaseAgent applicantAgent) Request a list of registered tracing entities.
static void	listTracingServices(BaseAgent applicantAgent) Request a list of registered tracing services.
static void	publishTracingService(AgentID tms_aid, BaseAgent applicantAgent, String serviceName, String description) Publish a tracing service so that other agents can request it and receive the corresponding trace events.
static void	publishTracingService(BaseAgent applicantAgent, String serviceName, String description) Publish a tracing service so that other agents can request it and receive the corresponding trace events.
static void	requestAllTracingServices(AgentID tms_aid, BaseAgent requesterAgent) Request all tracing services available at the time.
static void	requestAllTracingServices(BaseAgent requesterAgent) Request all tracing services available at the time.
static void	requestTracingService(AgentID tms_aid, BaseAgent requesterAgent, String serviceName) Request a tracing service from any tracing entity.
static void	requestTracingService(AgentID tms_aid, BaseAgent requesterAgent, String serviceName, AgentID originEntity) Request a tracing service from a specific tracing entity.
static void	requestTracingService(BaseAgent requesterAgent, String serviceName) Request a tracing service from any tracing entity.
static void	requestTracingService(BaseAgent requesterAgent, String serviceName, AgentID originEntity) Request a tracing service from a specific tracing entity.
static void	unpublishTracingService(AgentID tms_aid, BaseAgent applicantAgent, String serviceName) Unpublish a tracing service.
static void	unpublishTracingService(BaseAgent applicantAgent, String serviceName) Unpublish a tracing service.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceInteract

public TraceInteract()

Method Detail

publishTracingService

public static void publishTracingService(BaseAgent applicantAgent,
                                         String serviceName,
                                         String description)

Publish a tracing service so that other agents can request it and receive the corresponding trace events.

The applicant agent must specify a name for the tracing service, the corresponding type of the trace events which will be provided by the service and a description of the tracing service.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method publishTracingService(AgentID tms_aid, BaseAgent applicantAgent, String serviceName, String description)

Parameters:

applicantAgent - Agent which wants to publish the tracing service

serviceName - Name of the tracing service which is to be published

description - Description of the tracing service to be published

See Also:

TracingService

publishTracingService

public static void publishTracingService(AgentID tms_aid,
                                         BaseAgent applicantAgent,
                                         String serviceName,
                                         String description)

Publish a tracing service so that other agents can request it and receive the corresponding trace events.

The applicant agent must specify a name for the tracing service, the corresponding type of the trace events which will be provided by the service and a description of the tracing service.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method publishTracingService(BaseAgent applicantAgent, String serviceName, String description)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the publication request

applicantAgent - Agent which wants to publish the tracing service

serviceName - Name of the tracing service which is to be published

description - Description of the tracing service to be published

See Also:

TracingService, AgentID

unpublishTracingService

public static void unpublishTracingService(BaseAgent applicantAgent,
                                           String serviceName)

Unpublish a tracing service.

Unpublish a previously published tracing service so that other agents cannot subscribe nor receive the corresponding trace events from the applicantAgent (if there were more providers of the tracing service, subscribers would still be able to receive trace events of that tracing service generated by these other providers.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method unpublishTracingService(AgentID tms_aid, BaseAgent applicantAgent, String serviceName)

Parameters:

applicantAgent - Agent which wants to unpublish the tracing service

serviceName - Name of the tracing service which is to be unpublished

unpublishTracingService

public static void unpublishTracingService(AgentID tms_aid,
                                           BaseAgent applicantAgent,
                                           String serviceName)

Unpublish a tracing service.

Unpublish a previously published tracing service so that other agents cannot subscribe nor receive the corresponding trace events from the applicantAgent (if there were more providers of the tracing service, subscribers would still be able to receive trace events of that tracing service generated by these other providers.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method unpublishTracingService(BaseAgent applicantAgent, String serviceName)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the unpublication request

applicantAgent - Agent which wants to unpublish the tracing service

serviceName - Name of the tracing service which is to be unpublished

requestTracingService

public static void requestTracingService(BaseAgent requesterAgent,
                                         String serviceName,
                                         AgentID originEntity)

Request a tracing service from a specific tracing entity.

The requester agent must specify a name for the tracing service, the corresponding type of the trace events which will be provided by the service and a description of the tracing service.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method requestTracingService(AgentID tms_aid, BaseAgent requesterAgent, String serviceName, AgentID originEntity)

This method requests a tracing service provided by a specific tracing entity. To request a tracing service from any tracing entity and receive the trace events of the corresponding tracing service from any entity in the system which offers that tracing service, use the method requestTracingService(BaseAgent requesterAgent, String serviceName)

Parameters:

requesterAgent - Agent which wants to request the tracing service

serviceName - Name of the tracing service which is to be requested

originEntity - AgentID of the tracing entity whose tracing service is requested

See Also:

TracingService

requestTracingService

public static void requestTracingService(AgentID tms_aid,
                                         BaseAgent requesterAgent,
                                         String serviceName,
                                         AgentID originEntity)

Request a tracing service from a specific tracing entity.

The requester agent must specify a name for the tracing service, the corresponding type of the trace events which will be provided by the service and a description of the tracing service.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method requestTracingService(BaseAgent requesterAgent, String serviceName, AgentID originEntity)

This method requests a tracing service provided by a specific tracing entity. To request a tracing service from any tracing entity and receive the trace events of the corresponding tracing service from any entity in the system which offers that tracing service, use the method requestTracingService(AgentID tms_aid, BaseAgent requesterAgent, String serviceName, AgentID originEntity)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

requesterAgent - Agent which wants to request the tracing service

serviceName - Name of the tracing service which is to be requested

originEntity - AgentID of the tracing entity whose tracing service is requested

See Also:

TracingService

requestTracingService

public static void requestTracingService(BaseAgent requesterAgent,
                                         String serviceName)

Request a tracing service from any tracing entity.

The requester agent must specify a name for the tracing service, the corresponding type of the trace events which will be provided by the service and a description of the tracing service.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method requestTracingService(AgentID tms_aid, BaseAgent requesterAgent, String serviceName)

This method requests a tracing service from any tracing entity which provides it. To request a tracing service from a specific tracing entity and receive only the trace events of the corresponding tracing service generated by that entity in the system, use the method requestTracingService(BaseAgent requesterAgent, String serviceName, AgentID originEntity)

Parameters:

requesterAgent - Agent which wants to request the tracing service

serviceName - Name of the tracing service which is to be requested

See Also:

TracingService

requestTracingService

public static void requestTracingService(AgentID tms_aid,
                                         BaseAgent requesterAgent,
                                         String serviceName)

Request a tracing service from any tracing entity.

The requester agent must specify a name for the tracing service, the corresponding type of the trace events which will be provided by the service and a description of the tracing service.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method requestTracingService(AgentID tms_aid, BaseAgent requesterAgent, String serviceName)

This method requests a tracing service to receive trace events coming from any tracing entity which provides it. To request a tracing service a specific tracing entity and receive only the trace events which that tracing entity generates, use the method requestTracingService(BaseAgent requesterAgent, String serviceName, AgentID originEntity)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

requesterAgent - Agent which wants to request the tracing service

serviceName - Name of the tracing service which is to be requested

See Also:

TracingService

requestAllTracingServices

public static void requestAllTracingServices(BaseAgent requesterAgent)

Request all tracing services available at the time.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method requestAllTracingServices(AgentID tms_aid, BaseAgent requesterAgent)

Parameters:

requesterAgent - Agent which wants to request tracing services

requestAllTracingServices

public static void requestAllTracingServices(AgentID tms_aid,
                                             BaseAgent requesterAgent)

Request all tracing services available at the time.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method requestAllTracingServices(BaseAgent requesterAgent)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

requesterAgent - Agent which wants to request tracing services

cancelTracingServiceSubscription

public static void cancelTracingServiceSubscription(BaseAgent requesterAgent,
                                                    String serviceName,
                                                    AgentID originEntity)

Cancel subscription to a tracing service from a specific tracing entity.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method cancelTracingServiceSubscription(AgentID tms_aid, BaseAgent requesterAgent, String serviceName, AgentID originEntity)

This method cancels the subscription to a tracing service from a specific tracing entity. To cancel a subscription to any entity, use the method cancelTracingServiceSubscription(BaseAgent requesterAgent, String serviceName)

Parameters:

requesterAgent - Agent which wants to cancel its subscription

serviceName - Name of the tracing service to which the subscription was made

originEntity - AgentID of the tracing entity to which the subscription referred to

cancelTracingServiceSubscription

public static void cancelTracingServiceSubscription(AgentID tms_aid,
                                                    BaseAgent requesterAgent,
                                                    String serviceName,
                                                    AgentID originEntity)

Cancel subscription to a tracing service from a specific tracing entity.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method cancelTracingServiceSubscription(BaseAgent requesterAgent, String serviceName, AgentID originEntity)

This method cancels the subscription to a tracing service from a specific tracing entity. To cancel a subscription to any entity, use the method cancelTracingServiceSubscription(AgentID tms_aid, BaseAgent requesterAgent, String serviceName)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

requesterAgent - Agent which wants to cancel its subscription

serviceName - Name of the tracing service to which the subscription was made

originEntity - AgentID of the tracing entity to which the subscription referred to

cancelTracingServiceSubscription

public static void cancelTracingServiceSubscription(BaseAgent requesterAgent,
                                                    String serviceName)

Cancel subscription to a tracing service from any tracing entity.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method cancelTracingServiceSubscription(AgentID tms_aid, BaseAgent requesterAgent, String serviceName)

This method cancels the subscription to a tracing service from a specific tracing entity. To cancel a subscription to any entity, use the method cancelTracingServiceSubscription(BaseAgent requesterAgent, String serviceName, AgentID originEntity)

Parameters:

requesterAgent - Agent which wants to cancel its subscription

serviceName - Name of the tracing service to which the subscription was made

cancelTracingServiceSubscription

public static void cancelTracingServiceSubscription(AgentID tms_aid,
                                                    BaseAgent requesterAgent,
                                                    String serviceName)

Cancel subscription to a tracing service from any tracing entity.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method cancelTracingServiceSubscription(BaseAgent requesterAgent, String serviceName)

This method cancels the subscription to a tracing service from a specific tracing entity. To cancel a subscription to any entity, use the method cancelTracingServiceSubscription(AgentID tms_aid, BaseAgent requesterAgent, String serviceName, AgentID originEntity)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

requesterAgent - Agent which wants to cancel its subscription

serviceName - Name of the tracing service to which the subscription was made

listTracingEntities

public static void listTracingEntities(BaseAgent applicantAgent)

Request a list of registered tracing entities.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method listTracingEntities(AgentID tms_aid, BaseAgent applicantAgent)

Parameters:

applicantAgent - Agent which wants to receive the list of tracing entities

listTracingEntities

public static void listTracingEntities(AgentID tms_aid,
                                       BaseAgent applicantAgent)

Request a list of registered tracing entities to a specific trace manager entity.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method listTracingEntities(BaseAgent applicantAgent)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

applicantAgent - Agent which wants to receive the list of tracing entities

listTracingServices

public static void listTracingServices(BaseAgent applicantAgent)

Request a list of registered tracing services.

This method communicates via ACL with a trace manager entity in localhost ("qpid://TM@localhost:8080"). To interact with a different trace manager entity, use the method listTracingServices(AgentID tms_aid, BaseAgent applicantAgent)

Parameters:

applicantAgent - Agent which wants to receive the list of tracing services

listTracingServices

public static void listTracingServices(AgentID tms_aid,
                                       BaseAgent applicantAgent)

Request a list of registered tracing entities.

This method communicates via ACL with the trace manager entity specified by the parameter tms_aid. To interact with the default trace manager entity in localhost ("qpid://TM@localhost:8080"), use the method listTracingServices(BaseAgent applicantAgent)

Parameters:

tms_aid - AgentID of the trace manager entity which is being sent the request

applicantAgent - Agent which wants to receive the list of tracing services