org.apache.qpid.server.virtualhostnode

Class AbstractVirtualHostNode<X extends AbstractVirtualHostNode<X>>

java.lang.Object

org.apache.qpid.server.model.AbstractConfiguredObject<X>

org.apache.qpid.server.virtualhostnode.AbstractVirtualHostNode<X>

All Implemented Interfaces:

ConfiguredObject<X>, VirtualHostNode<X>

Direct Known Subclasses:

AbstractStandardVirtualHostNode, BDBHAVirtualHostNodeImpl

public abstract class AbstractVirtualHostNode<X extends AbstractVirtualHostNode<X>>
extends AbstractConfiguredObject<X>
implements VirtualHostNode<X>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

AbstractConfiguredObject.CallableWithArgument<V,A>, AbstractConfiguredObject.ChainedListenableFuture<V>, AbstractConfiguredObject.ChainedSettableFuture<V>, AbstractConfiguredObject.DuplicateIdException, AbstractConfiguredObject.DuplicateNameException

Field Summary

Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

SECURED_STRING_VALUE

Fields inherited from interface org.apache.qpid.server.model.VirtualHostNode

DEFAULT_INITIAL_CONFIG_VIRTUALHOST_CONFIG_VAR, DEFAULT_INITIAL_CONFIGURATION, DEFAULT_VIRTUAL_HOST_NODE, QPID_INITIAL_CONFIG_VIRTUALHOST_CONFIG_VAR, VIRTUALHOST_BLUEPRINT_CONTEXT_VAR, VIRTUALHOST_INITIAL_CONFIGURATION

Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject

CONTEXT, CREATED_BY, CREATED_TIME, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractVirtualHostNode(Broker<?> parent, Map<String,Object> attributes)

Method Summary

Modifier and Type	Method and Description
protected abstract com.google.common.util.concurrent.ListenableFuture<Void>	activate()
protected abstract DurableConfigurationStore	createConfigurationStore()
protected com.google.common.util.concurrent.ListenableFuture<Void>	deleteVirtualHostIfExists()
protected com.google.common.util.concurrent.ListenableFuture<Void>	doActivate()
protected com.google.common.util.concurrent.ListenableFuture<Void>	doDelete()
protected com.google.common.util.concurrent.ListenableFuture<Void>	doStop()
protected abstract ConfiguredObjectRecord	enrichInitialVirtualHostRootRecord(ConfiguredObjectRecord vhostRecord)
protected Broker<?>	getBroker()
TaskExecutor	getChildExecutor()
DurableConfigurationStore	getConfigurationStore()
protected MessageStoreLogSubject	getConfigurationStoreLogSubject()
protected EventLogger	getEventLogger()
protected Reader	getInitialConfigReader()
protected ConfiguredObjectRecord[]	getInitialRecords()
LifetimePolicy	getLifetimePolicy() Return the lifetime policy for the object
protected static Collection<String>	getSupportedVirtualHostTypes(boolean includeProvided)
VirtualHost<?,?,?>	getVirtualHost()
String	getVirtualHostInitialConfiguration()
boolean	isDefaultVirtualHostNode()
protected void	onClose()
protected void	onCreate()
protected void	onExceptionInOpen(RuntimeException e) Callback method to perform ConfiguredObject specific exception handling on exception in open.
void	onOpen()
protected void	postResolve()
protected com.google.common.util.concurrent.ListenableFuture<Void>	stopAndSetStateTo(State stoppedState)
protected void	validateChange(ConfiguredObject<?> proxyForValidation, Set<String> changedAttributes)
protected void	validateOnCreate()

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

addChangeListener, addChildAsync, applyToChildren, asObjectRecord, attainState, attributeSet, authoriseCreate, authoriseCreateChild, authoriseDelete, authoriseSetAttributes, beforeClose, changeAttribute, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleted, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getModel, getName, getObjectFactory, getParent, getSecurityManager, getState, getStatistics, getTaskExecutor, getType, getTypeClass, handleExceptionOnOpen, isDurable, managesChildStorage, notifyStateChanged, onResolve, onValidate, open, openAsync, parentsMap, postResolveChildren, registerWithParents, removeChangeListener, rethrowRuntimeExceptionsOnOpen, runTask, setAttribute, setAttributes, setAttributesAsync, setEncrypter, setState, start, startAsync, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.server.model.VirtualHostNode

