FileDocCategorySizeDatePackage
MailResource.javaAPI DocGlassfish v2 API16731Fri May 26 10:47:08 BST 2006com.sun.enterprise.config.serverbeans

MailResource

public class MailResource extends com.sun.enterprise.config.ConfigBean implements Serializable
This generated bean class MailResource matches the DTD element mail-resource

Fields Summary
static Vector
comparators
private static final org.netbeans.modules.schema2beans.Version
runtimeVersion
public static final String
DESCRIPTION
public static final String
ELEMENT_PROPERTY
Constructors Summary
public MailResource()


	  
		this(Common.USE_DEFAULT_VALUES);
public MailResource(int options)

		super(comparators, runtimeVersion);
		// Properties (see root bean comments for the bean graph)
		initPropertyTables(2);
		this.createProperty("description", DESCRIPTION, 
			Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY, 
			String.class);
		this.createProperty("property", ELEMENT_PROPERTY, 
			Common.TYPE_0_N | Common.TYPE_BEAN | Common.TYPE_KEY, 
			ElementProperty.class);
		this.createAttribute(ELEMENT_PROPERTY, "name", "Name", 
						AttrProp.CDATA | AttrProp.REQUIRED,
						null, null);
		this.createAttribute(ELEMENT_PROPERTY, "value", "Value", 
						AttrProp.CDATA | AttrProp.REQUIRED,
						null, null);
		this.initialize(options);
Methods Summary
public static voidaddComparator(org.netbeans.modules.schema2beans.BeanComparator c)

		comparators.add(c);
public intaddElementProperty(ElementProperty value)

		return addElementProperty(value, true);
public intaddElementProperty(ElementProperty value, boolean overwrite)

		ElementProperty old = getElementPropertyByName(value.getName());
		if(old != null) {
			throw new ConfigException(StringManager.getManager(MailResource.class).getString("cannotAddDuplicate",  "ElementProperty"));
		}
		return this.addValue(ELEMENT_PROPERTY, value, overwrite);
public voiddump(java.lang.StringBuffer str, java.lang.String indent)

		String s;
		Object o;
		org.netbeans.modules.schema2beans.BaseBean n;
		str.append(indent);
		str.append("Description");	// NOI18N
		str.append(indent+"\t");	// NOI18N
		str.append("<");	// NOI18N
		o = this.getDescription();
		str.append((o==null?"null":o.toString().trim()));	// NOI18N
		str.append(">\n");	// NOI18N
		this.dumpAttributes(DESCRIPTION, 0, str, indent);

		str.append(indent);
		str.append("ElementProperty["+this.sizeElementProperty()+"]");	// NOI18N
		for(int i=0; i<this.sizeElementProperty(); i++)
		{
			str.append(indent+"\t");
			str.append("#"+i+":");
			n = (org.netbeans.modules.schema2beans.BaseBean) this.getElementProperty(i);
			if (n != null)
				n.dump(str, indent + "\t");	// NOI18N
			else
				str.append(indent+"\tnull");	// NOI18N
			this.dumpAttributes(ELEMENT_PROPERTY, i, str, indent);
		}
public java.lang.StringdumpBeanNode()

		StringBuffer str = new StringBuffer();
		str.append("MailResource\n");	// NOI18N
		this.dump(str, "\n  ");	// NOI18N
		return str.toString();
public static java.lang.StringgetDefaultAttributeValue(java.lang.String attr)

		if(attr == null) return null;
		attr = attr.trim();
		if(attr.equals(ServerTags.STORE_PROTOCOL)) return "imap".trim();
		if(attr.equals(ServerTags.STORE_PROTOCOL_CLASS)) return "com.sun.mail.imap.IMAPStore".trim();
		if(attr.equals(ServerTags.TRANSPORT_PROTOCOL)) return "smtp".trim();
		if(attr.equals(ServerTags.TRANSPORT_PROTOCOL_CLASS)) return "com.sun.mail.smtp.SMTPTransport".trim();
		if(attr.equals(ServerTags.DEBUG)) return "false".trim();
		if(attr.equals(ServerTags.OBJECT_TYPE)) return "user".trim();
		if(attr.equals(ServerTags.ENABLED)) return "true".trim();
	return null;
