org.apache.sling.discovery.oak.pinger

Class OakViewChecker

java.lang.Object

org.apache.sling.discovery.base.commons.BaseViewChecker

org.apache.sling.discovery.oak.pinger.OakViewChecker

All Implemented Interfaces:

Runnable, ViewChecker

@Service(value=OakViewChecker.class)
 @Reference(referenceInterface=org.osgi.service.http.HttpService.class,
           cardinality=OPTIONAL_MULTIPLE,
           policy=DYNAMIC)
public class OakViewChecker
extends BaseViewChecker

The OakViewChecker is taking care of checking the oak discovery-lite descriptor when checking the local cluster view and passing that on to the ViewStateManager which will then detect whether there was any change or not. Unlike discovery.impl's HeartbeatHandler this one does not store any heartbeats in the repository anymore.

Remote heartbeats are POSTs to remote TopologyConnectorServlets using discovery.base

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnouncementRegistry	announcementRegistry
protected ConnectorRegistry	connectorRegistry
protected PeriodicBackgroundJob	periodicCheckViewJob
protected ResourceResolverFactory	resourceResolverFactory
protected Scheduler	scheduler
protected SlingSettingsService	slingSettingsService

Fields inherited from class org.apache.sling.discovery.base.commons.BaseViewChecker

activated, context, endpoints, lock, logger, NAME, periodicPingJob, PROPERTY_ID_ENDPOINTS, PROPERTY_ID_RUNTIME, PROPERTY_ID_SLING_HOME_PATH, runtimeId, slingId

Constructor Summary

Constructors

Constructor and Description
OakViewChecker()

Method Summary

Modifier and Type	Method and Description
protected void	deactivate()
protected void	doActivate()
protected void	doCheckView() Check whether the established view matches the reality, ie matches the heartbeats
protected AnnouncementRegistry	getAnnouncementRegistry()
protected BaseConfig	getConnectorConfig()
protected ConnectorRegistry	getConnectorRegistry()
protected ResourceResolverFactory	getResourceResolverFactory()
protected Scheduler	getScheduler()
protected SlingSettingsService	getSlingSettingsService()
void	initialize(OakDiscoveryService discoveryService) The initialize method is called by the OakDiscoveryService.activate as we require the discoveryService (and the discoveryService has a reference on us - but we cant have circular references in osgi).
boolean	resetLeaderElectionId() Hook that will cause a reset of the leaderElectionId on next invocation of issueClusterLocalHeartbeat.
static OakViewChecker	testConstructor(SlingSettingsService slingSettingsService, ResourceResolverFactory resourceResolverFactory, ConnectorRegistry connectorRegistry, AnnouncementRegistry announcementRegistry, Scheduler scheduler, Config config) for testing only
protected void	updateProperties()

Methods inherited from class org.apache.sling.discovery.base.commons.BaseViewChecker

activate, bindHttpService, checkView, getEndpointsAsString, heartbeatAndCheckView, issueConnectorPings, issueHeartbeat, run, triggerAsyncConnectorPing, unbindHttpService

Methods inherited from class java.lang.Object

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

Field Detail

slingSettingsService

@Reference
protected SlingSettingsService slingSettingsService

resourceResolverFactory

@Reference
protected ResourceResolverFactory resourceResolverFactory

connectorRegistry

@Reference
protected ConnectorRegistry connectorRegistry

announcementRegistry

@Reference
protected AnnouncementRegistry announcementRegistry

scheduler

@Reference
protected Scheduler scheduler

periodicCheckViewJob

protected PeriodicBackgroundJob periodicCheckViewJob

Constructor Detail

OakViewChecker

public OakViewChecker()

Method Detail

testConstructor

public static OakViewChecker testConstructor(SlingSettingsService slingSettingsService,
                                             ResourceResolverFactory resourceResolverFactory,
                                             ConnectorRegistry connectorRegistry,
                                             AnnouncementRegistry announcementRegistry,
                                             Scheduler scheduler,
                                             Config config)

for testing only

getAnnouncementRegistry

protected AnnouncementRegistry getAnnouncementRegistry()

Specified by:

getAnnouncementRegistry in class BaseViewChecker

getConnectorConfig

protected BaseConfig getConnectorConfig()

Specified by:

getConnectorConfig in class BaseViewChecker

getConnectorRegistry

protected ConnectorRegistry getConnectorRegistry()

Specified by:

getConnectorRegistry in class BaseViewChecker

getResourceResolverFactory

protected ResourceResolverFactory getResourceResolverFactory()

Specified by:

getResourceResolverFactory in class BaseViewChecker

getScheduler

protected Scheduler getScheduler()

Specified by:

getScheduler in class BaseViewChecker

getSlingSettingsService

protected SlingSettingsService getSlingSettingsService()

Specified by:

getSlingSettingsService in class BaseViewChecker

doActivate

protected void doActivate()

Overrides:

doActivate in class BaseViewChecker

deactivate

protected void deactivate()

Overrides:

deactivate in class BaseViewChecker

initialize

public void initialize(OakDiscoveryService discoveryService)

The initialize method is called by the OakDiscoveryService.activate as we require the discoveryService (and the discoveryService has a reference on us - but we cant have circular references in osgi).

resetLeaderElectionId

public boolean resetLeaderElectionId()

Hook that will cause a reset of the leaderElectionId on next invocation of issueClusterLocalHeartbeat.

Returns:

true if the leaderElectionId was reset - false if that was not necessary as that happened earlier already and it has not propagated yet to the ./clusterInstances in the meantime

doCheckView

protected void doCheckView()

Description copied from class: BaseViewChecker

Check whether the established view matches the reality, ie matches the heartbeats

Overrides:

doCheckView in class BaseViewChecker

updateProperties

protected void updateProperties()

Specified by:

updateProperties in class BaseViewChecker