Package com.jalios.jcms.readiness

Class FileReadinessProbe

java.lang.Object

com.jalios.jcms.readiness.AbstractBasicReadinessProbe

com.jalios.jcms.readiness.FileReadinessProbe

All Implemented Interfaces:

ReadinessProbeInterface

public class FileReadinessProbe
extends AbstractBasicReadinessProbe

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	DEFAULT_ERROR_FILENAME
protected static java.lang.String	DEFAULT_READINESS_DIRECTORY
protected static java.lang.String	DEFAULT_READINESS_FILENAME
protected static java.lang.String	ERROR_FILENAME_PROP
protected static java.lang.String	READINESS_DIRECTORY_PROP
protected static java.lang.String	READINESS_FILENAME_PROP

Constructor Summary

Constructors

Constructor	Description
FileReadinessProbe()

Method Summary

Modifier and Type	Method	Description
void	removeReadinessProbe()	Remove the readiness probe (call at application init)
void	setErrorProbe(java.lang.String message)	Set the error probe when the application is not correctly started
void	setReadinessProbe()	Set the readiness probe when the application is correctly started

Methods inherited from class java.lang.Object

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

Field Detail

READINESS_DIRECTORY_PROP

protected static final java.lang.String READINESS_DIRECTORY_PROP

See Also:

Constant Field Values

READINESS_FILENAME_PROP

protected static final java.lang.String READINESS_FILENAME_PROP

See Also:

Constant Field Values

ERROR_FILENAME_PROP

protected static final java.lang.String ERROR_FILENAME_PROP

See Also:

Constant Field Values

DEFAULT_READINESS_DIRECTORY

protected static final java.lang.String DEFAULT_READINESS_DIRECTORY

See Also:

Constant Field Values

DEFAULT_READINESS_FILENAME

protected static final java.lang.String DEFAULT_READINESS_FILENAME

See Also:

Constant Field Values

DEFAULT_ERROR_FILENAME

protected static final java.lang.String DEFAULT_ERROR_FILENAME

See Also:

Constant Field Values

Constructor Detail

FileReadinessProbe

public FileReadinessProbe()

Method Detail

removeReadinessProbe

public void removeReadinessProbe()
                          throws java.lang.Exception

Description copied from interface: ReadinessProbeInterface

Remove the readiness probe (call at application init)

Specified by:

removeReadinessProbe in interface ReadinessProbeInterface

Overrides:

removeReadinessProbe in class AbstractBasicReadinessProbe

Throws:

java.lang.Exception - if the probe cannot be executed correctly

setReadinessProbe

public void setReadinessProbe()
                       throws java.lang.Exception

Description copied from interface: ReadinessProbeInterface

Set the readiness probe when the application is correctly started

Specified by:

setReadinessProbe in interface ReadinessProbeInterface

Overrides:

setReadinessProbe in class AbstractBasicReadinessProbe

Throws:

java.lang.Exception - if the probe cannot be executed correctly

setErrorProbe

public void setErrorProbe(java.lang.String message)
                   throws java.lang.Exception

Description copied from interface: ReadinessProbeInterface

Set the error probe when the application is not correctly started

Specified by:

setErrorProbe in interface ReadinessProbeInterface

Overrides:

setErrorProbe in class AbstractBasicReadinessProbe

Parameters:

message - an error message

Throws:

java.lang.Exception - if the probe cannot be executed correctly