com.secutix.plugin.em.v1_0

Class ExternalManagerPlugin

java.lang.Object

com.secutix.plugin.v1_0.AbstractStxPlugin

com.secutix.plugin.em.v1_0.ExternalManagerPlugin

public abstract class ExternalManagerPlugin
extends AbstractStxPlugin

To implement a plugin, override this class. Fill abstract method (they may have been pre-implemented by S-360 team)

• Override readCatalog if you want to be able to access and log a catalog content.
• Override availabilityForProduct if you want to be able to return the availabilities of your product.
• Override executeJustBeforeClosingOrder if you want to be notified when an order containing your product is closed.

Only override methods for behaviors handled by your plugin. A method must never throw any exception, and always return a PluginCallResult object.

• Connection and context parameters (url, login, password...) can be accessed through : interfaceParametersProvider
• Logging must be done through getLogger() helper.
• Logging for operator (in the application) must i18nized and done through logForOperator method.
• doing http requests must be done through getCurrentHttpClientHelper() (this helper guarantee the use of internal S-360 proxies, timeouts, etc.)

Author:

lkl, qhr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalManagerPlugin.EntityGranularity
static class	ExternalManagerPlugin.ResynchronisationCauseEnum

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTINGENT_CODE

Fields inherited from class com.secutix.plugin.v1_0.AbstractStxPlugin

watch

Constructor Summary

Constructors

Constructor and Description
ExternalManagerPlugin()

Method Summary

Modifier and Type	Method and Description
PluginCallResult	associateTicketToRfid(String rfidCode, String ticketAdditionnalInfo, TicketInformationData ticketInformationData)
AssociateTicketToRfidResult	associateTicketToRfidAndUpdateContact(String rfidCode, String ticketAdditionnalInfo, TicketInformationData ticketInformationData)
AvailabilityResult	availabilityForProduct(String productMapping, Date performanceDate, String performanceMapping, List<String> itemOrCategoryMappings, List<String> contingentMappings, List<String> areaMappings, List<String> blockMappings) Method called by S-360 to get the availability for a given product
SeatSelectionResult	cancelSeatSelection(SeatSelectionQuery query, List<SeatSelectionData> seatSelectionData)
List<String>	checkSeatAttribution(SeatSelectionResult res)
ClosingOrderResult	executeJustBeforeClosingOrder(OrderData orderData)
GeneratingTicketResult	generateTicket(TicketInformationData ticketInformationData, boolean doProceedToGeneration, PrinterData printerData)
CatalogReader	getCatalogReader()
EnumSet<ExternalManagerPlugin.EntityGranularity>	getEntityGranularity() Method called by S-360 to know what information is required by the plugin.
ExternalReferencesAccessor	getExternalReferencesAccessor()
OrderReader	getOrderReader()
OrganizationReader	getOrganizationReader()
TicketReader	getTicketReader()
TicketUpdater	getTicketUpdater()
boolean	handlesReservations() If returning false, then reservation information will never be transmitted to the plugin.
PluginCallResult	readCatalog()
Boolean	requiredToApplyAllProducts() Method called by Secutix to know if this plugin required to apply for all products.
ResynchronizationOrderPluginResult	resynchronizeOrders(List<OrderData> orders, ExternalManagerPlugin.ResynchronisationCauseEnum cause, String remark)
SeatAvailabilityResult	seatsAvailability(String productMapping, Date performanceDate, String performanceMapping, List<String> itemOrCategoryMappings, List<String> contingentMappings, List<String> areaMappings, List<String> blockMappings, Date lastModified, List<SeatData> availabilityAmongThoseSeats)
SeatSelectionResult	selectSeatsInPerformance(String productMapping, Date performanceDate, String performanceMapping, String categoryMapping, String contingentMapping, List<String> areaMappings, List<String> blockMappings, boolean selectionForcedInAreas, Map<String,Integer> quantityPerTariffMapping, int quantity, Long orderId, String sessionId) Called by S-360 to ask the external system to assign seats for a performance according to the preferences passed in the parameters.
SeatSelectionResult	selectSeatsInPerformanceFromQuery(SeatSelectionQuery query)
void	setCatalogReader(CatalogReader catalogReader)
void	setExternalReferencesAccessor(ExternalReferencesAccessor externalReferencesAccessor)
void	setOrderReader(OrderReader orderReader)
void	setOrganizationReader(OrganizationReader organizationReader)
void	setTicketReader(TicketReader ticketReader)
void	setTicketUpdater(TicketUpdater ticketUpdater)
SynchronizationTicketResult	synchronizeTickets(List<TicketInformationData> ticketInformationData)
UpdateTicketInformationResult	updateTicketInformation(TicketInformationData ticketInformationData)

