Package org.glassfish.resources.mail.config

Interface MailResource

All Superinterfaces:
com.sun.enterprise.config.serverbeans.BindableResource, org.jvnet.hk2.config.ConfigBeanProxy, jakarta.validation.Payload, org.jvnet.hk2.config.types.PropertyBag, com.sun.enterprise.config.serverbeans.Resource
@ResourceConfigCreator(commandName="create-mail-resource") @ResourceTypeOrder(deploymentOrder=MAIL_RESOURCE) @UniqueResourceNameConstraint(message="{resourcename.isnot.unique}", payload=MailResource.class) public interface MailResource extends org.jvnet.hk2.config.ConfigBeanProxy, com.sun.enterprise.config.serverbeans.Resource, org.jvnet.hk2.config.types.PropertyBag, com.sun.enterprise.config.serverbeans.BindableResource
The mail-resource element describes a Session resource.

  • Field Summary

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

    PATTERN_JNDI

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

    OBJECT_TYPES

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    default String
    getIdentity()
     
    List<org.jvnet.hk2.config.types.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
    setDebug(String debug)
    Sets the value of the debug property.
    void
    setDescription(String description)
    Sets the value of the description property.
    void
    setEnabled(String enabled)
    Sets the value of the enabled property.
    void
    setFrom(String from)
    Sets the value of the from property.
    void
    setHost(String host)
    Sets the value of the host property.
    void
    setStoreProtocol(String protocol)
    Sets the value of the storeProtocol property.
    void
    setStoreProtocolClass(String protocolClass)
    Sets the value of the storeProtocolClass property.
    void
    setTransportProtocol(String protocol)
    Sets the value of the transportProtocol property.
    void
    setTransportProtocolClass(String protocolClass)
    Sets the value of the transportProtocolClass property.
    void
    setUser(String user)
    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 Details

    • getStoreProtocol

      String getStoreProtocol()
      Gets the value of the storeProtocol property.
      Returns:
      possible object is String

    • setStoreProtocol

      void setStoreProtocol(String protocol) throws PropertyVetoException
      Sets the value of the storeProtocol property.
      Parameters:
      protocol - 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 protocolClass) throws PropertyVetoException
      Sets the value of the storeProtocolClass property.
      Parameters:
      protocolClass - 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 protocol) throws PropertyVetoException
      Sets the value of the transportProtocol property.
      Parameters:
      protocol - 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 protocolClass) throws PropertyVetoException
      Sets the value of the transportProtocolClass property.
      Parameters:
      protocolClass - 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 host) throws PropertyVetoException
      Sets the value of the host property.
      Parameters:
      host - 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 user) throws PropertyVetoException
      Sets the value of the user property.
      Parameters:
      user - 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 from) throws PropertyVetoException
      Sets the value of the from property.
      Parameters:
      from - 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 debug) throws PropertyVetoException
      Sets the value of the debug property.
      Parameters:
      debug - allowed object is String
      Throws:
      PropertyVetoException

    • getEnabled

      String getEnabled()
      Gets the value of the enabled property.
      Specified by:
      getEnabled in interface com.sun.enterprise.config.serverbeans.BindableResource
      Returns:
      possible object is String

    • setEnabled

      void setEnabled(String enabled) throws PropertyVetoException
      Sets the value of the enabled property.
      Specified by:
      setEnabled in interface com.sun.enterprise.config.serverbeans.BindableResource
      Parameters:
      enabled - 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 description) throws PropertyVetoException
      Sets the value of the description property.
      Parameters:
      description - allowed object is String
      Throws:
      PropertyVetoException

    • getProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties as per PropertyBag
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag

    • getIdentity

      default String getIdentity()
      Specified by:
      getIdentity in interface com.sun.enterprise.config.serverbeans.BindableResource
      Specified by:
      getIdentity in interface com.sun.enterprise.config.serverbeans.Resource