org.bedework.synch.shared.cnctrs

Class AbstractConnector<T,TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI,InfoT extends BaseSubscriptionInfo>

java.lang.Object

org.bedework.util.misc.Logged

org.bedework.synch.shared.cnctrs.AbstractConnector<T,TI,TN,Tconf,InfoT>

Type Parameters:

T - Connector subclass

TI - Connector instance subclass

TN - Notification subclass

Tconf - Configuration class

All Implemented Interfaces:

Connector<TI,TN,Tconf>

public abstract class AbstractConnector<T,TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI,InfoT extends BaseSubscriptionInfo>
extends org.bedework.util.misc.Logged
implements Connector<TI,TN,Tconf>

A special connector to handle calls to the synch engine via the web context.

This is the way to call the system to add subscriptions, to unsubscribe etc.

Author:

Mike Douglass

Nested Class Summary

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

Connector.NotificationBatch<N extends Notification>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	callbackUri
protected Tconf	config
protected boolean	failed
protected JAXBContext	jc
protected org.bedework.synch.wsmessages.ObjectFactory	of
protected PropertiesInfo	propInfo
protected boolean	running
protected MessageFactory	soapMsgFactory
protected boolean	stopped
protected SynchEngine	syncher

Fields inherited from class org.bedework.util.misc.Logged

auditLoggerName, debug, errorLoggerName, metricsLoggerName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnector(PropertiesInfo propInfo)

Method Summary

Modifier and Type	Method and Description
String	getCallbackUri()
String	getConnectorId()
TI	getConnectorInstance(Subscription sub, org.bedework.synch.wsmessages.SynchEndType end) Called to obtain a connector instance for a subscription.
ietf.params.xml.ns.icalendar_2.ObjectFactory	getIcalObjectFactory()
String	getId()
protected org.bedework.synch.wsmessages.SynchRemoteServicePortType	getPort(String uri)
PropertiesInfo	getPropertyInfo() Information about properties required for subscriptions via this connector.
List<Object>	getSkipList()
protected MessageFactory	getSoapMsgFactory()
String	getStatus()
SynchEngine	getSyncher()
boolean	getTrustLastmod() Can we trust the lastmod from this connector?
Connector.NotificationBatch<TN>	handleCallback(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, List<String> resourceUri) Will create a notification batch object which will be passed to a synchling for processing.
boolean	isFailed()
boolean	isManager()
boolean	isReadOnly() Is this a read-only connector?
boolean	isStarted()
boolean	isStopped()
abstract TI	makeInstance(Subscription sub, org.bedework.synch.wsmessages.SynchEndType end)
protected void	marshal(Object o, OutputStream out)
void	respondCallback(javax.servlet.http.HttpServletResponse resp, Connector.NotificationBatch<TN> notifications) Will respond to a notification.
void	start(String connectorId, Tconf conf, String callbackUri, SynchEngine syncher) Start the connector.
void	stop() Shut down the connector
protected Object	unmarshalBody(javax.servlet.http.HttpServletRequest req)

Methods inherited from class org.bedework.util.misc.Logged

audit, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, getAuditLoggerIfEnabled, getErrorLoggerIfEnabled, getLogger, getLogger, getMetricsLoggerIfEnabled, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsLoggerEnabled, metrics, warn

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.Connector

getKind

Field Detail

config

protected Tconf extends ConnectorConfigI config

callbackUri

protected String callbackUri

syncher

protected SynchEngine syncher

running

protected boolean running

stopped

protected boolean stopped

failed

protected boolean failed

of

protected org.bedework.synch.wsmessages.ObjectFactory of

soapMsgFactory

protected MessageFactory soapMsgFactory

jc

protected JAXBContext jc

propInfo

protected PropertiesInfo propInfo

Constructor Detail

AbstractConnector

protected AbstractConnector(PropertiesInfo propInfo)

Method Detail

getConnectorId

public String getConnectorId()

Returns:

the connector id

start

public void start(String connectorId,
                  Tconf conf,
                  String callbackUri,
                  SynchEngine syncher)

Description copied from interface: Connector

Start the connector. A response of null means no synch available.

The callback url is unique to the connector. It will be used as a path prefix to allow the callback service to locate the handler for incoming callback requests.

