|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.agent.events.AgentMessagingTools
public class AgentMessagingTools
The class contains the configurations and utility methods for creating and sending agent events.
Field Summary | |
---|---|
static java.lang.String |
CHANGE_PASSWORD_TYPE
Agent Activity Type for a ProfilePasswordChanged |
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
END_CALL_TYPE
Agent Activity Type for an end call |
protected AgentTools |
mAgentTools
|
static java.lang.String |
NEW_CALL_TYPE
Agent Activity Type for a new call |
static java.lang.String |
ORGANIZATION_CREATED_TYPE
Agent Activity Type for a OrganizationCreated |
static java.lang.String |
PROFILE_ADDED_TO_ORG_TYPE
Agent Activity Type for a ProfileAddedToOrg |
static java.lang.String |
PROFILE_CREATED_TYPE
Agent Activity Type for a Profile Create |
static java.lang.String |
PROFILE_REMOVED_FROM_ORG_TYPE
Agent Activity Type for a ProfileRemovedFromOrg |
static java.lang.String |
PROFILE_UPDATED_TYPE
Agent Activity Type for a Profile Update |
static java.lang.String |
PROFILE_VIEWED_TYPE
Agent Activity Type for a Profile View |
static java.lang.String |
SESSIONEND_TYPE
Agent Activity Type for a SessionEnd |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
AgentMessagingTools()
|
Method Summary | |
---|---|
AgentEvent |
createAgentEvent(java.lang.String pActivityType,
java.lang.String pCustomerProfileId)
Creates a new AgentEvent with the given customer profile ID |
AgentEvent |
createAgentEvent(java.lang.String pActivityType,
java.lang.String pCustomerProfileId,
java.lang.String pTicketId)
Creates a new AgentEvent with the given customer profile ID |
CallEvent |
createCallEvent(java.lang.String pActivityType,
java.lang.String pCustomerProfileId,
java.lang.String pCallId,
java.util.Date pStartTime,
java.util.Date pEndTime)
Creates a new CallEvent |
CallEvent |
createCallEvent(java.lang.String pActivityType,
java.lang.String pCustomerProfileId,
java.lang.String pTicketId,
java.lang.String pCallId,
java.util.Date pStartTime,
java.util.Date pEndTime)
Creates a new CallEvent |
ItemUpdateAgentEvent |
createItemUpdateAgentEvent(java.lang.String pActivityType,
RepositoryItem pUpdatedRepositoryItem,
java.lang.String pCustomerProfileId,
java.util.Collection pPropertyUpdates,
java.lang.String pTicketId)
Creates a ItemUpdateAgentEvent. |
AgentEvent |
createProfileViewedAgentEvent(java.lang.String pViewedCustomerProfileId)
Creates a profile viewed agent event. |
AgentEvent |
createProfileViewedAgentEvent(java.lang.String pActivityType,
java.lang.String pViewedCustomerProfileId)
Creates a profile viewed agent event. |
ItemUpdateAgentEvent |
generateAgentEventForItemUpdate(RepositoryItem pUpdatedItem,
RepositoryItem pCustomerProfile,
java.lang.String pActivityType,
java.util.Dictionary pNewValues,
java.lang.String pTicketId)
Generates an agent event for the updates in the values dictionary. |
AgentMessageSource |
getAgentMessageSource()
|
AgentTools |
getAgentTools()
|
java.lang.String |
getChangePasswordJMSType()
|
java.lang.String |
getCreateProfileJMSType()
|
java.lang.String |
getEndCallJMSType()
|
java.lang.String |
getNewCallJMSType()
|
java.lang.String |
getOrganizationCreatedJMSType()
|
java.lang.String |
getProfileAddedToOrgJMSType()
|
java.lang.String |
getProfileRemovedFromOrgJMSType()
|
ProfileTools |
getProfileTools()
The ProfileTools component |
java.lang.String |
getSessionEndJMSType()
|
java.lang.String |
getUpdateOrganizationJMSType()
|
java.lang.String |
getUpdateProfileJMSType()
|
java.lang.String |
getViewProfileJMSType()
|
void |
sendChangePasswordEvent(java.lang.String pProfileId,
java.lang.String pTicketId)
Sends the ChangePassword event using the JMSType defined by the changePasswordJMSType
property. |
void |
sendChangePasswordEvent(java.lang.String pProfileId,
java.lang.String pTicketId,
java.lang.String pPortName)
Sends the ChangePassword event using the JMSType defined by the changePasswordJMSType
property. |
void |
sendCreateProfileEvent(java.lang.String pNewProfileId,
java.lang.String pTicketId)
Sends the CreateProfile event using the JMSType defined by the createProfileJMSType
property. |
void |
sendCreateProfileEvent(java.lang.String pNewProfileId,
java.lang.String pTicketId,
java.lang.String pPortName)
Sends the CreateProfile event using the JMSType defined by the createProfileJMSType
property. |
void |
sendEndCallEvent(java.lang.String pCustomerProfileId,
java.lang.String pCallId,
java.util.Date pStartTime,
java.util.Date pEndTime)
Sends the EndCall event using the JMSType defined by the endCallJMSType
property. |
void |
sendEndCallEvent(java.lang.String pCustomerProfileId,
java.lang.String pPortName,
java.lang.String pCallId,
java.util.Date pStartTime,
java.util.Date pEndTime)
Sends the EndCall event using the JMSType defined by the endCallJMSType
property. |
void |
sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent,
java.lang.String pJMSType)
|
void |
sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent,
java.lang.String pJMSType,
java.lang.String pPortName)
Sends a ItemUpdateAgentEvent to the specified port. |
void |
sendNewCallEvent(java.lang.String pCustomerProfileId,
java.lang.String pCallId,
java.util.Date pStartTime,
java.util.Date pEndTime)
Sends the NewCall event using the JMSType defined by the newCallJMSType
property. |
void |
sendNewCallEvent(java.lang.String pCustomerProfileId,
java.lang.String pPortName,
java.lang.String pCallId,
java.util.Date pStartTime,
java.util.Date pEndTime)
Sends the NewCall event using the JMSType defined by the newCallJMSType
property. |
void |
sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId,
java.lang.String pTicketId)
Sends the OrganizationCreated event using the JMSType defined by the organizationCreatedJMSType
property. |
void |
sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId,
java.lang.String pTicketId,
java.lang.String pPortName)
Sends the OrganizationCreated event using the JMSType defined by the organizationCreatedJMSType
property. |
void |
sendProfileAddedToOrgEvent(java.lang.String pAddedProfileId,
java.lang.String pOrganizationId,
java.lang.String pTicketId,
java.lang.String pPortName)
Sends an event that indicates a profile was added to an organization. |
void |
sendProfileRemovedFromOrgEvent(java.lang.String pRemovedProfileId,
java.lang.String pOrganizationId,
java.lang.String pTicketId,
java.lang.String pPortName)
Sends an event that indicates a profile was removed from an organization. |
void |
sendSessionEndEvent(java.lang.String pAgentProfileId,
java.lang.String pParentOrganizationId,
java.lang.String pSessionId,
long pSessionCreateTime,
long pSessionDuration)
Sends agent session end event |
void |
sendSessionEndEvent(java.lang.String pAgentProfileId,
java.lang.String pParentOrganizationId,
java.lang.String pSessionId,
long pSessionCreateTime,
long pSessionDuration,
java.lang.String pPortName)
Sends agent session end event |
void |
sendViewProfileEvent(java.lang.String pCustomerProfileId)
Sends the ViewProfile event using the JMSType defined by the viewProfileJMSType
property. |
void |
sendViewProfileEvent(java.lang.String pCustomerProfileId,
java.lang.String pPortName)
Sends the ViewProfile event using the JMSType defined by the viewProfileJMSType
property. |
void |
setAgentMessageSource(AgentMessageSource pAgentMessageSource)
The component used to send agent event messages |
void |
setAgentTools(AgentTools pCSRAgentTools)
Sets the property AgentTools. |
void |
setChangePasswordJMSType(java.lang.String pChangePasswordJMSType)
Sets the JMS Type used for the change password event |
void |
setCreateProfileJMSType(java.lang.String pCreateProfileJMSType)
Sets the JMS Type used for the create profile event |
void |
setEndCallJMSType(java.lang.String pEndCallJMSType)
Sets the JMS Type used for the end call event |
void |
setNewCallJMSType(java.lang.String pNewCallJMSType)
Sets the JMS Type used for the new call event |
void |
setOrganizationCreatedJMSType(java.lang.String pOrganizationCreatedJMSType)
Sets the JMS Type used for the create organization event |
void |
setProfileAddedToOrgJMSType(java.lang.String pProfileAddedToOrgJMSType)
Sets the JMS Type used when added a profile to an organization |
void |
setProfileRemovedFromOrgJMSType(java.lang.String pProfileRemovedFromOrgJMSType)
Sets the JMS Type used when removing a profile from an organization |
void |
setProfileTools(ProfileTools pProfileTools)
Sets the ProfileTools component |
void |
setSessionEndJMSType(java.lang.String pSessionEndJMSType)
|
void |
setUpdateOrganizationJMSType(java.lang.String pUpdateOrganizationJMSType)
Sets the JMS Type used for the edit organization event |
void |
setUpdateProfileJMSType(java.lang.String pUpdateProfileJMSType)
Sets the JMS Type used for the edit profile event |
void |
setViewProfileJMSType(java.lang.String pViewProfileJMSType)
Sets the JMS Type used for the view profile event |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
public static final java.lang.String NEW_CALL_TYPE
public static final java.lang.String END_CALL_TYPE
public static final java.lang.String PROFILE_UPDATED_TYPE
public static final java.lang.String PROFILE_CREATED_TYPE
public static final java.lang.String PROFILE_VIEWED_TYPE
public static final java.lang.String PROFILE_REMOVED_FROM_ORG_TYPE
public static final java.lang.String PROFILE_ADDED_TO_ORG_TYPE
public static final java.lang.String CHANGE_PASSWORD_TYPE
public static final java.lang.String SESSIONEND_TYPE
public static final java.lang.String ORGANIZATION_CREATED_TYPE
protected AgentTools mAgentTools
Constructor Detail |
---|
public AgentMessagingTools()
Method Detail |
---|
public void setAgentTools(AgentTools pCSRAgentTools)
public AgentTools getAgentTools()
public void setProfileTools(ProfileTools pProfileTools)
pProfileTools
- the ProfileTools componentpublic ProfileTools getProfileTools()
public void setAgentMessageSource(AgentMessageSource pAgentMessageSource)
pAgentMessageSource
- the component used to send agent event messagespublic AgentMessageSource getAgentMessageSource()
public java.lang.String getSessionEndJMSType()
public void setSessionEndJMSType(java.lang.String pSessionEndJMSType)
pSessionEndJMSType
- The sessionEndJMSType to set.public void setChangePasswordJMSType(java.lang.String pChangePasswordJMSType)
pChangePasswordJMSType
- the JMS Type used for the change password eventpublic java.lang.String getChangePasswordJMSType()
public void setCreateProfileJMSType(java.lang.String pCreateProfileJMSType)
pCreateProfileJMSType
- the JMS Type used for the create profile eventpublic java.lang.String getCreateProfileJMSType()
public void setOrganizationCreatedJMSType(java.lang.String pOrganizationCreatedJMSType)
pOrganizationCreatedJMSType
- the JMS Type used for the create organization eventpublic java.lang.String getOrganizationCreatedJMSType()
public void setProfileRemovedFromOrgJMSType(java.lang.String pProfileRemovedFromOrgJMSType)
pProfileRemovedFromOrgJMSType
- the JMS Type used when removing a profile from an organizationpublic java.lang.String getProfileRemovedFromOrgJMSType()
public void setProfileAddedToOrgJMSType(java.lang.String pProfileAddedToOrgJMSType)
pProfileAddedToOrgJMSType
- the JMS Type used when added a profile to an organizationpublic java.lang.String getProfileAddedToOrgJMSType()
public void setUpdateProfileJMSType(java.lang.String pUpdateProfileJMSType)
pUpdateProfileJMSType
- the JMS Type used for the edit profile eventpublic java.lang.String getUpdateProfileJMSType()
public void setUpdateOrganizationJMSType(java.lang.String pUpdateOrganizationJMSType)
pUpdateOrganizationJMSType
- the JMS Type used for the edit organization eventpublic java.lang.String getUpdateOrganizationJMSType()
public void setNewCallJMSType(java.lang.String pNewCallJMSType)
pNewCallJMSType
- the JMS Type used for the new call eventpublic java.lang.String getNewCallJMSType()
public void setEndCallJMSType(java.lang.String pEndCallJMSType)
pEndCallJMSType
- the JMS Type used for the end call eventpublic java.lang.String getEndCallJMSType()
public void setViewProfileJMSType(java.lang.String pViewProfileJMSType)
pViewProfileJMSType
- the JMS Type used for the view profile eventpublic java.lang.String getViewProfileJMSType()
public AgentEvent createAgentEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId)
pActivityType
- the event activity type.pCustomerProfileId
- the customer profile id to associate with the event.
public AgentEvent createAgentEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId, java.lang.String pTicketId)
pActivityType
- the event activity type.pCustomerProfileId
- the customer profile id to associate with the event.pTicketId
- the ticket id associated with the event
public CallEvent createCallEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId, java.lang.String pTicketId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
pActivityType
- the event activity type.pCustomerProfileId
- the customer profile id to associate with the event.pTicketId
- the ticket id associated with the eventpCallId
- id for callpStartTime
- call start timepEndTime
- call end time
public CallEvent createCallEvent(java.lang.String pActivityType, java.lang.String pCustomerProfileId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
pActivityType
- the event activity type.pCustomerProfileId
- the customer profile id to associate with the event.pCallId
- id for callpStartTime
- call start timepEndTime
- call end time
public void sendSessionEndEvent(java.lang.String pAgentProfileId, java.lang.String pParentOrganizationId, java.lang.String pSessionId, long pSessionCreateTime, long pSessionDuration)
pAgentProfileId
- Agent's profile idpParentOrganizationId
- parentOrganization of the Agent. Can be null if the aganet doesn't have a parent organizationpSessionId
- HTTP Session idpSessionCreateTime
- Session create time in millisecondspSessionDuration
- HTTP Session duration in secondspublic void sendSessionEndEvent(java.lang.String pAgentProfileId, java.lang.String pParentOrganizationId, java.lang.String pSessionId, long pSessionCreateTime, long pSessionDuration, java.lang.String pPortName)
pAgentProfileId
- Agent's profile idpParentOrganizationId
- parentOrganization of the Agent. Can be null if the aganet doesn't have a parent organizationpSessionId
- HTTP Session idpSessionCreateTime
- Session create time in millisecondspSessionDuration
- HTTP Session duration in secondspPortName
- JMS port to send the message onpublic void sendChangePasswordEvent(java.lang.String pProfileId, java.lang.String pTicketId)
changePasswordJMSType
property.
pProfileId
- the id of the customer profilepTicketId
- the id of the associated ticketpublic void sendChangePasswordEvent(java.lang.String pProfileId, java.lang.String pTicketId, java.lang.String pPortName)
changePasswordJMSType
property.
pProfileId
- the id of the new customer profilepTicketId
- the id of the associated ticketpPortName
- the port name to use for sending the event.AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public void sendCreateProfileEvent(java.lang.String pNewProfileId, java.lang.String pTicketId)
createProfileJMSType
property.
pNewProfileId
- the id of the new customer profilepTicketId
- the id of the associated ticketpublic void sendCreateProfileEvent(java.lang.String pNewProfileId, java.lang.String pTicketId, java.lang.String pPortName)
createProfileJMSType
property.
pNewProfileId
- the id of the new customer profilepTicketId
- the id of the associated ticketpPortName
- the port name to use for sending the event.AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public void sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId, java.lang.String pTicketId)
organizationCreatedJMSType
property.
pNewOrganizationId
- the id of the new organizationpTicketId
- the id of the associated ticketpublic void sendOrganizationCreatedEvent(java.lang.String pNewOrganizationId, java.lang.String pTicketId, java.lang.String pPortName)
organizationCreatedJMSType
property.
pNewOrganizationId
- the id of the new organizationpTicketId
- the id of the associated ticketpPortName
- the port name to use for sending the event.public void sendProfileRemovedFromOrgEvent(java.lang.String pRemovedProfileId, java.lang.String pOrganizationId, java.lang.String pTicketId, java.lang.String pPortName)
It uses the JMSType defined by the profileRemovedFromOrgJMSType
property.
pRemovedProfileId
- the id of the removed customer profilepOrganizationId
- the id of the organization.pTicketId
- the id of the associated ticketpPortName
- the port name to use for sending the event.AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public void sendProfileAddedToOrgEvent(java.lang.String pAddedProfileId, java.lang.String pOrganizationId, java.lang.String pTicketId, java.lang.String pPortName)
It uses the JMSType defined by the profileAddedFromOrgJMSType
property.
pAddedProfileId
- the id of the added customer profilepOrganizationId
- the id of the organization.pTicketId
- the id of the associated ticketpPortName
- the port name to use for sending the event.AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public ItemUpdateAgentEvent createItemUpdateAgentEvent(java.lang.String pActivityType, RepositoryItem pUpdatedRepositoryItem, java.lang.String pCustomerProfileId, java.util.Collection pPropertyUpdates, java.lang.String pTicketId)
pActivityType
- the activity type for the update.pUpdatedRepositoryItem
- the item that was updated.pCustomerProfileId
- the customer profile id to associate with the event.pPropertyUpdates
- a collection of property updates that details the changes made in the updatepTicketId
- the id of the associated ticket
public AgentEvent createProfileViewedAgentEvent(java.lang.String pViewedCustomerProfileId)
pViewedCustomerProfileId
- the profile that was viewed.pTicketId
- the id of the associated ticket
public AgentEvent createProfileViewedAgentEvent(java.lang.String pActivityType, java.lang.String pViewedCustomerProfileId)
pActivityType
- the activity typepViewedCustomerProfileId
- the profile that was viewed.
public void sendNewCallEvent(java.lang.String pCustomerProfileId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
newCallJMSType
property.
pCustomerProfileId
- the id of the customer profile for which the new call was started.pCallId
- id for callpStartTime
- call start timepEndTime
- call end timepublic void sendNewCallEvent(java.lang.String pCustomerProfileId, java.lang.String pPortName, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
newCallJMSType
property.
pCustomerProfileId
- the id of the customer profile for which the new call was started.pPortName
- the port name to use for sending the event.pCallId
- id for callpStartTime
- call start timepEndTime
- call end timeAgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public void sendEndCallEvent(java.lang.String pCustomerProfileId, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
endCallJMSType
property.
pCustomerProfileId
- the id of the customer profile for which the call was endedpCallId
- id for callpStartTime
- call start timepEndTime
- call end timepublic void sendEndCallEvent(java.lang.String pCustomerProfileId, java.lang.String pPortName, java.lang.String pCallId, java.util.Date pStartTime, java.util.Date pEndTime)
endCallJMSType
property.
pCustomerProfileId
- the id of the customer profile for which the call was endedpPortName
- the port name to use for sending the event.pCallId
- id for callpStartTime
- call start timepEndTime
- call end timeAgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public void sendViewProfileEvent(java.lang.String pCustomerProfileId)
viewProfileJMSType
property.
pCustomerProfileId
- the id of the customer whose profile was viewedpublic void sendViewProfileEvent(java.lang.String pCustomerProfileId, java.lang.String pPortName)
viewProfileJMSType
property.
pCustomerProfileId
- the id of the customer whose profile was viewedpPortName
- the port name to use for sending the event.AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
public ItemUpdateAgentEvent generateAgentEventForItemUpdate(RepositoryItem pUpdatedItem, RepositoryItem pCustomerProfile, java.lang.String pActivityType, java.util.Dictionary pNewValues, java.lang.String pTicketId)
pUpdatedItem
- the item being updated.pCustomerProfile
- the customer profile to associate with the new events.pActivityType
- the activity type to use in the the ItemUpdateAgentEvent.pNewValues
- a value dictionary from ProfileForm or RepositoryFormHandler.pTicketId
- the id of the associated ticket
ProfileTools.buildPropertyUpdatesForDictionary(RepositoryItem, Dictionary)
public void sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent, java.lang.String pJMSType)
pEvent
- pJMSType
- sendItemUpdateAgentEvent(ItemUpdateAgentEvent, String, String)
public void sendItemUpdateAgentEvent(ItemUpdateAgentEvent pEvent, java.lang.String pJMSType, java.lang.String pPortName)
pAgentEvent
- the item update agent eventpJMSType
- the jms type to use for sending the eventpPortName
- the port name to use for sending the event.AgentMessageSource.sendAgentEventMessage(AgentEvent, String, String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |