com.sun.enterprise.deployment
Class Descriptor

java.lang.Object
  java.util.Observable
      com.sun.enterprise.deployment.DynamicAttributesDescriptor
          com.sun.enterprise.deployment.Descriptor

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbsoluteOrderingDescriptor, ActivationConfigDescriptor, Addressing, AdminObject, AppListenerDescriptorImpl, AuthMechanism, AuthorizationConstraintImpl, BeanCacheDescriptor, BeanPoolDescriptor, CheckpointAtEndOfMethodDescriptor, ConcurrentMethodDescriptor, ConnectionDefDescriptor, ContainerTransaction, CookieConfigDescriptor, DataSourceDefinitionDescriptor, DataSourcePropertyDescriptor, DescribableDescriptor, EjbAbstractDescriptor, EnvironmentProperty, ExtensionElementDescriptor, FieldDescriptor, FlushAtEndOfMethodDescriptor, IASEjbCMPFinder, IASPersistenceManagerDescriptor, InboundResourceAdapter, InterceptorBindingDescriptor, JavaWebStartAccessDescriptor, JaxrpcMappingDescriptor, JndiEnvironmentRefsGroupDescriptor, JspConfigDescriptor, JspGroupDescriptor, LicenseDescriptor, LifecycleCallbackDescriptor, LocaleEncodingMappingDescriptor, LocaleEncodingMappingListDescriptor, LoginConfigurationImpl, MdbConnectionFactoryDescriptor, MessageDestinationDescriptor, MessageListener, MethodDescriptor, MethodPermission, ModuleDescriptor, MultipartConfigDescriptor, NameValuePairDescriptor, OrderingDescriptor, OrderingOrderingDescriptor, OutboundResourceAdapter, PersistenceDescriptor, PersistenceManagerInUse, PersistenceUnitDescriptor, PrefetchDisabledDescriptor, PrincipalNameDescriptor, QueryDescriptor, RelationRoleDescriptor, RelationshipDescriptor, RespectBinding, RootDeploymentDescriptor, RunAsIdentityDescriptor, RuntimeDescriptor, SecurityConstraintImpl, SecurityPermission, SecurityRoleDescriptor, ServiceRefPortInfo, ServletFilterDescriptor, ServletFilterMappingDescriptor, SessionConfigDescriptor, TimeoutValueDescriptor, UserDataConstraintImpl, WebComponentDescriptor, WebResourceCollectionImpl, WebService, WebServiceEndpoint, WebServiceHandler, WebServiceHandlerChain

public class Descriptor
extends DynamicAttributesDescriptor
implements java.io.Serializable

Descriptor is the root class for all objects representing deployment information in J2EE. Descriptors notifiy listeners of state changes, and have a name, description, and icons.

Author:

Danny Coward

See Also:

Serialized Form

Field Summary

static java.lang.String	DESCRIPTION_CHANGED
static java.lang.String	DESCRIPTOR_CHANGED Notification String for a general descriptor change.
java.lang.String	docType
static java.lang.String	LARGE_ICON_CHANGED
static java.lang.String	NAME_CHANGED
static java.lang.String	SMALL_ICON_CHANGED

Constructor Summary

	Descriptor() The default constructor.
protected	Descriptor(Descriptor other) The copy constructor.
	Descriptor(java.lang.String name, java.lang.String description) Constructs a descriptor with given name, description.

Method Summary