For example, if the callback context is /synchcb/ and the connector id is "bedework" then the callback uri might be /synchcb/bedework/. The connector might append a uid to that path to allow it to locate the active subscription for which the callback is intended.

Specified by:

start in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Parameters:

connectorId - - registered id for the connector

getStatus

public String getStatus()

Specified by:

getStatus in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

a useful status message

isStarted

public boolean isStarted()

Specified by:

isStarted in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

true if we started

isFailed

public boolean isFailed()

Specified by:

isFailed in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

true if we failed in some way

isStopped

public boolean isStopped()

Specified by:

isStopped in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

true if we're stopped

isManager

public boolean isManager()

Specified by:

isManager in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

true if we are the manager

isReadOnly

public boolean isReadOnly()

Description copied from interface: Connector

Is this a read-only connector?

Specified by:

isReadOnly in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

boolean

getTrustLastmod

public boolean getTrustLastmod()

Description copied from interface: Connector

Can we trust the lastmod from this connector?

Specified by:

getTrustLastmod in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

boolean

getId

public String getId()

Specified by:

getId in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

id provided at start

getCallbackUri

public String getCallbackUri()

Specified by:

getCallbackUri in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

callbackUri provided at start

getSyncher

public SynchEngine getSyncher()

Specified by:

getSyncher in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

syncher provided at start

getIcalObjectFactory

public ietf.params.xml.ns.icalendar_2.ObjectFactory getIcalObjectFactory()

Specified by:

getIcalObjectFactory in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

an object factory for icalendar

getPropertyInfo

public PropertiesInfo getPropertyInfo()

Description copied from interface: Connector

Information about properties required for subscriptions via this connector.

Specified by:

getPropertyInfo in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

list of info

getSkipList

public List<Object> getSkipList()

Specified by:

getSkipList in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Returns:

list of icalendar properties to skip.

stop

public void stop()
          throws SynchException

Description copied from interface: Connector

Shut down the connector

Specified by:

stop in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Throws:

SynchException

makeInstance

public abstract TI makeInstance(Subscription sub,
                                org.bedework.synch.wsmessages.SynchEndType end)
                         throws SynchException

Throws:

SynchException

getConnectorInstance

public TI getConnectorInstance(Subscription sub,
                               org.bedework.synch.wsmessages.SynchEndType end)
                        throws SynchException

Description copied from interface: Connector

Called to obtain a connector instance for a subscription. A response of null means no synch available.

Specified by:

getConnectorInstance in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

Parameters:

sub - - the subscription

end - - which end

Returns:

null for no synch else a connector instance.

Throws:

SynchException

handleCallback

public Connector.NotificationBatch<TN> handleCallback(javax.servlet.http.HttpServletRequest req,
                                                      javax.servlet.http.HttpServletResponse resp,
                                                      List<String> resourceUri)
                                               throws SynchException

Description copied from interface: Connector

Will create a notification batch object which will be passed to a synchling for processing. When processing is complete respond will be called.

The resource URI has been stripped of the context element and the element which identifies the connector. What remains is used by the connector to determine a subscription id allowing retrieval of the subscription from the synch engine.

Specified by:

handleCallback in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

resourceUri - - elements of the path with context and connector id removed

Returns:

Notification with 1 or more Notification items or null for no action.

Throws:

SynchException

respondCallback

public void respondCallback(javax.servlet.http.HttpServletResponse resp,
                            Connector.NotificationBatch<TN> notifications)
                     throws SynchException

Description copied from interface: Connector

Will respond to a notification.

Specified by:

respondCallback in interface Connector<TI extends AbstractConnectorInstance,TN extends Notification,Tconf extends ConnectorConfigI>

notifications - from handleCallback.

Throws:

SynchException

getPort

protected org.bedework.synch.wsmessages.SynchRemoteServicePortType getPort(String uri)
                                                                    throws SynchException

Throws:

SynchException

unmarshalBody

protected Object unmarshalBody(javax.servlet.http.HttpServletRequest req)
                        throws SynchException

Throws:

SynchException

marshal

protected void marshal(Object o,
                       OutputStream out)
                throws SynchException

Throws:

SynchException

getSoapMsgFactory

protected MessageFactory getSoapMsgFactory()
                                    throws SynchException

Throws:

SynchException