Package org.apache.qpid.server.model

Interface ConfiguredObject<X extends ConfiguredObject<X>>

All Superinterfaces:

ContextProvider, PermissionedObject, TaskExecutorProvider

All Known Subinterfaces:

AccessControlProvider<X>, AllowAllAccessControlProvider<X>, AMQPConnection<C>, AmqpPort<X>, AMQPSession<S,X>, AuthenticationMethod, AuthenticationProvider<X>, AutoGeneratedSelfSignedKeyStore<X>, Broker<X>, BrokerConnectionLimitProvider<X>, BrokerLogger<X>, BrokerLogInclusionRule<X>, CachingAuthenticationProvider<X>, CaseAwareGroupProvider<X>, CloudFoundryDashboardManagementGroupProvider<X>, CompositeUsernamePasswordAuthenticationManager<T>, Connection<X>, ConnectionLimitProvider<X>, Consumer<X,T>, Container<C>, DefaultVirtualHostAlias<X>, DirectExchange<X>, Exchange<X>, ExternalAuthenticationManager<T>, ExternalFileBasedAuthenticationManager<X>, FanoutExchange<X>, FileBasedGroupProvider<X>, FileKeyStore<X>, FileTrustStore<X>, FixedVirtualHostNodeAlias<X>, Group<X>, GroupMember<X>, GroupProvider<X>, HeadersExchange<X>, HostNameAlias<X>, HttpPort<X>, JsonSystemConfig<X>, JsonVirtualHostNode<X>, KeyStore<X>, LastValueQueue<X>, ManagedPeerCertificateTrustStore<X>, MemorySystemConfig<X>, NonJavaKeyStore<X>, NonJavaTrustStore<X>, NonStandardVirtualHost<X>, OAuth2AuthenticationProvider<T>, PasswordCredentialManagingAuthenticationProvider<X>, PatternMatchingAlias<X>, Plugin<X>, Port<X>, PriorityQueue<X>, Producer<X>, ProvidedStoreVirtualHost<X>, Queue<X>, QueueConsumer<X,T>, QueueManagingVirtualHost<X>, RedirectingVirtualHost<X>, RedirectingVirtualHostNode<X>, RemoteReplicationNode<X>, Session<X>, SimpleLDAPAuthenticationManager<X>, SiteSpecificTrustStore<X>, SortedQueue<X>, StandardQueue<X>, SystemAddressSpaceAlias<X>, SystemConfig<X>, TopicExchange<X>, TrustStore<X>, User<X>, UsernamePasswordAuthenticationProvider<X>, VirtualHost<X>, VirtualHostAccessControlProvider<X>, VirtualHostAlias<X>, VirtualHostConnectionLimitProvider<X>, VirtualHostLogger<X>, VirtualHostLogInclusionRule<X>, VirtualHostNameAlias<X>, VirtualHostNode<X>

All Known Implementing Classes:

AbstractAccessControlProvider, AbstractAMQPConnection, AbstractAMQPSession, AbstractAuthenticationManager, AbstractCaseAwareGroupProvider, AbstractConfiguredObject, AbstractContainer, AbstractExchange, AbstractKeyStore, AbstractNonConnectionAcceptingVirtualHost, AbstractPluginAdapter, AbstractPort, AbstractQueue, AbstractScramAuthenticationManager, AbstractStandardVirtualHostNode, AbstractSystemConfig, AbstractTrustStore, AbstractVirtualHost, AbstractVirtualHostNode, AllowAllAccessControlProviderImpl, AmqpPortImpl, AnonymousAuthenticationManager, AutoGeneratedSelfSignedKeyStoreImpl, Base64MD5PasswordDatabaseAuthenticationManager, BrokerImpl, CloudFoundryDashboardManagementGroupProviderImpl, CompositeUsernamePasswordAuthenticationManagerImpl, ConfigModelPasswordManagingAuthenticationProvider, DefaultVirtualHostAliasImpl, DirectExchangeImpl, ExternalAuthenticationManagerImpl, FileBasedGroupProviderImpl, FileKeyStoreImpl, FileTrustStoreImpl, GroupImpl, GroupMemberImpl, GroupProviderImpl, HeadersExchangeImpl, HostNameAliasImpl, HttpPortImpl, JsonSystemConfigImpl, JsonVirtualHostNodeImpl, KerberosAuthenticationManager, LastValueQueueImpl, ManagedPeerCertificateTrustStoreImpl, MD5AuthenticationProvider, NonJavaKeyStoreImpl, NonJavaTrustStoreImpl, OAuth2AuthenticationProviderImpl, OutOfOrderQueue, PatternMatchingAliasImpl, PlainAuthenticationProvider, PlainPasswordDatabaseAuthenticationManager, PrincipalDatabaseAuthenticationManager, PriorityQueueImpl, ProducerImpl, ProvidedStoreVirtualHostImpl, RedirectingVirtualHostNodeImpl, ScramSHA1AuthenticationManager, ScramSHA256AuthenticationManager, SimpleAuthenticationManager, SimpleLDAPAuthenticationManagerImpl, SiteSpecificTrustStoreImpl, SortedQueueImpl, StandardQueueImpl, SystemAddressSpaceAliasImpl, VirtualHostNameAliasImpl