getRemoteReplicationNodes, start, stop

Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject

addChangeListener, asObjectRecord, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getTaskExecutor, getType, getTypeClass, isDurable, managesChildStorage, open, openAsync, removeChangeListener, setAttribute, setAttributes, setAttributesAsync

Constructor Detail

AbstractVirtualHostNode

public AbstractVirtualHostNode(Broker<?> parent,
                               Map<String,Object> attributes)

Method Detail

onOpen

public void onOpen()

Overrides:

onOpen in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

getChildExecutor

public TaskExecutor getChildExecutor()

Specified by:

getChildExecutor in interface ConfiguredObject<X extends AbstractVirtualHostNode<X>>

Overrides:

getChildExecutor in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

getLifetimePolicy

public LifetimePolicy getLifetimePolicy()

Description copied from interface: ConfiguredObject

Return the lifetime policy for the object

Specified by:

getLifetimePolicy in interface ConfiguredObject<X extends AbstractVirtualHostNode<X>>

Overrides:

getLifetimePolicy in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

Returns:

the lifetime policy

onCreate

protected void onCreate()

Overrides:

onCreate in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

doActivate

protected com.google.common.util.concurrent.ListenableFuture<Void> doActivate()

getVirtualHost

public VirtualHost<?,?,?> getVirtualHost()

Specified by:

getVirtualHost in interface VirtualHostNode<X extends AbstractVirtualHostNode<X>>

validateOnCreate

protected void validateOnCreate()

Overrides:

validateOnCreate in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

validateChange

protected void validateChange(ConfiguredObject<?> proxyForValidation,
                              Set<String> changedAttributes)

Overrides:

validateChange in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

getConfigurationStore

public DurableConfigurationStore getConfigurationStore()

Specified by:

getConfigurationStore in interface VirtualHostNode<X extends AbstractVirtualHostNode<X>>

getBroker

protected Broker<?> getBroker()

getEventLogger

protected EventLogger getEventLogger()

getConfigurationStoreLogSubject

protected MessageStoreLogSubject getConfigurationStoreLogSubject()

doDelete

protected com.google.common.util.concurrent.ListenableFuture<Void> doDelete()

deleteVirtualHostIfExists

protected com.google.common.util.concurrent.ListenableFuture<Void> deleteVirtualHostIfExists()

doStop

protected com.google.common.util.concurrent.ListenableFuture<Void> doStop()

stopAndSetStateTo

protected com.google.common.util.concurrent.ListenableFuture<Void> stopAndSetStateTo(State stoppedState)

onExceptionInOpen

protected void onExceptionInOpen(RuntimeException e)

Description copied from class: AbstractConfiguredObject

Callback method to perform ConfiguredObject specific exception handling on exception in open.

The method is not expected to throw any runtime exception.

Overrides:

onExceptionInOpen in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

Parameters:

e - open exception

postResolve

protected void postResolve()

Overrides:

postResolve in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

onClose

protected void onClose()

Overrides:

onClose in class AbstractConfiguredObject<X extends AbstractVirtualHostNode<X>>

getVirtualHostInitialConfiguration

public String getVirtualHostInitialConfiguration()

Specified by:

getVirtualHostInitialConfiguration in interface VirtualHostNode<X extends AbstractVirtualHostNode<X>>

isDefaultVirtualHostNode

public boolean isDefaultVirtualHostNode()

Specified by:

isDefaultVirtualHostNode in interface VirtualHostNode<X extends AbstractVirtualHostNode<X>>

createConfigurationStore

protected abstract DurableConfigurationStore createConfigurationStore()

activate

protected abstract com.google.common.util.concurrent.ListenableFuture<Void> activate()

enrichInitialVirtualHostRootRecord

protected abstract ConfiguredObjectRecord enrichInitialVirtualHostRootRecord(ConfiguredObjectRecord vhostRecord)

getInitialRecords

protected final ConfiguredObjectRecord[] getInitialRecords()
                                                    throws IOException

Throws:

IOException

getInitialConfigReader

protected final Reader getInitialConfigReader()
                                       throws IOException

Throws:

IOException

getSupportedVirtualHostTypes

protected static Collection<String> getSupportedVirtualHostTypes(boolean includeProvided)