com.exalead.papi.framework.connectors

Class ConnectorState

java.lang.Object

com.exalead.papi.framework.connectors.ConnectorState

public abstract class ConnectorState
extends java.lang.Object

State of a connector, with state transition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectorState.Builder
static class	ConnectorState.ScanStatus

Field Summary

Fields

Modifier and Type	Field and Description
ConnectorState.ScanStatus	currentScan Detailed status for current scan (if a scan is currently running)
protected java.lang.Throwable	exceptionForStatus If relevant, exception that lead to the connector being in this status
java.util.List<java.lang.String>	loggingContext Internal, framework usage only
ConnectorState.ScanStatus	previousScan Detailed status for previous scan (if a scan has ever been performed)
protected java.lang.String	reasonForStatus Global message indicating reason of last status change.
long	scanCounter Counter indicating how many times we tried to run the scan.
protected ConnectorStatus	status

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectorState() Default constructor.
protected	ConnectorState(ConnectorStatus status) Constructor.

Method Summary

Modifier and Type	Method and Description
static ConnectorState.Builder	builder()
void	clearSpecificMeasure() Remove all custom metrics.
java.lang.Throwable	getExceptionForStatus()
java.lang.String	getReasonForStatus()
long	getScanCounter()
ConnectorStatus	getStatus() Get the status
abstract void	incDeleted() Increment the counter representing the number of documents deleted by the connector.
abstract void	incDeleted(long increment) Add a specific amount to the counter representing the number of documents deleted by the connector.
abstract void	incPushed() Increment the number of documents pushed by the scan in progress.
abstract void	incPushed(long increment) Add a specific amount of documents pushed by the scan in progress.
void	incScanCounter()
void	incScanned() Increment the counter representing the number of objects retrieved from the source.
void	incScanned(long increment) Add a specific amount to the counter representing the number of objets retrieved from the source.
boolean	isStatus(ConnectorStatus status) Test current status
void	popLoggingContext()
void	pushLoggingContext() Push the logging context for the connector.
void	removeSpecificMeasure(java.lang.String name) Remove a custom metric
void	resetScanCounter()
void	setSpecificMeasure(java.lang.String name, java.lang.Number value) Set a custom metric, retrievable by the MAMI operation connector#GetConnectorsStatus
void	setStatus(ConnectorStatus status)
void	setStatus(ConnectorStatus status, java.lang.String reason)
void	setStatus(ConnectorStatus status, java.lang.String reason, java.lang.Throwable t) Set the status
void	startScan() Reset internal counters.
void	stopScan()
java.lang.String	toString() Convert the current state to a string.
static java.lang.String	toString(ConnectorStatus status) Convert the 'status' to a string.
void	waitStatus(ConnectorStatus expected) BLock the current thread until the connector scan status is the one specified in parameter.
void	waitStatusChange() Deprecated.
void	waitStatusChange(ConnectorStatus curStatus) Block the current thread until the connector scan status changes.
boolean	waitStatusChange(ConnectorStatus curStatus, long timeoutMs) Block the current thread until the connector scan status changes.

Methods inherited from class java.lang.Object

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

Field Detail

status

protected ConnectorStatus status

reasonForStatus

protected java.lang.String reasonForStatus

Global message indicating reason of last status change. This should not be an applicative message like "scanned 12 folders", but a global thing like "aborted by user", "previous scan finished"

exceptionForStatus

protected java.lang.Throwable exceptionForStatus

If relevant, exception that lead to the connector being in this status

previousScan

public ConnectorState.ScanStatus previousScan

Detailed status for previous scan (if a scan has ever been performed)

currentScan

public ConnectorState.ScanStatus currentScan

Detailed status for current scan (if a scan is currently running)

scanCounter

public long scanCounter

Counter indicating how many times we tried to run the scan. If the indexing server crashes during a scan, the scan will be automatically retried and this counter will be incremented.

loggingContext

public java.util.List<java.lang.String> loggingContext

Internal, framework usage only

Constructor Detail

ConnectorState

protected ConnectorState(ConnectorStatus status)

Constructor.

ConnectorState

protected ConnectorState()

Default constructor.

Method Detail

builder

public static ConnectorState.Builder builder()

getStatus

public ConnectorStatus getStatus()

Get the status

isStatus

public boolean isStatus(ConnectorStatus status)

Test current status

Parameters:

status - A status

Returns:

true if the connector scan status is the one specified in parameter, false otherwise.