Methods inherited from class com.secutix.plugin.v1_0.AbstractStxPlugin

clearLogSuffix, findAllFunctions, getCurrentHttpClientHelper, getCurrentXmlRpcClientHelper, getDummyHttpClientHelper, getDummyXmlRpcClientHelper, getExecutorServiceProvider, getHttpClientHelper, getInterfaceNamesByLanguageCode, getInterfaceParametersProvider, getInterfaceType, getInternationalizedLogger, getJaxRpcSoapProxyHelper, getJaxwsSoapProxyHelper, getLogger, getMappingReader, getRemoteFileAccessor, getTranslatedMessage, getUniqueValuesHelper, getXmlRpcClientHelper, initLogSuffix, isDemoPlugin, listParameterDefinitions, listParameterDefinitions, logDownloadableData, logForOperator, setDummyHttpClientHelper, setDummyXmlRpcClientHelper, setExecutorServiceProvider, setHttpClientHelper, setInterfaceParametersProvider, setInternationalizedLogger, setJaxRpcSoapProxyHelper, setJaxwsSoapProxyHelper, setLogger, setMappingReader, setRemoteFileAccessor, setUniqueValuesHelper, setXmlRpcClientHelper, validate, validateStringWithTranslations

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTINGENT_CODE

public static String DEFAULT_CONTINGENT_CODE

Constructor Detail

ExternalManagerPlugin

public ExternalManagerPlugin()

Method Detail

executeJustBeforeClosingOrder

public ClosingOrderResult executeJustBeforeClosingOrder(OrderData orderData)

readCatalog

public PluginCallResult readCatalog()

availabilityForProduct

public AvailabilityResult availabilityForProduct(String productMapping,
                                                 Date performanceDate,
                                                 String performanceMapping,
                                                 List<String> itemOrCategoryMappings,
                                                 List<String> contingentMappings,
                                                 List<String> areaMappings,
                                                 List<String> blockMappings)

Method called by S-360 to get the availability for a given product

Parameters:

productMapping - : mandatory. The id of the product

performanceDate - : optional. The date of the performance, if relevant.

performanceMapping - : optional. The id of the performance.

itemOrCategoryMappings - : if empty, return all availabilities. If provided, filter the result by category or item mapping.

contingentMappings - :Optional. If not empty, filter the result according to the contingent, if the concept is relevant. Else, return everything.

areaMappings - : Optional. If not empty, filter the result according to areas. If empty, return availabilities for all areas.

blockMappings - TODO : Optional. If not empty, filter the result according to blocks. If empty, return availabilities for all blocks.

Returns:

availabilities

selectSeatsInPerformance

public SeatSelectionResult selectSeatsInPerformance(String productMapping,
                                                    Date performanceDate,
                                                    String performanceMapping,
                                                    String categoryMapping,
                                                    String contingentMapping,
                                                    List<String> areaMappings,
                                                    List<String> blockMappings,
                                                    boolean selectionForcedInAreas,
                                                    Map<String,Integer> quantityPerTariffMapping,
                                                    int quantity,
                                                    Long orderId,
                                                    String sessionId)

Called by S-360 to ask the external system to assign seats for a performance according to the preferences passed in the parameters.

Parameters:

productMapping - : mandatory. product concerned.

performanceDate - : mandatory. Date of the performance.