public static java.lang.StringgetDefaultDebug()
Get the default value of Debug from dtd

		return "false".trim();
public static java.lang.StringgetDefaultEnabled()
Get the default value of Enabled from dtd

		return "true".trim();
public static java.lang.StringgetDefaultObjectType()
Get the default value of ObjectType from dtd

		return "user".trim();
public static java.lang.StringgetDefaultStoreProtocol()
Get the default value of StoreProtocol from dtd

		return "imap".trim();
public static java.lang.StringgetDefaultStoreProtocolClass()
Get the default value of StoreProtocolClass from dtd

		return "com.sun.mail.imap.IMAPStore".trim();
public static java.lang.StringgetDefaultTransportProtocol()
Get the default value of TransportProtocol from dtd

		return "smtp".trim();
public static java.lang.StringgetDefaultTransportProtocolClass()
Get the default value of TransportProtocolClass from dtd

		return "com.sun.mail.smtp.SMTPTransport".trim();
public java.lang.StringgetDescription()
Return the Description of the Element mail-resource

		return (String) getValue(ServerTags.DESCRIPTION);
public ElementPropertygetElementProperty(int index)

		return (ElementProperty)this.getValue(ELEMENT_PROPERTY, index);
public ElementProperty[]getElementProperty()

		return (ElementProperty[])this.getValues(ELEMENT_PROPERTY);
public ElementPropertygetElementPropertyByName(java.lang.String id)

	 if (null != id) { id = id.trim(); }
	ElementProperty[] o = getElementProperty();
	 if (o == null) return null;

	 for (int i=0; i < o.length; i++) {
	     if(o[i].getAttributeValue(Common.convertName(ServerTags.NAME)).equals(id)) {
	         return o[i];
	     }
	 }

		return null;
public java.lang.StringgetFrom()
Getter for From of the Element mail-resource

return
the From of the Element mail-resource

		return getAttributeValue(ServerTags.FROM);
public java.lang.StringgetHost()
Getter for Host of the Element mail-resource

return
the Host of the Element mail-resource

		return getAttributeValue(ServerTags.HOST);
public java.lang.StringgetJndiName()
Getter for JndiName of the Element mail-resource

return
the JndiName of the Element mail-resource

		return getAttributeValue(ServerTags.JNDI_NAME);
public java.lang.StringgetObjectType()
Getter for ObjectType of the Element mail-resource

return
the ObjectType of the Element mail-resource

		return getAttributeValue(ServerTags.OBJECT_TYPE);
protected java.lang.StringgetRelativeXPath()
get the xpath representation for this element returns something like abc[@name='value'] or abc depending on the type of the bean

	    String ret = null;
	    ret = "mail-resource" + (canHaveSiblings() ? "[@jndi-name='" + getAttributeValue("jndi-name") +"']" : "") ;
	    return (null != ret ? ret.trim() : null);
public java.lang.StringgetStoreProtocol()
Getter for StoreProtocol of the Element mail-resource

return
the StoreProtocol of the Element mail-resource

		return getAttributeValue(ServerTags.STORE_PROTOCOL);
public java.lang.StringgetStoreProtocolClass()
Getter for StoreProtocolClass of the Element mail-resource

return
the StoreProtocolClass of the Element mail-resource

		return getAttributeValue(ServerTags.STORE_PROTOCOL_CLASS);
public java.lang.StringgetTransportProtocol()
Getter for TransportProtocol of the Element mail-resource

return
the TransportProtocol of the Element mail-resource

		return getAttributeValue(ServerTags.TRANSPORT_PROTOCOL);
public java.lang.StringgetTransportProtocolClass()
Getter for TransportProtocolClass of the Element mail-resource

return
the TransportProtocolClass of the Element mail-resource

		return getAttributeValue(ServerTags.TRANSPORT_PROTOCOL_CLASS);
public java.lang.StringgetUser()
Getter for User of the Element mail-resource

return
the User of the Element mail-resource

		return getAttributeValue(ServerTags.USER);
voidinitialize(int options)
public booleanisDebug()
Getter for Debug of the Element mail-resource

return
the Debug of the Element mail-resource

		return toBoolean(getAttributeValue(ServerTags.DEBUG));