public interface ConfiguredObject<X extends ConfiguredObject<X>>
extends ContextProvider, TaskExecutorProvider, PermissionedObject

Field Summary

Fields

Modifier and Type	Field	Description
static String	AWAIT_ATTAINMENT_TIMEOUT
static String	CONTEXT
static String	CREATED_BY
static String	CREATED_TIME
static int	DEFAULT_AWAIT_ATTAINMENT_TIMEOUT
static String	DESCRIPTION
static String	DESIRED_STATE
static String	DURABLE
static String	ID
static String	LAST_UPDATED_BY
static String	LAST_UPDATED_TIME
static String	LIFETIME_POLICY
static String	NAME
static String	OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT
static String	STATE
static String	TYPE

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(ConfigurationChangeListener listener)	Add a listener which will be informed of all changes to this configuration object
ConfiguredObjectRecord	asObjectRecord()
void	authorise(Operation operation)
void	authorise(Operation operation, Map<String,Object> arguments)
void	authorise(SecurityToken token, Operation operation, Map<String,Object> arguments)
void	close()
com.google.common.util.concurrent.ListenableFuture<Void>	closeAsync()
<C extends ConfiguredObject> C	createChild(Class<C> childClass, Map<String,Object> attributes)
<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>	createChildAsync(Class<C> childClass, Map<String,Object> attributes)
void	decryptSecrets()
void	delete()
com.google.common.util.concurrent.ListenableFuture<Void>	deleteAsync()
<C extends ConfiguredObject<C>> C	findConfiguredObject(Class<C> clazz, String name)
Map<String,Object>	getActualAttributes()	Return the map containing only explicitly set attributes
<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>	getAttainedChildById(Class<C> childClass, UUID id)
<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>	getAttainedChildByName(Class<C> childClass, String name)
Object	getAttribute(String name)	Return the value for the given attribute name.
Collection<String>	getAttributeNames()	Get the names of attributes that are set on this object Note that the returned collection is correct at the time the method is called, but will not reflect future additions or removals when they occur
Class<? extends ConfiguredObject>	getCategoryClass()
<C extends ConfiguredObject> C	getChildById(Class<C> clazz, UUID id)
<C extends ConfiguredObject> C	getChildByName(Class<C> clazz, String name)
TaskExecutor	getChildExecutor()
<C extends ConfiguredObject> Collection<C>	getChildren(Class<C> clazz)	Return children of the ConfiguredObject of the given class
Map<String,String>	getContext()
String	getCreatedBy()
Date	getCreatedTime()
String	getDescription()
State	getDesiredState()	Get the desired state of the object.
UUID	getId()	Get the universally unique identifier for the object
Date	getLastOpenedTime()
String	getLastUpdatedBy()
Date	getLastUpdatedTime()
LifetimePolicy	getLifetimePolicy()	Return the lifetime policy for the object
Model	getModel()
String	getName()	Get the name of the object
ConfiguredObjectFactory	getObjectFactory()
ConfiguredObject<?>	getParent()	Get the parent of the given type for this object
State	getState()	Get the actual state of the object.
Map<String,Object>	getStatistics()	Return the statistics for the ConfiguredObject
Map<String,Object>	getStatistics(List<String> statistics)
String	getType()
Class<? extends ConfiguredObject>	getTypeClass()
UserPreferences	getUserPreferences()
boolean	hasEncrypter()
boolean	isDurable()	Returns whether the the object configuration is durably stored
boolean	managesChildStorage()
SecurityToken	newToken(Subject subject)
void	open()
com.google.common.util.concurrent.ListenableFuture<Void>	openAsync()
boolean	removeChangeListener(ConfigurationChangeListener listener)	Remove a change listener
String	removeContextVariable(String name)
void	setAttributes(Map<String,Object> attributes)
com.google.common.util.concurrent.ListenableFuture<Void>	setAttributesAsync(Map<String,Object> attributes)
String	setContextVariable(String name, String value)
void	setUserPreferences(UserPreferences userPreferences)

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

