Package 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:

EventLoggerProvider, ConfiguredObject<X>, ContextProvider, PermissionedObject, TaskExecutorProvider, VirtualHostNode<X>, PreferencesRoot

Direct Known Subclasses:

AbstractStandardVirtualHostNode

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.ConfiguredObject

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract com.google.common.util.concurrent.ListenableFuture<Void>	activate()
protected com.google.common.util.concurrent.ListenableFuture<Void>	closeVirtualHostIfExists()
protected abstract DurableConfigurationStore	createConfigurationStore()
PreferenceStore	createPreferenceStore()
protected com.google.common.util.concurrent.ListenableFuture<Void>	doActivate()
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()
EventLogger	getEventLogger()
protected Reader	getInitialConfigReader()
protected ConfiguredObjectRecord[]	getInitialRecords()
LifetimePolicy	getLifetimePolicy()	Return the lifetime policy for the object
PreferenceStoreAttributes	getPreferenceStoreAttributes()
protected static Collection<String>	getSupportedVirtualHostTypes(boolean includeProvided)
VirtualHost<?>	getVirtualHost()
String	getVirtualHostInitialConfiguration()
boolean	isDefaultVirtualHostNode()
protected com.google.common.util.concurrent.ListenableFuture<Void>	onClose()
protected void	onCloseOrDelete()
protected void	onCreate()
protected com.google.common.util.concurrent.ListenableFuture<Void>	onDelete()
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>	startQuiesced()
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, addFutureCallback, applyToChildren, asObjectRecord, attainState, attributesAsString, attributeSet, authorise, authorise, authorise, authoriseCreateChild, awaitChildClassToAttainState, awaitChildClassToAttainState, beforeClose, beforeDelete, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleteChildren, deleteNoChecks, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getAccessControl, getActualAttributes, getAncestor, 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, getStatistics, getSubjectWithAddedSystemRights, getSystemPrincipal, getSystemTaskControllerContext, getSystemTaskSubject, getSystemTaskSubject, getTaskExecutor, getType, getTypeClass, getUserPreferences, handleExceptionOnOpen, hasEncrypter, isDurable, isSystemProcess, isSystemSubject, logCreated, logDeleted, logOperation, logRecovered, logUpdated, managesChildStorage, newToken, notifyStateChanged, onResolve, onValidate, open, openAsync, postResolveChildren, postSetAttributes, registerWithParents, removeChangeListener, removeContextVariable, rethrowRuntimeExceptionsOnOpen, runTask, setAttributes, setAttributesAsync, setContextVariable, setEncrypter, setState, setUserPreferences, start, startAsync, stop, toString, updateModel, validateChildDelete

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.ConfiguredObject

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

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

getContextKeys, getContextValue, getContextValue

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

getTaskExecutor

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

getRemoteReplicationNodes, start, stop

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>>

startQuiesced

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

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

public EventLogger getEventLogger()

Specified by:

getEventLogger in interface EventLoggerProvider

getConfigurationStoreLogSubject

protected MessageStoreLogSubject getConfigurationStoreLogSubject()

onDelete

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

Overrides:

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

closeVirtualHostIfExists

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

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 com.google.common.util.concurrent.ListenableFuture<Void> onClose()

Overrides:

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

onCloseOrDelete

protected void onCloseOrDelete()

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>>

getPreferenceStoreAttributes

public PreferenceStoreAttributes getPreferenceStoreAttributes()

Specified by:

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

createPreferenceStore

public PreferenceStore createPreferenceStore()

Specified by:

createPreferenceStore in interface PreferencesRoot

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)