Package com.attivio.sdk.admin

Class Shutdown

java.lang.Object

com.attivio.sdk.esb.AbstractPlatformMessage

com.attivio.sdk.admin.AdminMessage

com.attivio.sdk.admin.Shutdown

All Implemented Interfaces:

PlatformMessage, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ShutdownImmediately

public class Shutdown
extends AdminMessage

Sent to tell the AdminService to shutdown this instance of Attivio. The default shutdown mode specified will be used. If safe default shutdown is set, then shutdown will be done as safely as possible. A safe shutdown will try to do the following before stopping Attivio:

1. Stop all new messages from being accepted into the Attivio instance. This means clients sending new PlatformMessages will get errors. 2. Stop all Connectors that are currently running (ex: FileConnector). 3. Wait until all existing documents have been processed by the system. 4. Stop the Attivio instance.

See the ShutdownImmediately message for a more immediate shutdown.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors

Constructor	Description
Shutdown()	The default constructor
Shutdown(long delayUntilShutdown)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
long	getDelay()
int	hashCode()
void	setDelay(long delay)
java.lang.String	toString()

Methods inherited from class com.attivio.sdk.admin.AdminMessage

getMessageId, setMessageId

Methods inherited from class com.attivio.sdk.esb.AbstractPlatformMessage

addMessageHistory, addMessageHistory, clone, getClientId, getEstimatedSize, getMessageHistory, getMetadata, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getWorkflowQueue, getWorkflowQueue, hasProperty, isRedelivered, removeProperty, removeWorkflowQueue, setClientId, setProperty, setRedelivered, setWorkflowQueue, setWorkflowQueue, toMessageString, toString, toString, toString, toString, toString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Shutdown

public Shutdown()

The default constructor

Shutdown

public Shutdown(long delayUntilShutdown)

Constructor

Parameters:

delayUntilShutdown - the delay until shutdown

Method Detail

getDelay

public long getDelay()

setDelay

public void setDelay(long delay)

hashCode

public int hashCode()

Overrides:

hashCode in class AdminMessage

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class AdminMessage

toString

public java.lang.String toString()

Overrides:

toString in class AbstractPlatformMessage