Package org.glassfish.resources.javamail.config

Interface MailResource

All Superinterfaces:

BindableResource, ConfigBeanProxy, jakarta.validation.Payload, PropertyBag, Resource

@ResourceConfigCreator(commandName="create-javamail-resource")
@ResourceTypeOrder(deploymentOrder=MAIL_RESOURCE)
@UniqueResourceNameConstraint(message="{resourcename.isnot.unique}",
                              payload=MailResource.class)
public interface MailResource
extends ConfigBeanProxy, Resource, PropertyBag, BindableResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MailResource.Duck

Method Summary

Modifier and Type	Method	Description
String	getAuth()	Gets the value of the auth property
String	getDebug()	Gets the value of the debug property.
String	getDescription()	Gets the value of the description property.
String	getEnabled()	Gets the value of the enabled property.
@NotNull String	getFrom()	Gets the value of the from property.
@NotNull String	getHost()	Gets the value of the host property.
String	getIdentity()
String	getPassword()	Gets the value of the password property
List<Property>	getProperty()	Properties as per PropertyBag
String	getStoreProtocol()	Gets the value of the storeProtocol property.
String	getStoreProtocolClass()	Gets the value of the storeProtocolClass property.
String	getTransportProtocol()	Gets the value of the transportProtocol property.
String	getTransportProtocolClass()	Gets the value of the transportProtocolClass property.
@NotNull String	getUser()	Gets the value of the user property.
void	setAuth(String value)	Sets the value of the auth property
void	setDebug(String value)	Sets the value of the debug property.
void	setDescription(String value)	Sets the value of the description property.
void	setEnabled(String value)	Sets the value of the enabled property.
void	setFrom(String value)	Sets the value of the from property.
void	setHost(String value)	Sets the value of the host property.
void	setPassword(String value)	Sets the value of the password property
void	setStoreProtocol(String value)	Sets the value of the storeProtocol property.
void	setStoreProtocolClass(String value)	Sets the value of the storeProtocolClass property.
void	setTransportProtocol(String value)	Sets the value of the transportProtocol property.
void	setTransportProtocolClass(String value)	Sets the value of the transportProtocolClass property.
void	setUser(String value)	Sets the value of the user property.

Methods inherited from interface com.sun.enterprise.config.serverbeans.BindableResource

getJndiName, setJndiName

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Methods inherited from interface com.sun.enterprise.config.serverbeans.Resource

getDeploymentOrder, getObjectType, setDeploymentOrder, setObjectType

Method Detail

getStoreProtocol

String getStoreProtocol()

Gets the value of the storeProtocol property.

Returns:

possible object is String

setStoreProtocol

void setStoreProtocol(String value)
               throws PropertyVetoException

Sets the value of the storeProtocol property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getStoreProtocolClass

@JavaClassName
String getStoreProtocolClass()

Gets the value of the storeProtocolClass property.

Returns:

possible object is String

setStoreProtocolClass

void setStoreProtocolClass(String value)
                    throws PropertyVetoException

Sets the value of the storeProtocolClass property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getTransportProtocol

String getTransportProtocol()

Gets the value of the transportProtocol property.

Returns:

possible object is String

setTransportProtocol

void setTransportProtocol(String value)
                   throws PropertyVetoException

Sets the value of the transportProtocol property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getTransportProtocolClass

@JavaClassName
String getTransportProtocolClass()

Gets the value of the transportProtocolClass property.

Returns:

possible object is String

setTransportProtocolClass

void setTransportProtocolClass(String value)
                        throws PropertyVetoException

Sets the value of the transportProtocolClass property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getHost

@NotNull
@NotNull String getHost()

Gets the value of the host property. ip V6 or V4 address or hostname

Returns:

possible object is String

setHost

void setHost(String value)
      throws PropertyVetoException

Sets the value of the host property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getUser

@NotNull
@NotNull String getUser()

Gets the value of the user property.

Returns:

possible object is String

setUser

void setUser(String value)
      throws PropertyVetoException

Sets the value of the user property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getPassword

String getPassword()

Gets the value of the password property

Returns:

possible object is String

setPassword

void setPassword(String value)
          throws PropertyVetoException

Sets the value of the password property

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAuth

String getAuth()

Gets the value of the auth property

Returns:

possible object is String

setAuth

void setAuth(String value)
      throws PropertyVetoException

Sets the value of the auth property

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getFrom

@NotNull
@NotNull String getFrom()

Gets the value of the from property.

Returns:

possible object is String

setFrom

void setFrom(String value)
      throws PropertyVetoException

Sets the value of the from property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDebug

String getDebug()

Gets the value of the debug property.

Returns:

possible object is String

setDebug

void setDebug(String value)
       throws PropertyVetoException

Sets the value of the debug property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getEnabled

String getEnabled()

Gets the value of the enabled property.

Specified by:

getEnabled in interface BindableResource

Returns:

possible object is String

setEnabled

void setEnabled(String value)
         throws PropertyVetoException

Sets the value of the enabled property.

Specified by:

setEnabled in interface BindableResource

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDescription

String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

void setDescription(String value)
             throws PropertyVetoException

Sets the value of the description property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
@PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

getIdentity

@DuckTyped
String getIdentity()

Specified by:

getIdentity in interface BindableResource

Specified by:

getIdentity in interface Resource