com.Sericon.ProductAgents.AutoSSLAgent
Class StatusCheck

java.lang.Object
  com.Sericon.ProductAgents.AutoSSLAgent.StatusCheck

public abstract class StatusCheck
extends java.lang.Object

Provides feedback to the user about the status of the AutoSSL process. This abstract class should be subclassed by the developers of the enclosing application. During the AutoSSL process, its methods will be called to update the status which may be displayed to the user by whatever means is available (e.g. GUI, console, LCD display, etc.).

Field Summary

static int	STATUS_CERTIFICATE_CREATED
static int	STATUS_CERTIFICATE_SIGNED
static int	STATUS_CHECKING_DDNS
static int	STATUS_CREATING_CERTIFICATE
static int	STATUS_ERROR_OCCURRED
static int	STATUS_HOSTNAME_RESERVED
static int	STATUS_PROCESS_BEGIN
static int	STATUS_PROCESS_COMPLETE
static int	STATUS_PRODUCT_REGISTERED
static int	STATUS_REGISTERING_PRODUCT
static int	STATUS_RESERVING_HOSTNAME
static int	STATUS_SIGNING_CERTIFICATE
static int	STATUS_TEMP_CERTIFICATE_SIGNED
static int	STATUS_UPDATING_DDNS

Constructor Summary

StatusCheck()

Method Summary

java.lang.String	elapsedTime() This method shows how much time that has elapsed since the start of the provisioning process.
boolean	isUserAbort() Query whether or not the user aborted this process.
abstract void	showInstallProblem(java.lang.String message) Display a message to the user concerning a problem that has occurred during the provisioning of the SSL certificate.
abstract void	showInstallStatus(int step, java.lang.String message) Display a message to the user updating him on the status during the provisioning of the SSL certificate.
void	userAbort() Notify the AutoSSL Agent that the user has requested that processing be aborted.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_ERROR_OCCURRED

public static final int STATUS_ERROR_OCCURRED

See Also:

Constant Field Values

STATUS_PROCESS_BEGIN

public static final int STATUS_PROCESS_BEGIN

See Also:

Constant Field Values

STATUS_RESERVING_HOSTNAME

public static final int STATUS_RESERVING_HOSTNAME

See Also:

Constant Field Values

STATUS_HOSTNAME_RESERVED

public static final int STATUS_HOSTNAME_RESERVED

See Also:

Constant Field Values

STATUS_REGISTERING_PRODUCT

public static final int STATUS_REGISTERING_PRODUCT

See Also:

Constant Field Values

STATUS_PRODUCT_REGISTERED

public static final int STATUS_PRODUCT_REGISTERED

See Also:

Constant Field Values

STATUS_CREATING_CERTIFICATE

public static final int STATUS_CREATING_CERTIFICATE

See Also:

Constant Field Values

STATUS_CERTIFICATE_CREATED

public static final int STATUS_CERTIFICATE_CREATED

See Also:

Constant Field Values

STATUS_SIGNING_CERTIFICATE

public static final int STATUS_SIGNING_CERTIFICATE

See Also:

Constant Field Values

STATUS_CERTIFICATE_SIGNED

public static final int STATUS_CERTIFICATE_SIGNED

See Also:

Constant Field Values

STATUS_TEMP_CERTIFICATE_SIGNED

public static final int STATUS_TEMP_CERTIFICATE_SIGNED

See Also:

Constant Field Values

STATUS_PROCESS_COMPLETE

public static final int STATUS_PROCESS_COMPLETE

See Also:

Constant Field Values

STATUS_CHECKING_DDNS

public static final int STATUS_CHECKING_DDNS

See Also:

Constant Field Values

STATUS_UPDATING_DDNS

public static final int STATUS_UPDATING_DDNS

See Also:

Constant Field Values

Constructor Detail

StatusCheck

public StatusCheck()

Method Detail

showInstallProblem

public abstract void showInstallProblem(java.lang.String message)

Display a message to the user concerning a problem that has occurred during the provisioning of the SSL certificate.

This can be accomplished by writing information to the console, GUI, LCD, or other means of displaying information to the user. Note that it is understood that in many cases the application will find it difficult to display information to the user, and so this method will only be called as a last resort.

Parameters:

message - The message to display to the user that summerizes the problem

showInstallStatus

public abstract void showInstallStatus(int step,
                                       java.lang.String message)

Display a message to the user updating him on the status during the provisioning of the SSL certificate. Note: The message used here is in English. If a different language is to be used, then the message displayed to the user should be based on the step number.

This can be accomplished by writing information to the console, GUI, LCD, or other means of displaying information to the user. Note that it is understood that in many cases the application will find it difficult to display information to the user, but it should still make every attempt to inform him of the status to reassure him that the process is working.

Parameters:

step - The step in the process that has been completed. Note: This number corresponds to the STATUS_ constants defined in this class.

message - The message to display to the user that summerizes the current status

userAbort

public void userAbort()

Notify the AutoSSL Agent that the user has requested that processing be aborted. This method may be called by the application. Note: This method will not attempt to abort any processing that happens on the AutoSSL Server on behalf of this AutoSSL Agent. It will simply stop any additional requests made to the AutoSSL Server.

isUserAbort

public boolean isUserAbort()

Query whether or not the user aborted this process.

elapsedTime

public java.lang.String elapsedTime()

This method shows how much time that has elapsed since the start of the provisioning process.

Returns:

Time elapsed as a string in timer format