Package org.bedework.synch.shared.cnctrs

Class AbstractConnectorInstance<CnctrT extends AbstractConnector,InfoT extends BaseSubscriptionInfo,ConfigT extends ConnectorConfigI>

java.lang.Object

org.bedework.synch.shared.cnctrs.AbstractConnectorInstance<CnctrT,InfoT,ConfigT>

All Implemented Interfaces:

ConnectorInstance<InfoT>, org.bedework.util.logging.Logged

Direct Known Subclasses:

BaseConnectorInstance

public abstract class AbstractConnectorInstance<CnctrT extends AbstractConnector,InfoT extends BaseSubscriptionInfo,ConfigT extends ConnectorConfigI>
extends Object
implements org.bedework.util.logging.Logged, ConnectorInstance<InfoT>

Abstract connector instance to handle some trivia.

Author:

Mike Douglass

Nested Class Summary

Nested classes/interfaces inherited from interface org.bedework.synch.shared.cnctrs.ConnectorInstance

ConnectorInstance.ItemInfo, ConnectorInstance.SynchItemsInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected CnctrT	cnctr
protected ConfigT	config
protected org.bedework.synch.wsmessages.SynchEndType	end
protected InfoT	info
protected Subscription	sub

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConnectorInstance(Subscription sub, org.bedework.synch.wsmessages.SynchEndType end, InfoT info, CnctrT cnctr, ConfigT config)

Method Summary

Modifier and Type	Method	Description
protected org.apache.http.impl.client.CloseableHttpClient	getClient()
Connector	getConnector()
BaseSubscriptionInfo.CrudCts	getLastCrudCts()
org.bedework.util.logging.BwLogger	getLogger()
InfoT	getSubInfo()
BaseSubscriptionInfo.CrudCts	getTotalCrudCts()
org.oasis_open.docs.ws_calendar.ns.soap.BaseResponseType	open()	Called when a subscription is activated on synch engine startup or after creation of a new subscription.
void	setLastCrudCts(BaseSubscriptionInfo.CrudCts val)
void	setTotalCrudCts(BaseSubscriptionInfo.CrudCts val)
boolean	subscribe(org.bedework.synch.wsmessages.SubscribeResponseType sr)	Do whatever is required to set up a subscription to the end point for this connector instance.
boolean	unsubscribe(org.bedework.synch.wsmessages.UnsubscribeRequestType usreq, org.bedework.synch.wsmessages.UnsubscribeResponseType usresp)	Check to see if an unsubscribe can go ahead.
boolean	validateActiveSubInfo(org.bedework.synch.wsmessages.ActiveSubscriptionRequestType req, org.oasis_open.docs.ws_calendar.ns.soap.BaseResponseType resp, Connector cnctr, BaseSubscriptionInfo info)	Ensure active subscription info matches the subscription
protected boolean	validateSubInfo(org.bedework.synch.wsmessages.SubscribeResponseType sr, Connector cnctr, BaseSubscriptionInfo info)	Ensure subscription info is valid

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.synch.shared.cnctrs.ConnectorInstance

addItem, changed, deleteItem, fetchItem, fetchItems, getItemsInfo, updateItem

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, warn

Field Detail

sub

protected Subscription sub

end

protected org.bedework.synch.wsmessages.SynchEndType end

info

protected InfoT extends BaseSubscriptionInfo info

cnctr

protected final CnctrT extends AbstractConnector cnctr

config

protected final ConfigT extends ConnectorConfigI config

Constructor Detail

AbstractConnectorInstance

protected AbstractConnectorInstance(Subscription sub,
                                    org.bedework.synch.wsmessages.SynchEndType end,
                                    InfoT info,
                                    CnctrT cnctr,
                                    ConfigT config)

Method Detail

getConnector

public Connector getConnector()

Specified by:

getConnector in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

the connector for this instance

getSubInfo

public InfoT getSubInfo()

Specified by:

getSubInfo in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

the info for the subscription this instance is handling.

open

public org.oasis_open.docs.ws_calendar.ns.soap.BaseResponseType open()
                                                              throws SynchException

Description copied from interface: ConnectorInstance

Called when a subscription is activated on synch engine startup or after creation of a new subscription.

Specified by:

open in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

status + messages

Throws:

SynchException

subscribe

public boolean subscribe(org.bedework.synch.wsmessages.SubscribeResponseType sr)
                  throws SynchException

Description copied from interface: ConnectorInstance

Do whatever is required to set up a subscription to the end point for this connector instance. This is a one time call when a new subscription is created and allows the connector instance to validate the information.

This method should set the appropriate status if an error occurs.

the open method handles any dynamic creation of a connection to the subscribed-to service.

Specified by:

subscribe in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

false if the subscription fails - status has been set in response

Throws:

SynchException

unsubscribe

public boolean unsubscribe(org.bedework.synch.wsmessages.UnsubscribeRequestType usreq,
                           org.bedework.synch.wsmessages.UnsubscribeResponseType usresp)
                    throws SynchException

Description copied from interface: ConnectorInstance

Check to see if an unsubscribe can go ahead. This method should ensure that the important properties in the request match those set in the subscription, e.g. paths

This method should set the appropriate status and return false if an error occurs.

Specified by:

unsubscribe in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

false if the unsubscribe fails - status has been set in response

Throws:

SynchException

validateActiveSubInfo

public boolean validateActiveSubInfo(org.bedework.synch.wsmessages.ActiveSubscriptionRequestType req,
                                     org.oasis_open.docs.ws_calendar.ns.soap.BaseResponseType resp,
                                     Connector cnctr,
                                     BaseSubscriptionInfo info)
                              throws SynchException

Description copied from interface: ConnectorInstance

Ensure active subscription info matches the subscription

Specified by:

validateActiveSubInfo in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

true if all ok

Throws:

SynchException

setLastCrudCts

public void setLastCrudCts(BaseSubscriptionInfo.CrudCts val)
                    throws SynchException

Specified by:

setLastCrudCts in interface ConnectorInstance<CnctrT extends AbstractConnector>

Parameters:

val -

Throws:

SynchException

getLastCrudCts

public BaseSubscriptionInfo.CrudCts getLastCrudCts()
                                            throws SynchException

Specified by:

getLastCrudCts in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

cts

Throws:

SynchException

setTotalCrudCts

public void setTotalCrudCts(BaseSubscriptionInfo.CrudCts val)
                     throws SynchException

Specified by:

setTotalCrudCts in interface ConnectorInstance<CnctrT extends AbstractConnector>

Parameters:

val -

Throws:

SynchException

getTotalCrudCts

public BaseSubscriptionInfo.CrudCts getTotalCrudCts()
                                             throws SynchException

Specified by:

getTotalCrudCts in interface ConnectorInstance<CnctrT extends AbstractConnector>

Returns:

cts

Throws:

SynchException

validateSubInfo

protected boolean validateSubInfo(org.bedework.synch.wsmessages.SubscribeResponseType sr,
                                  Connector cnctr,
                                  BaseSubscriptionInfo info)
                           throws SynchException

Ensure subscription info is valid

Parameters:

sr -

cnctr -

info -

Returns:

true if all ok

Throws:

SynchException

getClient

protected org.apache.http.impl.client.CloseableHttpClient getClient()
                                                             throws SynchException

Throws:

SynchException

getLogger

public org.bedework.util.logging.BwLogger getLogger()

Specified by:

getLogger in interface org.bedework.util.logging.Logged