waitStatusChange

public void waitStatusChange(ConnectorStatus curStatus)

Block the current thread until the connector scan status changes.

Parameters:

curStatus - The status to be monitored.

waitStatusChange

@Deprecated
public void waitStatusChange()

Deprecated.

Block the current thread until the connector scan status changes. This call is prone to race conditions: do not use it.

waitStatusChange

public boolean waitStatusChange(ConnectorStatus curStatus,
                                long timeoutMs)

Block the current thread until the connector scan status changes. Returns true is the status has changed before the given timeout value.

Parameters:

curStatus - The status to be monitored.

timeoutMs - The timeout value, in milliseconds.

waitStatus

public void waitStatus(ConnectorStatus expected)

BLock the current thread until the connector scan status is the one specified in parameter.

Parameters:

expected - The expected connector scan status.

getReasonForStatus

public java.lang.String getReasonForStatus()

Returns:

The reason that explain why the previous scan status changed.

getExceptionForStatus

public java.lang.Throwable getExceptionForStatus()

Returns:

provides the Exception that lead to this scan status if any, null otherwise

pushLoggingContext

public void pushLoggingContext()

Push the logging context for the connector. This method should be called each time you start a thread

popLoggingContext

public void popLoggingContext()

startScan

public void startScan()

Reset internal counters. Internal member methods, not meant to be called directly.

incPushed

public abstract void incPushed()

Increment the number of documents pushed by the scan in progress. These counters are used by:

• Administration Console: to display connector informations
• Monitoring Console: to build useful chart of connector's activity
• Provided in the MAMI operation connect#GetConnectorsStatus

Is now done by the connector server if the counting PAPi is not disabled. Else this method has become a non-operation. The data modified by this method is ignored.

incPushed

public abstract void incPushed(long increment)

Add a specific amount of documents pushed by the scan in progress. These counters are used by:

• Administration Console: to display connector informations
• Monitoring Console: to build useful chart of connector's activity
• Provided in the MAMI operation connect#GetConnectorsStatus

Parameters:

increment - Is now done by the connector server if the counting PAPi is not disabled. Else this method has become a non-operation. The data modified by this method is ignored.

incDeleted

public abstract void incDeleted()

Increment the counter representing the number of documents deleted by the connector. Is now done by the connector server if the counting PAPi is not disabled. Else this method has become a non-operation. The data modified by this method is ignored.

incDeleted

public abstract void incDeleted(long increment)

Add a specific amount to the counter representing the number of documents deleted by the connector.

Parameters:

increment - Is now done by the connector server if the counting PAPi is not disabled. Else this method has become a non-operation. The data modified by this method is ignored.

incScanned

public void incScanned()

Increment the counter representing the number of objects retrieved from the source.

incScanned

public void incScanned(long increment)

Add a specific amount to the counter representing the number of objets retrieved from the source.

Parameters:

increment -

setSpecificMeasure

public void setSpecificMeasure(java.lang.String name,
                               java.lang.Number value)

Set a custom metric, retrievable by the MAMI operation connector#GetConnectorsStatus

Parameters:

name - Label of the metric

value - its value This can be used to build custom chart in the Monitoring Console for instance.

removeSpecificMeasure

public void removeSpecificMeasure(java.lang.String name)

Remove a custom metric

Parameters:

name - Label of the metric to remove.

clearSpecificMeasure

public void clearSpecificMeasure()

Remove all custom metrics. Custom metrics are not cleared when a new scan starts. They belong to the connector using them. You can use this method to clear previous metrics at the beginning of the @{link Connector.scan(com.exalead.papi.helper.PushAPI, String, Object) member method.

stopScan

public void stopScan()

setStatus

public void setStatus(ConnectorStatus status)

setStatus

public void setStatus(ConnectorStatus status,
                      java.lang.String reason)

resetScanCounter

public void resetScanCounter()

getScanCounter

public long getScanCounter()

incScanCounter

public void incScanCounter()

setStatus

public void setStatus(ConnectorStatus status,
                      java.lang.String reason,
                      java.lang.Throwable t)
               throws java.lang.IllegalStateException

Set the status

Throws:

java.lang.IllegalStateException - if the transition state is invalid

toString

public java.lang.String toString()

Convert the current state to a string.

Overrides:

toString in class java.lang.Object

toString

public static java.lang.String toString(ConnectorStatus status)

Convert the 'status' to a string.