public booleanisEnabled()
Getter for Enabled of the Element mail-resource

return
the Enabled of the Element mail-resource

		return toBoolean(getAttributeValue(ServerTags.ENABLED));
public ElementPropertynewElementProperty()
Create a new bean using it's default constructor. This does not add it to any bean graph.

		return new ElementProperty();
public static voidremoveComparator(org.netbeans.modules.schema2beans.BeanComparator c)

		comparators.remove(c);
public intremoveElementProperty(ElementProperty value)

		return this.removeValue(ELEMENT_PROPERTY, value);
public intremoveElementProperty(ElementProperty value, boolean overwrite)

		return this.removeValue(ELEMENT_PROPERTY, value, overwrite);
public voidsetDebug(boolean v, boolean overwrite)
Modify the Debug of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.DEBUG, ""+(v==true), overwrite);
public voidsetDebug(boolean v)
Modify the Debug of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.DEBUG, ""+(v==true));
public voidsetDescription(java.lang.String v)
Modify the Description of the Element mail-resource

param
v the new value

		setValue(ServerTags.DESCRIPTION, (null != v ? v.trim() : null));
public voidsetElementProperty(ElementProperty[] value)

		this.setValue(ELEMENT_PROPERTY, value);
public voidsetEnabled(boolean v, boolean overwrite)
Modify the Enabled of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.ENABLED, ""+(v==true), overwrite);
public voidsetEnabled(boolean v)
Modify the Enabled of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.ENABLED, ""+(v==true));
public voidsetFrom(java.lang.String v, boolean overwrite)
Modify the From of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.FROM, v, overwrite);
public voidsetFrom(java.lang.String v)
Modify the From of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.FROM, v);
public voidsetHost(java.lang.String v, boolean overwrite)
Modify the Host of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.HOST, v, overwrite);
public voidsetHost(java.lang.String v)
Modify the Host of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.HOST, v);
public voidsetJndiName(java.lang.String v, boolean overwrite)
Modify the JndiName of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.JNDI_NAME, v, overwrite);
public voidsetJndiName(java.lang.String v)
Modify the JndiName of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.JNDI_NAME, v);
public voidsetObjectType(java.lang.String v, boolean overwrite)
Modify the ObjectType of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.OBJECT_TYPE, v, overwrite);
public voidsetObjectType(java.lang.String v)
Modify the ObjectType of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.OBJECT_TYPE, v);
public voidsetStoreProtocol(java.lang.String v, boolean overwrite)
Modify the StoreProtocol of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.STORE_PROTOCOL, v, overwrite);
public voidsetStoreProtocol(java.lang.String v)
Modify the StoreProtocol of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.STORE_PROTOCOL, v);
public voidsetStoreProtocolClass(java.lang.String v, boolean overwrite)
Modify the StoreProtocolClass of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.STORE_PROTOCOL_CLASS, v, overwrite);
public voidsetStoreProtocolClass(java.lang.String v)
Modify the StoreProtocolClass of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.STORE_PROTOCOL_CLASS, v);
public voidsetTransportProtocol(java.lang.String v, boolean overwrite)
Modify the TransportProtocol of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.TRANSPORT_PROTOCOL, v, overwrite);
public voidsetTransportProtocol(java.lang.String v)
Modify the TransportProtocol of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.TRANSPORT_PROTOCOL, v);
public voidsetTransportProtocolClass(java.lang.String v, boolean overwrite)
Modify the TransportProtocolClass of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.TRANSPORT_PROTOCOL_CLASS, v, overwrite);
public voidsetTransportProtocolClass(java.lang.String v)
Modify the TransportProtocolClass of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.TRANSPORT_PROTOCOL_CLASS, v);
public voidsetUser(java.lang.String v, boolean overwrite)
Modify the User of the Element mail-resource

param
v the new value
throws
StaleWriteConfigException if overwrite is false and file changed on disk

		setAttributeValue(ServerTags.USER, v, overwrite);
public voidsetUser(java.lang.String v)
Modify the User of the Element mail-resource

param
v the new value

		setAttributeValue(ServerTags.USER, v);
public intsizeElementProperty()

		return this.size(ELEMENT_PROPERTY);
public voidvalidate()