void	addDeploymentExtension(DeploymentExtensionDescriptor de) Add a new deployment-extension for this descriptor
void	addPrefixMapping(java.lang.String mapping, java.lang.String uri) add a prefix mapping
static java.lang.String	createUniqueFilenameAmongst(java.lang.String trialName, java.util.Vector<java.lang.String> otherNames) Returns String based on the trial name that is guaramteed to be different from any of the strings in the vector of String names.
static java.lang.String	createUniqueNameAmongst(java.lang.String trialName, java.util.Vector<java.lang.String> otherNames) Returns String based on the trial name that is guaramteed to be different from any of the strings in the vector of String names.
static java.lang.String	createUniqueNameAmongstNamedDescriptors(java.lang.String trialName, java.util.Set<? extends Descriptor> descriptors) Returns String based on the trial name that is guaramteed to be different from any of the strings returnsed by the getName() call in any of the Descriptor objects in the Set supplied.
void	fillDocType(java.io.InputStream in)
java.util.Iterator	getDeploymentExtensions()
java.lang.String	getDescription() The description text of this descriptor as a String.
java.lang.String	getDisplayName()
java.lang.String	getDocType()
java.lang.String	getLargeIconUri() The large icon name of this descriptor as a String.
java.lang.String	getLocalizedDescription(java.lang.String lang)
java.util.Map<? extends java.lang.String,? extends java.lang.String>	getLocalizedDescriptions()
java.lang.String	getLocalizedDisplayName(java.lang.String language)
java.util.Map<? extends java.lang.String,? extends java.lang.String>	getLocalizedDisplayNames()
java.lang.String	getLocalizedLargeIconUri(java.lang.String lang)
java.util.Map	getLocalizedLargeIconUris()
java.lang.String	getLocalizedSmallIconUri(java.lang.String lang)
java.util.Map<? extends java.lang.String,? extends java.lang.String>	getLocalizedSmallIconUris()
java.lang.String	getName() The name of this descriptor as a String.
java.util.Map<java.lang.String,java.lang.String>	getPrefixMapping()
java.lang.String	getSmallIconUri() The small icon name of this descriptor as a String.
static boolean	isBoundsChecking() Answers whether the object model is bounds checking.
void	print(java.lang.StringBuffer sb) A String representation of this object.
static void	setBoundsChecking(boolean b) Sets a global flag to enable or disable boudsn checking of deployment information
void	setDescription(java.lang.String description) Sets the description text of this descriptor.
void	setDisplayName(java.lang.String name) sets the display name for this bundle
void	setLargeIconUri(java.lang.String largeIconUri) Sets the large icon name of this descriptor as a String.
void	setLocalizedDescription(java.lang.String lang, java.lang.String description) Add a localized description for this descriptor
void	setLocalizedDisplayName(java.lang.String lang, java.lang.String displayName) Add a localized display name for this descriptor
void	setLocalizedLargeIconUri(java.lang.String lang, java.lang.String uri) Sets the large icon uri for a particular language
void	setLocalizedSmallIconUri(java.lang.String lang, java.lang.String uri) set the localized small icon uri for the passed language
void	setName(java.lang.String name) Sets the name of this descriptor.
void	setSmallIconUri(java.lang.String smallIconUri) Sets the small icon name of this descriptor as a String.
void	visit(DescriptorVisitor aVisitor) Visitor API implementation, all descriptors must be visitable

Methods inherited from class com.sun.enterprise.deployment.DynamicAttributesDescriptor

addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR_CHANGED

public static final java.lang.String DESCRIPTOR_CHANGED

Notification String for a general descriptor change.

See Also:

Constant Field Values

NAME_CHANGED

public static final java.lang.String NAME_CHANGED

See Also:

Constant Field Values

DESCRIPTION_CHANGED

public static final java.lang.String DESCRIPTION_CHANGED

See Also:

Constant Field Values

LARGE_ICON_CHANGED

public static final java.lang.String LARGE_ICON_CHANGED

See Also:

Constant Field Values

SMALL_ICON_CHANGED

public static final java.lang.String SMALL_ICON_CHANGED

See Also:

Constant Field Values

docType

public java.lang.String docType

Constructor Detail

Descriptor

public Descriptor()

The default constructor. Constructs a descriptor with name, description and icons as empty Strings.

Descriptor

protected Descriptor(Descriptor other)

The copy constructor.

Parameters:

other - the source descriptor

Descriptor

public Descriptor(java.lang.String name,
                  java.lang.String description)

Constructs a descriptor with given name, description.

Parameters:

name - the name of the descriptor.

description - the name of the descriptor.

Method Detail

setBoundsChecking

public static void setBoundsChecking(boolean b)

Sets a global flag to enable or disable boudsn checking of deployment information

Parameters:

b - true for bounds checking on, false else.

isBoundsChecking

public static boolean isBoundsChecking()

Answers whether the object model is bounds checking.

Returns:

true for boudsn checking, false else.

setName

public void setName(java.lang.String name)

Sets the name of this descriptor.

Parameters:

name - the new name of the descriptor.

getName

public java.lang.String getName()

The name of this descriptor as a String.

Returns:

the name of this descriptor

setLocalizedDisplayName

public void setLocalizedDisplayName(java.lang.String lang,
                                    java.lang.String displayName)

Add a localized display name for this descriptor

Parameters:

lang - the local identifier (null if using default locale)

displayName - the localized string

getLocalizedDisplayName

public java.lang.String getLocalizedDisplayName(java.lang.String language)

Parameters:

language - the language

Returns:

the localized display name for the passed language

getLocalizedDisplayNames

public java.util.Map<? extends java.lang.String,? extends java.lang.String> getLocalizedDisplayNames()

Returns:

the localized display name indexed by language

setDisplayName

public void setDisplayName(java.lang.String name)

sets the display name for this bundle

Parameters:

name - the display name

getDisplayName

public java.lang.String getDisplayName()

Returns:

the display name

setDescription

public void setDescription(java.lang.String description)

Sets the description text of this descriptor.

Parameters:

description - the new description text of the descriptor.

getDescription

public java.lang.String getDescription()

The description text of this descriptor as a String.

Returns:

the description text of this descriptor

setLocalizedDescription

public void setLocalizedDescription(java.lang.String lang,
                                    java.lang.String description)

Add a localized description for this descriptor

Parameters:

lang - the local identifier (null if using default locale)

description - the localized string

getLocalizedDescription

public java.lang.String getLocalizedDescription(java.lang.String lang)

Parameters:

lang - the local language

Returns:

the localized description

getLocalizedDescriptions

public java.util.Map<? extends java.lang.String,? extends java.lang.String> getLocalizedDescriptions()

Returns:

a Map of localized description, where lang is the key

setLocalizedLargeIconUri

public void setLocalizedLargeIconUri(java.lang.String lang,
                                     java.lang.String uri)

Sets the large icon uri for a particular language

Parameters:

lang - the language identifier

uri - the large icon uri

getLocalizedLargeIconUri

public java.lang.String getLocalizedLargeIconUri(java.lang.String lang)

Parameters:

lang - the language or null for the current locale

Returns:

the large icon uri for a language

getLocalizedLargeIconUris

public java.util.Map getLocalizedLargeIconUris()

Returns:

a map of localized large icons uris indexed by language

setLocalizedSmallIconUri

public void setLocalizedSmallIconUri(java.lang.String lang,
                                     java.lang.String uri)

set the localized small icon uri for the passed language

Parameters:

lang - the language

uri - the uri for the small icon

getLocalizedSmallIconUri

public java.lang.String getLocalizedSmallIconUri(java.lang.String lang)

Parameters:

lang - the language

Returns:

the small icon uri for the passed language

getLocalizedSmallIconUris

public java.util.Map<? extends java.lang.String,? extends java.lang.String> getLocalizedSmallIconUris()

Returns:

the map of small icons indexed by language

getLargeIconUri

public java.lang.String getLargeIconUri()

The large icon name of this descriptor as a String.

Returns:

the large icon name of this descriptor

setLargeIconUri

public void setLargeIconUri(java.lang.String largeIconUri)

Sets the large icon name of this descriptor as a String.

Parameters:

largeIconUri - the large icon name of this descriptor

getSmallIconUri

public java.lang.String getSmallIconUri()

The small icon name of this descriptor as a String.

Returns:

the small icon name of this descriptor

setSmallIconUri

public void setSmallIconUri(java.lang.String smallIconUri)

Sets the small icon name of this descriptor as a String.

Parameters:

smallIconUri - the small icon name of this descriptor

createUniqueFilenameAmongst

public static java.lang.String createUniqueFilenameAmongst(java.lang.String trialName,
                                                           java.util.Vector<java.lang.String> otherNames)

Returns String based on the trial name that is guaramteed to be different from any of the strings in the vector of String names.

Parameters:

trialName - the suggested name

otherNames - The Vector of String objects none of which will be the same as the return

Returns:

the unique String

createUniqueNameAmongst

public static java.lang.String createUniqueNameAmongst(java.lang.String trialName,
                                                       java.util.Vector<java.lang.String> otherNames)

Returns String based on the trial name that is guaramteed to be different from any of the strings in the vector of String names.

Parameters:

trialName - the suggested name

otherNames - The Vector of String objects none of which will be the same as the return

Returns:

the unique String

createUniqueNameAmongstNamedDescriptors

public static java.lang.String createUniqueNameAmongstNamedDescriptors(java.lang.String trialName,
                                                                       java.util.Set<? extends Descriptor> descriptors)

Returns String based on the trial name that is guaramteed to be different from any of the strings returnsed by the getName() call in any of the Descriptor objects in the Set supplied.

Parameters:

trialName - the suggested name

descriptors - The Set of Descriptor objects to whose name attribute will not be the same as the return

Returns:

the unique String

addDeploymentExtension

public void addDeploymentExtension(DeploymentExtensionDescriptor de)

Add a new deployment-extension for this descriptor

Parameters:

de - descriptor to add

getDeploymentExtensions

public java.util.Iterator getDeploymentExtensions()

Returns:

an iterator on the deployment-extension

addPrefixMapping

public void addPrefixMapping(java.lang.String mapping,
                             java.lang.String uri)

add a prefix mapping

Parameters:

mapping - the mapping

uri - the uri

getPrefixMapping

public java.util.Map<java.lang.String,java.lang.String> getPrefixMapping()

Returns:

the map of prefix to namepace uri

print

public void print(java.lang.StringBuffer sb)

A String representation of this object.

Overrides:

print in class DynamicAttributesDescriptor

visit

public void visit(DescriptorVisitor aVisitor)

Visitor API implementation, all descriptors must be visitable

Parameters:

aVisitor - the visitor implementation

getDocType

public java.lang.String getDocType()

fillDocType

public void fillDocType(java.io.InputStream in)