performanceMapping - : mandatory. Id of the performance.

categoryMapping - : mandatory. Id of the seat category.

contingentMapping - : mandatory. Id of the contingent. May be ignored if the concept does not exist in plugin.

areaMappings - : optional. Select seats in the related area.

blockMappings - : optional. Select seats in the related block.

selectionForcedInAreas - TODO

quantityPerTariffMapping - TODO

quantity - : mandatory. Number of seats expected. Strictly superior to zero.

orderId - : mandatory. S-360 order reference.

sessionId - identifies one seat selection.

Returns:

result of the seat selection

selectSeatsInPerformanceFromQuery

public SeatSelectionResult selectSeatsInPerformanceFromQuery(SeatSelectionQuery query)

cancelSeatSelection

public SeatSelectionResult cancelSeatSelection(SeatSelectionQuery query,
                                               List<SeatSelectionData> seatSelectionData)

updateTicketInformation

public UpdateTicketInformationResult updateTicketInformation(TicketInformationData ticketInformationData)

generateTicket

public GeneratingTicketResult generateTicket(TicketInformationData ticketInformationData,
                                             boolean doProceedToGeneration,
                                             PrinterData printerData)

associateTicketToRfid

public PluginCallResult associateTicketToRfid(String rfidCode,
                                              String ticketAdditionnalInfo,
                                              TicketInformationData ticketInformationData)

associateTicketToRfidAndUpdateContact

public AssociateTicketToRfidResult associateTicketToRfidAndUpdateContact(String rfidCode,
                                                                         String ticketAdditionnalInfo,
                                                                         TicketInformationData ticketInformationData)

resynchronizeOrders

public ResynchronizationOrderPluginResult resynchronizeOrders(List<OrderData> orders,
                                                              ExternalManagerPlugin.ResynchronisationCauseEnum cause,
                                                              String remark)

synchronizeTickets

public SynchronizationTicketResult synchronizeTickets(List<TicketInformationData> ticketInformationData)

getCatalogReader

public CatalogReader getCatalogReader()

setCatalogReader

public void setCatalogReader(CatalogReader catalogReader)

setTicketReader

public void setTicketReader(TicketReader ticketReader)

getTicketReader

public TicketReader getTicketReader()

getTicketUpdater

public TicketUpdater getTicketUpdater()

setTicketUpdater

public void setTicketUpdater(TicketUpdater ticketUpdater)

getOrderReader

public OrderReader getOrderReader()

setOrderReader

public void setOrderReader(OrderReader orderReader)

getOrganizationReader

public OrganizationReader getOrganizationReader()

setOrganizationReader

public void setOrganizationReader(OrganizationReader organizationReader)

getExternalReferencesAccessor

public ExternalReferencesAccessor getExternalReferencesAccessor()

setExternalReferencesAccessor

public void setExternalReferencesAccessor(ExternalReferencesAccessor externalReferencesAccessor)

checkSeatAttribution

public final List<String> checkSeatAttribution(SeatSelectionResult res)

seatsAvailability

public SeatAvailabilityResult seatsAvailability(String productMapping,
                                                Date performanceDate,
                                                String performanceMapping,
                                                List<String> itemOrCategoryMappings,
                                                List<String> contingentMappings,
                                                List<String> areaMappings,
                                                List<String> blockMappings,
                                                Date lastModified,
                                                List<SeatData> availabilityAmongThoseSeats)

handlesReservations

public boolean handlesReservations()

If returning false, then reservation information will never be transmitted to the plugin.

Returns:

status

getEntityGranularity

public EnumSet<ExternalManagerPlugin.EntityGranularity> getEntityGranularity()

Method called by S-360 to know what information is required by the plugin. Information from operation and movement is always required, the other entity are optional (see ExternalManagerPlugin.EntityGranularity).

Returns:

as list of ExternalManagerPlugin.EntityGranularity

requiredToApplyAllProducts

public Boolean requiredToApplyAllProducts()

Method called by Secutix to know if this plugin required to apply for all products.

Returns:

required to apply all products or not.