Class AdministeredObject
- java.lang.Object
-
- com.sun.messaging.AdministeredObject
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
AdminConnectionFactory,BasicConnectionFactory,Destination
public abstract class AdministeredObject extends java.lang.Object implements java.io.SerializableAnAdministeredObjectencapsulates behavior common to all Sun MQ Administered Objects and MQ Administered Object classes extend this class.All MQ Administered Objects contain a configuration and maintain a state flag indicating whether they are modifiable or read only. They are also versioned to support migration of previous formats of MQ Administered Objects to the current format.
When a MQ Administered Object is first created it contains the default configuration and the configuration is modifiable. After modification (either programmatically, or by the administrator using the MQ Administration utilities), an
AdministeredObjectcan be set to read only to prevent further modification.Typically, the Sun MQ Administration utilities would be used to create MQ Administered Objects, optionally set their state to read only, and store them using the Java Naming and Directory Service (JNDI).
When Sun MQ applications use JNDI and
lookup()MQ Administered Objects that have had their state set to read only, the applications will not be able to modify the administrator stored configurations.Sun MQ automatically converts JMQ, iMQ and Sun ONE MQ Administered Objects from the following previous versions of JMQ, iMQ and Sun ONE MQ to the current version of Oracle GlassFish(tm) Server Message Queue Administered Objects.
- JMQ 1.1 Beta
- JMQ 1.1 FCS
- JMQ 2.0 FCS
- JMQ 2.1 SP1
- iMQ 3.0 FCS
- S1MQ 3.5 FCS
Conversion of JMQ Administered Objects created using JMQ1.1 EA and versions of JMQ prior to JMQ1.1 EA is not supported.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringAO_PROPERTY_TYPE_BOOLEANAdministeredObject configuration property type designator for Booleanstatic java.lang.StringAO_PROPERTY_TYPE_INTEGERAdministeredObject configuration property type designator for Integerstatic java.lang.StringAO_PROPERTY_TYPE_LISTAdministeredObject configuration property type designator for Liststatic java.lang.StringAO_PROPERTY_TYPE_LONGAdministeredObject configuration property type designator for Longstatic java.lang.StringAO_PROPERTY_TYPE_PROPERTYOWNERAdministeredObject configuration property type designator for PropertyOwnerstatic java.lang.StringAO_PROPERTY_TYPE_STRINGAdministeredObject configuration property type designator for Stringprotected static java.util.Map<java.lang.String,java.util.Properties[]>cachedConfigurationMapcachedConfigurationMap key = defaultsBase, value is a Properties[] where value[0] is the cached initial value of configuration where value[1] is the cached initial value of configurationTypes where value[2] is the cached initial value of configurationLabelsprotected java.util.PropertiesconfigurationThe configuration of thisAdministeredObjectprotected java.util.PropertiesconfigurationLabelsprotected java.util.PropertiesconfigurationTypesstatic com.sun.messaging.jmq.jmsclient.resources.ClientResourcescrstatic java.lang.StringVERSIONThe Version string of thisAdministeredObjectis3.0
-
Constructor Summary
Constructors Constructor Description AdministeredObject(java.lang.String defaultsBase)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Stringdump()Returns the provider specific name for thisAdministeredObjectalong with a complete listing of its configuration, configuration attribute label keys and configuration attribute types.java.util.EnumerationenumeratePropertyNames()Returns an enumeration of the configuration property names of thisAdministeredObject.java.util.PropertiesgetConfiguration()Returns the configuration of thisAdministeredObject.java.util.PropertiesgetCurrentConfiguration()Returns the current (runtime) configuration of thisAdministeredObjectmodified by any System properties.java.lang.StringgetLabelForGroup(java.lang.String group)Returns the label for a given group.java.lang.StringgetPropertiesForGroup(java.lang.String group)Returns an ordered property list for a given group.java.lang.StringgetProperty(java.lang.String propname)Returns a single configuration property value given the property name.java.lang.StringgetPropertyForListValue(java.lang.String listpropname, java.lang.String listvalue)Returns the property name for any selection on Properties of Type List.java.lang.StringgetPropertyGroups()Returns an ordered property groups list.java.lang.StringgetPropertyLabel(java.lang.String propname)Returns the configuration label of a single configuration property name.java.lang.StringgetPropertyListOtherName(java.lang.String propname)Returns the property name for the ...java.lang.StringgetPropertyListValues(java.lang.String propname)Returns an ordered property list for Properties of Type List.java.lang.StringgetPropertyType(java.lang.String propname)Returns the configuration type of a single configuration property name.java.lang.StringgetPropertyValueForListValue(java.lang.String listpropname, java.lang.String listvalue, java.lang.String propname)Returns the property values set when a property of type List is set to a particular value.java.lang.StringgetStoredVersion()Returns the storedVersion of thisAministeredObject.static java.lang.StringgetVERSION()Returns the Version string used for this MQAdministeredObject.booleanisPropertyDeprecated(java.lang.String propname)Returns whether a single configuration property name is deprecated or not.booleanisPropertyHidden(java.lang.String propname)Returns whether a single configuration property name should be hidden or not.booleanisReadOnly()Returns the readOnly state of thisAministeredObject.booleanisStoredVersionCompatible()Tests whether the storedVersion of thisAministeredObjectis compatible with the current runtime VERSIONabstract voidsetDefaultConfiguration()Subclasses must implement this to set their default configuration.java.lang.StringsetProperty(java.lang.String propname, java.lang.String propval)Sets a single configuration property in thisAdministeredObject.voidsetReadOnly()Sets thisAdministeredObjectto be read only.voidsetStoredVersion(java.lang.String version)java.lang.StringtoString()Returns the provider specific name for thisAdministeredObjectalong with a listing of its configuration.
-
-
-
Field Detail
-
VERSION
public static final java.lang.String VERSION
The Version string of thisAdministeredObjectis3.0- See Also:
- Constant Field Values
-
AO_PROPERTY_TYPE_STRING
public static final java.lang.String AO_PROPERTY_TYPE_STRING
AdministeredObject configuration property type designator for String- See Also:
- Constant Field Values
-
AO_PROPERTY_TYPE_INTEGER
public static final java.lang.String AO_PROPERTY_TYPE_INTEGER
AdministeredObject configuration property type designator for Integer- See Also:
- Constant Field Values
-
AO_PROPERTY_TYPE_LONG
public static final java.lang.String AO_PROPERTY_TYPE_LONG
AdministeredObject configuration property type designator for Long- See Also:
- Constant Field Values
-
AO_PROPERTY_TYPE_BOOLEAN
public static final java.lang.String AO_PROPERTY_TYPE_BOOLEAN
AdministeredObject configuration property type designator for Boolean- See Also:
- Constant Field Values
-
AO_PROPERTY_TYPE_PROPERTYOWNER
public static final java.lang.String AO_PROPERTY_TYPE_PROPERTYOWNER
AdministeredObject configuration property type designator for PropertyOwner- See Also:
- Constant Field Values
-
AO_PROPERTY_TYPE_LIST
public static final java.lang.String AO_PROPERTY_TYPE_LIST
AdministeredObject configuration property type designator for List- See Also:
- Constant Field Values
-
configuration
protected java.util.Properties configuration
The configuration of thisAdministeredObject
-
configurationTypes
protected java.util.Properties configurationTypes
-
configurationLabels
protected java.util.Properties configurationLabels
-
cr
public static final transient com.sun.messaging.jmq.jmsclient.resources.ClientResources cr
-
cachedConfigurationMap
protected static final java.util.Map<java.lang.String,java.util.Properties[]> cachedConfigurationMap
cachedConfigurationMap key = defaultsBase, value is a Properties[] where value[0] is the cached initial value of configuration where value[1] is the cached initial value of configurationTypes where value[2] is the cached initial value of configurationLabels
-
-
Method Detail
-
setDefaultConfiguration
public abstract void setDefaultConfiguration()
Subclasses must implement this to set their default configuration.
-
isReadOnly
public final boolean isReadOnly()
Returns the readOnly state of thisAministeredObject.- Returns:
- the readOnly state of this
AministeredObject
-
getStoredVersion
public final java.lang.String getStoredVersion()
Returns the storedVersion of thisAministeredObject.- Returns:
- the storedVersion of this
AministeredObject
-
setStoredVersion
public final void setStoredVersion(java.lang.String version)
-
isStoredVersionCompatible
public final boolean isStoredVersionCompatible()
Tests whether the storedVersion of thisAministeredObjectis compatible with the current runtime VERSIONThis methods flags mismatches between this
Administered Objectand the version stored in JNDI using an earlier or different version of this class. It is advisable to check before an earlier version of Administered Object is being overwritten by a newer version, otherwise an earlier version of the MQ Client will fail when attempting to use JNDI tolookup()that earlier version of the Administered Object.- Returns:
- the storedVersion of this
AministeredObject
-
setReadOnly
public final void setReadOnly()
Sets thisAdministeredObjectto be read only. Once thisAdministeredObjecthas been set to read only it cannot be reset back to read write.
-
getConfiguration
public java.util.Properties getConfiguration()
Returns the configuration of thisAdministeredObject.The configuration returned is the one that has been administratively or programmatically set in this
AdministeredObjectThis configuration is unaffected by runtime overrides using System properties.Use
getCurrentConfiguration()to get the current configuration, which takes into account any overriding System properties that have been set at runtime.- Returns:
- the configuration of this
AdministeredObject. - See Also:
getCurrentConfiguration()
-
getPropertyGroups
public java.lang.String getPropertyGroups()
Returns an ordered property groups list.- Returns:
- The String that represents an ordered property groups list. This list uses the '
|' character as the separator.
-
getPropertiesForGroup
public java.lang.String getPropertiesForGroup(java.lang.String group)
Returns an ordered property list for a given group.- Parameters:
group- The group for which the property list is desired.- Returns:
- The String that represents an ordered property list for a given group. This list uses the '
|' character as the separator.
-
getLabelForGroup
public java.lang.String getLabelForGroup(java.lang.String group)
Returns the label for a given group.- Parameters:
group- The group for which the label is desired.- Returns:
- The label the given group.
-
getPropertyListValues
public java.lang.String getPropertyListValues(java.lang.String propname)
Returns an ordered property list for Properties of Type List.- Parameters:
propname- The name of the configuration property that is of type List.- Returns:
- The String that represents an ordered property list. This list uses the '
|' character as the separator.
-
getPropertyForListValue
public java.lang.String getPropertyForListValue(java.lang.String listpropname, java.lang.String listvalue)Returns the property name for any selection on Properties of Type List.- Parameters:
listpropname- The name of the configuration property that is of type List.listvalue- The value of the configuration property that is of type List.- Returns:
- The property that is pre set when a property of type List is set to the value
listvalue.
-
getPropertyValueForListValue
public java.lang.String getPropertyValueForListValue(java.lang.String listpropname, java.lang.String listvalue, java.lang.String propname)Returns the property values set when a property of type List is set to a particular value.- Parameters:
listpropname- The name of the configuration property that is of type List.listvalue- The value of the configuration property that is of type List.propname- The name of the property for which the value is being sought.- Returns:
- The value that property
propnameis pre set to when the propertylistpropnameof type list is set to the valuelistvalue.
-
getPropertyListOtherName
public java.lang.String getPropertyListOtherName(java.lang.String propname)
Returns the property name for the ... selection on Properties of Type List.- Returns:
- The property to be exposed for editing when the
...selection on Properties of Type List is selected.
-
enumeratePropertyNames
public java.util.Enumeration enumeratePropertyNames()
Returns an enumeration of the configuration property names of thisAdministeredObject.- Returns:
- The enumeration of configuration property names.
-
setProperty
public java.lang.String setProperty(java.lang.String propname, java.lang.String propval) throws jakarta.jms.JMSExceptionSets a single configuration property in thisAdministeredObject.- Parameters:
propname- The name of the configuration property to set.propval- The value of the configuration property to set.- Returns:
- The previous value of the configuration property being set.
- Throws:
InvalidPropertyException- If an invalid property name is being set. The Exception string is the name of the invalid property.InvalidPropertyValueException- If an invalid property value is being set. The Exception string is the invalid value of the property.ReadOnlyPropertyException- If an attempt is made to modify thisAdministeredObjectwhen the readOnly flag has been set.jakarta.jms.JMSException
-
getProperty
public java.lang.String getProperty(java.lang.String propname) throws jakarta.jms.JMSExceptionReturns a single configuration property value given the property name.- Parameters:
propname- The name of the configuration property.- Returns:
- The value of the configuration property
propname. - Throws:
InvalidPropertyException- If an invalid property name is being requested. The Exception string is the name of the invalid property.jakarta.jms.JMSException
-
getPropertyType
public java.lang.String getPropertyType(java.lang.String propname) throws jakarta.jms.JMSExceptionReturns the configuration type of a single configuration property name.- Parameters:
propname- The name of the configuration property.- Returns:
- The type of the configuration property
propname. - Throws:
InvalidPropertyException- If an invalid property name is being requested. The Exception string is the name of the invalid property.jakarta.jms.JMSException
-
getPropertyLabel
public java.lang.String getPropertyLabel(java.lang.String propname) throws jakarta.jms.JMSExceptionReturns the configuration label of a single configuration property name.- Parameters:
propname- The name of the configuration property.- Returns:
- The label of the configuration property
propname. - Throws:
InvalidPropertyException- If an invalid property name is being requested. The Exception string is the name of the invalid property.jakarta.jms.JMSException
-
isPropertyHidden
public boolean isPropertyHidden(java.lang.String propname) throws jakarta.jms.JMSExceptionReturns whether a single configuration property name should be hidden or not.- Parameters:
propname- The name of the configuration property.- Returns:
trueIf the configuration propertypropnameshould be hidden;falseif it should not be hidden i.e. it is still supported in this version.- Throws:
InvalidPropertyException- If an invalid property name is being requested. The Exception string is the name of the invalid property.jakarta.jms.JMSException
-
isPropertyDeprecated
public boolean isPropertyDeprecated(java.lang.String propname) throws jakarta.jms.JMSExceptionReturns whether a single configuration property name is deprecated or not.- Parameters:
propname- The name of the configuration property.- Returns:
trueIf the configuration propertypropnamehas been deprecated;falseif it has not been deprecated i.e. it is still supported in this version.- Throws:
InvalidPropertyException- If an invalid property name is being requested. The Exception string is the name of the invalid property.jakarta.jms.JMSException
-
toString
public java.lang.String toString()
Returns the provider specific name for thisAdministeredObjectalong with a listing of its configuration.- Overrides:
toStringin classjava.lang.Object- Returns:
- A formatted String containing the provider specific name for this
AdministeredObjectalong with a listing of its configuration.
-
dump
public java.lang.String dump()
Returns the provider specific name for thisAdministeredObjectalong with a complete listing of its configuration, configuration attribute label keys and configuration attribute types.- Returns:
- A formatted String containing the provider specific name for this
AdministeredObjectalong with a listing of its configuration.
-
getVERSION
public static final java.lang.String getVERSION()
Returns the Version string used for this MQAdministeredObject.- Returns:
- the Version string
-
getCurrentConfiguration
public java.util.Properties getCurrentConfiguration()
Returns the current (runtime) configuration of thisAdministeredObjectmodified by any System properties.If the readOnly flag of this
AdministeredObjectis set, then thisAdministeredObjectis not affected by any System Properties set at runtime.- Returns:
- The current (runtime) configuration of this
AdministeredObjectmodified by any System properties. - See Also:
getConfiguration()
-
-