getContextKeys, getContextValue, getContextValue

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

getTaskExecutor

Field Detail

OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT

static final String OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT

See Also:

Constant Field Values

ID

static final String ID

See Also:

Constant Field Values

NAME

static final String NAME

See Also:

Constant Field Values

TYPE

static final String TYPE

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

See Also:

Constant Field Values

DURABLE

static final String DURABLE

See Also:

Constant Field Values

CONTEXT

static final String CONTEXT

See Also:

Constant Field Values

LIFETIME_POLICY

static final String LIFETIME_POLICY

See Also:

Constant Field Values

LAST_UPDATED_BY

static final String LAST_UPDATED_BY

See Also:

Constant Field Values

LAST_UPDATED_TIME

static final String LAST_UPDATED_TIME

See Also:

Constant Field Values

STATE

static final String STATE

See Also:

Constant Field Values

DESIRED_STATE

static final String DESIRED_STATE

See Also:

Constant Field Values

CREATED_BY

static final String CREATED_BY

See Also:

Constant Field Values

CREATED_TIME

static final String CREATED_TIME

See Also:

Constant Field Values

AWAIT_ATTAINMENT_TIMEOUT

static final String AWAIT_ATTAINMENT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_AWAIT_ATTAINMENT_TIMEOUT

static final int DEFAULT_AWAIT_ATTAINMENT_TIMEOUT

See Also:

Constant Field Values

Method Detail

getId

UUID getId()

Get the universally unique identifier for the object

Returns:

the objects id

getName

String getName()

Get the name of the object

Specified by:

getName in interface PermissionedObject

Returns:

the name of the object

getDescription

String getDescription()

getType

String getType()

getContext

Map<String,String> getContext()

getLastUpdatedBy

String getLastUpdatedBy()

getLastUpdatedTime

Date getLastUpdatedTime()

getCreatedBy

String getCreatedBy()

getCreatedTime

Date getCreatedTime()

getDesiredState

State getDesiredState()

Get the desired state of the object. This is the state set at the object itself, however the object may not be able attain this state if one of its ancestors is in a different state (in particular a descendant object may not be ACTIVE if all of its ancestors are not also ACTIVE).

Returns:

the desired state of the object

getState

State getState()

Get the actual state of the object. This state is derived from the desired state of the object itself and the actual state of its parents. If an object "desires" to be ACTIVE, but one of its parents is STOPPED, then the actual state of the object will be STOPPED

Returns:

the actual state of the object

getLastOpenedTime

Date getLastOpenedTime()

addChangeListener

void addChangeListener(ConfigurationChangeListener listener)

Add a listener which will be informed of all changes to this configuration object

Parameters:

listener - the listener to add

removeChangeListener

boolean removeChangeListener(ConfigurationChangeListener listener)

Remove a change listener

Parameters:

listener - the listener to remove

Returns:

true iff a listener was removed

getParent

ConfiguredObject<?> getParent()

Get the parent of the given type for this object

Returns:

the objects parent

isDurable

boolean isDurable()

Returns whether the the object configuration is durably stored

Returns:

the durability

getLifetimePolicy

LifetimePolicy getLifetimePolicy()

Return the lifetime policy for the object

Returns:

the lifetime policy

getStatistics

Map<String,Object> getStatistics(List<String> statistics)

setContextVariable

String setContextVariable(String name,
                          String value)

removeContextVariable

String removeContextVariable(String name)

getAttributeNames

Collection<String> getAttributeNames()

Get the names of attributes that are set on this object Note that the returned collection is correct at the time the method is called, but will not reflect future additions or removals when they occur

Returns:

the collection of attribute names

getAttribute

Object getAttribute(String name)

Return the value for the given attribute name. The actual attribute value is returned if the configured object has such attribute set. If not, the value is looked default attributes.

Parameters:

name - the name of the attribute

Returns:

the value of the attribute at the object (or null if the attribute value is set neither on object itself no in defaults)

getActualAttributes

Map<String,Object> getActualAttributes()

Return the map containing only explicitly set attributes

Returns:

the map with the attributes

getStatistics

Map<String,Object> getStatistics()

Return the statistics for the ConfiguredObject

Returns:

the current statistics for the ConfiguredObject

getChildren

<C extends ConfiguredObject> Collection<C> getChildren(Class<C> clazz)

Return children of the ConfiguredObject of the given class

Parameters:

clazz - the class of the children to return

Returns:

the children

Throws:

NullPointerException - if the supplied class null

getChildById

<C extends ConfiguredObject> C getChildById(Class<C> clazz,
                                            UUID id)

getChildByName

<C extends ConfiguredObject> C getChildByName(Class<C> clazz,
                                              String name)

createChild

<C extends ConfiguredObject> C createChild(Class<C> childClass,
                                           Map<String,Object> attributes)

getAttainedChildById

<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C> getAttainedChildById(Class<C> childClass,
                                                                                                        UUID id)

getAttainedChildByName

<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C> getAttainedChildByName(Class<C> childClass,
                                                                                                          String name)

createChildAsync

<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C> createChildAsync(Class<C> childClass,
                                                                                                    Map<String,Object> attributes)

setAttributes

void setAttributes(Map<String,Object> attributes)
            throws IllegalStateException,
                   AccessControlException,
                   IllegalArgumentException

Throws:

IllegalStateException

AccessControlException

IllegalArgumentException

setAttributesAsync

com.google.common.util.concurrent.ListenableFuture<Void> setAttributesAsync(Map<String,Object> attributes)
                                                                     throws IllegalStateException,
                                                                            AccessControlException,
                                                                            IllegalArgumentException

Throws:

IllegalStateException

AccessControlException

IllegalArgumentException

getCategoryClass

Class<? extends ConfiguredObject> getCategoryClass()

Specified by:

getCategoryClass in interface PermissionedObject

getTypeClass

Class<? extends ConfiguredObject> getTypeClass()

managesChildStorage

boolean managesChildStorage()

findConfiguredObject

<C extends ConfiguredObject<C>> C findConfiguredObject(Class<C> clazz,
                                                       String name)

asObjectRecord

ConfiguredObjectRecord asObjectRecord()

open

void open()

openAsync

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

close

void close()

closeAsync

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

deleteAsync

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

getChildExecutor

TaskExecutor getChildExecutor()

getObjectFactory

ConfiguredObjectFactory getObjectFactory()

getModel

Model getModel()

delete

void delete()

hasEncrypter

boolean hasEncrypter()

decryptSecrets

void decryptSecrets()

getUserPreferences

UserPreferences getUserPreferences()

setUserPreferences

void setUserPreferences(UserPreferences userPreferences)

authorise

void authorise(Operation operation)
        throws AccessControlException

Throws:

AccessControlException

authorise

void authorise(Operation operation,
               Map<String,Object> arguments)
        throws AccessControlException

Throws:

AccessControlException

authorise

void authorise(SecurityToken token,
               Operation operation,
               Map<String,Object> arguments)
        throws AccessControlException

Throws:

AccessControlException

newToken

SecurityToken newToken(Subject subject)